org.exolab.castor.xml.schema

Class Union

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.Annotated

org.exolab.castor.xml.schema.XMLType

org.exolab.castor.xml.schema.SimpleType

org.exolab.castor.xml.schema.Union

All Implemented Interfaces:

Serializable, Referable

public class Union
extends SimpleType

A class that represents the XML Schema Union simple-type.

Version:

$Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $

Author:

Keith Visco

See Also:

Serialized Form

Field Summary

Fields inherited from class org.exolab.castor.xml.schema.SimpleType

FINAL_ALL, FINAL_LIST, FINAL_RESTRICTION, FINAL_UNION

Fields inherited from class org.exolab.castor.xml.schema.XMLType

NULL_ARGUMENT

Fields inherited from class org.exolab.castor.xml.schema.Structure

ANNOTATION, ANYTYPE, APPINFO, ATTRIBUTE, ATTRIBUTE_GROUP, COMPLEX_CONTENT, COMPLEX_TYPE, DOCUMENTATION, ELEMENT, FACET, GROUP, IDENTITY_FIELD, IDENTITY_SELECTOR, KEY, KEYREF, LIST, MODELGROUP, MODELGROUP_REF, REDEFINE, SCHEMA, SIMPLE_CONTENT, SIMPLE_TYPE, UNION, UNIQUE, UNKNOWN, WILDCARD

Constructor Summary

Constructors

Constructor and Description
Union(Schema schema) Creates a new Union type.

Method Summary

Modifier and Type	Method and Description
void	addMemberType(SimpleType simpleType) Adds the given SimpleType as a member of this Union
void	addMemberType(String typeName) Adds the given SimpleType reference as a member of this Union.
String	getId() Returns the id for this Union, or null if no id has been set.
Annotation	getLocalAnnotation() Returns the annotation which appears local to this Union, or null if no local annotation has been set.
Enumeration<SimpleType>	getMemberTypes() Returns an Enumeration of all the SimpleTypes that are members of this Union.
short	getStructureType() Returns the type of this Schema Structure
void	setId(String id) Sets the id for this Union.
void	setLocalAnnotation(Annotation annotation) Sets an annotation which is local to this Union.
void	setSchema(Schema schema) Sets the Schema for this Union.

Methods inherited from class org.exolab.castor.xml.schema.SimpleType

addFacet, copyFacets, createReference, getBuiltInBaseType, getEffectiveFacets, getFacet, getFacets, getFacets, getFinal, getLength, getLocalFacets, getMaxLength, getMinLength, getNumberOfFacets, getParent, getReferenceId, getTypeCode, hasFacet, isBuiltInType, isDateTimeType, isNumericType, isRedefined, removeFacet, removeFacet, resolveReference, setFinal, setParent, setRedefined, validate

Methods inherited from class org.exolab.castor.xml.schema.XMLType

getBaseType, getBaseTypeName, getDerivationMethod, getName, getSchema, isAnyType, isComplexType, isSimpleType, setBaseType, setDerivationMethod, setName

Methods inherited from class org.exolab.castor.xml.schema.Annotated

addAnnotation, getAnnotations, removeAnnotation

Methods inherited from class org.exolab.castor.xml.schema.Structure

isValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Union

public Union(Schema schema)
      throws SchemaException

Creates a new Union type.

Parameters:

schema - the Schema for this Union (Cannot be null)

Throws:

SchemaException

Method Detail

addMemberType

public void addMemberType(String typeName)

Adds the given SimpleType reference as a member of this Union. An exception will be thrown during a call to #getMemberTypes if this reference cannot be resolved.

Parameters:

typeName - the name of the SimpleType to add.

addMemberType

public void addMemberType(SimpleType simpleType)

Adds the given SimpleType as a member of this Union

Parameters:

simpleType - the SimpleType to add to this Union.

getId

public String getId()

Returns the id for this Union, or null if no id has been set.

Overrides:

getId in class XMLType

Returns:

the id for this Union, or null if no id has been set..

getLocalAnnotation

public Annotation getLocalAnnotation()

Returns the annotation which appears local to this Union, or null if no local annotation has been set.

Returns:

the annotation which is local to this Union.

getMemberTypes

public Enumeration<SimpleType> getMemberTypes()

Returns an Enumeration of all the SimpleTypes that are members of this Union.

Returns:

an Enumeration of all member SimpleTypes.

getStructureType

public short getStructureType()

Returns the type of this Schema Structure

Overrides:

getStructureType in class SimpleType

Returns:

the type of this Schema Structure

setSchema

public void setSchema(Schema schema)

Sets the Schema for this Union. This method overloads the SimpleType#setSchema method to prevent the Schema from being changed.

Overrides:

setSchema in class XMLType

Parameters:

schema - the schema that this Union belongs to.

setId

public void setId(String id)

Sets the id for this Union.

Overrides:

setId in class XMLType

Parameters:

id - the unique id for this Union. Must be globally unique within the scope of the Schema.

setLocalAnnotation

public void setLocalAnnotation(Annotation annotation)

Sets an annotation which is local to this Union.

Parameters:

annotation - the local annotation to set for this Union.