org.exolab.castor.xml.schema

Class Union

public class Union extends SimpleType

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

Version: $Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:35 $

Author: Keith Visco

Constructor Summary
Union(Schema schema)
Creates a new Union type.
Method Summary
voidaddMemberType(String typeName)
Adds the given SimpleType reference as a member of this Union.
voidaddMemberType(SimpleType simpleType)
Adds the given SimpleType as a member of this Union
StringgetId()
Returns the id for this Union, or null if no id has been set.
AnnotationgetLocalAnnotation()
Returns the annotation which appears local to this Union, or null if no local annotation has been set.
EnumerationgetMemberTypes()
Returns an Enumeration of all the SimpleTypes that are members of this Union.
shortgetStructureType()
Returns the type of this Schema Structure
voidsetId(String id)
Sets the id for this Union.
voidsetLocalAnnotation(Annotation annotation)
Sets an annotation which is local to this Union.
voidsetSchema(Schema schema)
Sets the Schema for this Union.

Constructor Detail

Union

public Union(Schema schema)
Creates a new Union type.

Parameters: schema the Schema for this Union (Cannot be null)

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.

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 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

Returns: the type of this Schema Structure

setId

public void setId(String id)
Sets the id for this Union.

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.

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.

Parameters: the schema that this Union belongs to.

Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com