Package org.exolab.castor.xml.schema
Class ComplexType
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.ComplexType
- All Implemented Interfaces:
Serializable
,ContentModelGroup
,Referable
The XML Schema ComplexType class.
- Version:
- $Revision: 7625 $ $Date: 2006-02-01 15:47:48 -0700 (Wed, 01 Feb 2006) $
- Author:
- Keith Visco
- See Also:
-
Field Summary
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
ConstructorsConstructorDescriptionComplexType
(Schema schema) Creates a newComplexType
instance with no name.ComplexType
(Schema schema, String name) Creates a newComplexType
with the given name. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttributeDecl
(AttributeDecl attrDecl) Adds the givenAttributeDecl
to thisComplexType
.void
addAttributeGroupReference
(AttributeGroupReference attrGroupRef) Adds the given AttributeGroupReference to this ComplexType.void
addElementDecl
(ElementDecl elementDecl) Adds the given ElementDecl to thisContentModelGroup
.void
Adds the given Group to thisContentModelGroup
.void
addGroup
(ModelGroup group) Adds the given ModelGroup Definition to thisContentModelGroup
.void
addWildcard
(Wildcard wildcard) Adds the givenWildcard
to thisContentModelGroup
.createAttributeDecl
(String name) Creates anAttributeDecl
with the given name.Returns an enumeration of all the Particles of this ContentModelGroup.Returns the wilcard used in this complexType (can be null).getAttributeDecl
(String name) Returns theAttributeDecl
associated with the given name.Returns an Enumeration of *all* the AttributeDecl objects declared within this ComplexType.Returns an Enumeration of all the AttributeGroup that are referenced within this ComplexType.Returns the base type that this type inherits from.getBlock()
Returns the value of the 'block' attribute for this element.Returns the content type of this ComplexType.getElementDecl
(String name) Returns the element declaration with the given name, or null if no element declaration with that name exists in this ContentModelGroup.getFinal()
Returns the list of values for the final property for this ComplexType, or null if no final values have been set.Returns an Enumeration of *all* locally defined AttributeDecl declared within this ComplexType.int
Returns the maximum number of occurances that this ContentModelGroup may appear.int
Returns the minimum number of occurances that this ContentModelGroup must appear.Returns the parent of this ComplexType, this value may be null if no parent has been set.getParticle
(int index) Returns the Particle at the specified indexint
Returns the number of particles contained within this ContentModelGroup.Returns the Id used to Refer to this Object.short
Returns the type of this Schema Structure.boolean
hasAny()
A helper method that returns true if this complexType contains an <any> element.boolean
Returns true if this ComplexType has been marked as Abstract.boolean
Returns true if this complexType is a 'complexContent'.boolean
boolean
Returns true if this complexType is a redefinition.boolean
Returns true if this complexType is a restriction.boolean
Returns true if this complexType is a 'simpleContent'.boolean
Returns true if this is a top levelComplexType
.void
removeAttributeDecl
(AttributeDecl attrDecl) Removes the givenAttributeDecl
from thisComplexType
.void
removeAttributeGroupReference
(AttributeGroupReference attrGroupRef) Removes the givenAttributeGroupReference
from thisComplexType
.boolean
removeElementDecl
(ElementDecl element) Removes the given ElementDecl from this ContentModelGroup.boolean
removeGroup
(Group group) Removes the given Group from this ContentModelGroup.boolean
removeGroup
(ModelGroup group) Removes the given ModelGroup Definition from this ContentModelGroup.boolean
removeWildcard
(Wildcard wildcard) Removes the given Wildcard from this Group.void
setAbstract
(boolean isAbstract) Sets whether or not this ComplexType should be abstract.void
setAnyAttribute
(Wildcard wildcard) Sets the wildcard (anyAttribute) of theComplexType
.void
Sets the base type that this type is derived from.void
setBaseType
(XMLType baseType) Sets the base type for this ComplexType.void
Sets the value of the 'block' attribute for this ComplexType.void
Sets the value of the 'block' attribute for this ComplexType.void
setComplexContent
(boolean complexContent) Sets whether or not this complexType is a 'complexContent'.void
setContentType
(ContentType contentType) Sets the content type of this complexType.void
Sets the value of the 'final' attribute for this ComplexType definition.void
Sets the value of the 'final' attribute for this ComplexType definition.protected void
Sets the parent for this ComplexType.void
Sets this Group has redefined.void
setRestriction
(boolean restricted) Sets whether or not this complexType is a restriction.void
setSimpleContent
(boolean simpleContent) Sets whether or not this complexType is a 'simpleContent'.void
useResolver
(Resolver resolver) void
validate()
Checks the validity of this ComplexType defintion.Methods inherited from class org.exolab.castor.xml.schema.XMLType
getBaseTypeName, getDerivationMethod, getId, getName, getSchema, getType, isAnyType, isComplexType, isSimpleType, setDerivationMethod, setId, setName, setSchema
Methods inherited from class org.exolab.castor.xml.schema.Annotated
addAnnotation, getAnnotations, removeAnnotation
-
Constructor Details
-
ComplexType
Creates a newComplexType
instance with no name.- Parameters:
schema
- the owningSchema
document
-
ComplexType
Creates a newComplexType
with the given name.- Parameters:
schema
- The owningSchema
instancename
- Name of theComplexType
-
-
Method Details
-
addAttributeDecl
Adds the givenAttributeDecl
to thisComplexType
.- Parameters:
attrDecl
- theAttributeDecl
to add to thisComplexType
-
removeAttributeDecl
Removes the givenAttributeDecl
from thisComplexType
.- Parameters:
attrDecl
- the AttributeDecl to remove.
-
addAttributeGroupReference
Adds the given AttributeGroupReference to this ComplexType.- Parameters:
attrGroupRef
- the AttributeGroupReference to add to this ComplexType
-
removeAttributeGroupReference
Removes the givenAttributeGroupReference
from thisComplexType
.- Parameters:
attrGroupRef
- theAttributeGroupReference
to remove.
-
createAttributeDecl
Creates anAttributeDecl
with the given name. The attribute declaration will still need to be added to thisComplexType
, or another archetype in the same schema, by making a call to #addAttributeDecl- Parameters:
name
- the name of the attribute- Returns:
- the new AttributeDecl
-
getAnyAttribute
Returns the wilcard used in this complexType (can be null).- Returns:
- the wilcard used in this complexType (can be null)
-
getAttributeDecl
Returns theAttributeDecl
associated with the given name.- Parameters:
name
- Name of the associatedAttributeDecl
- Returns:
- the
AttributeDecl
associated with the given name, or null if noAttributeDecl
with the given name was found.
-
getAttributeDecls
Returns an Enumeration of *all* the AttributeDecl objects declared within this ComplexType. The Enumeration will contain all AttributeDecl from AttributeGroup references as well. To return only locally declared attributes make a call togetLocalAttributeDecls
.- Returns:
- an Enumeration of all the AttributeDecl objects declared within this Complextype
-
getLocalAttributeDecls
Returns an Enumeration of *all* locally defined AttributeDecl declared within this ComplexType. The Enumeration will not contain any AttributeDecl from AttributeGroup references.- Returns:
- an Enumeration of all locally declared AttributeDecl.
-
getAttributeGroupReferences
Returns an Enumeration of all the AttributeGroup that are referenced within this ComplexType.- Returns:
- an Enumeration of all the AttributeGroup that are referenced within this ComplexType.
-
getBaseType
Returns the base type that this type inherits from.- Overrides:
getBaseType
in classXMLType
- Returns:
- the base type (also called super type).
-
getBlock
Returns the value of the 'block' attribute for this element.- Returns:
- the value of the 'block' attribute for this element
-
getContentType
Returns the content type of this ComplexType. The Content Type holds the information about the content of the complexType. For instance, if this complexType is a simpleContent then the simpleType information will be hold in the content type.- Returns:
- the content type of this ComplexType
-
getFinal
Returns the list of values for the final property for this ComplexType, or null if no final values have been set.- Returns:
- the FinalList for this ComplexType
-
getParent
Returns the parent of this ComplexType, this value may be null if no parent has been set.- Returns:
- the parent Structure of this ComplexType.
-
getReferenceId
Returns the Id used to Refer to this Object.- Specified by:
getReferenceId
in interfaceReferable
- Returns:
- the Id used to Refer to this Object
- See Also:
-
hasAny
public boolean hasAny()A helper method that returns true if this complexType contains an <any> element.- Returns:
- method that returns true if this complexType contains an <any> element.
-
isAbstract
public boolean isAbstract()Returns true if this ComplexType has been marked as Abstract.- Returns:
- true if this ComplexType is "abstract".
-
isRedefined
public boolean isRedefined()Returns true if this complexType is a redefinition.- Returns:
- true if this complexType is a redefinition.
-
isTopLevel
public boolean isTopLevel()Returns true if this is a top levelComplexType
.- Returns:
- true if this is a top level
ComplexType
-
isComplexContent
public boolean isComplexContent()Returns true if this complexType is a 'complexContent'.- Returns:
- true if this complexType is a 'complexContent'
-
isSimpleContent
public boolean isSimpleContent()Returns true if this complexType is a 'simpleContent'.- Returns:
- true if this complexType is a 'simpleContent'
-
isRestricted
public boolean isRestricted()Returns true if this complexType is a restriction.- Returns:
- true if this complexType is a restriction
-
setAbstract
public void setAbstract(boolean isAbstract) Sets whether or not this ComplexType should be abstract.- Parameters:
isAbstract
- a boolean that when true makes this ComplexType abstract.
-
setAnyAttribute
Sets the wildcard (anyAttribute) of theComplexType
.- Throws:
SchemaException
- thrown when a wildcard as already be set or when the wildCard is not an <anyAttribute>.
-
removeWildcard
Removes the given Wildcard from this Group.- Specified by:
removeWildcard
in interfaceContentModelGroup
- Parameters:
wildcard
- the Wildcard to remove.- Returns:
- true if the wildcard has been successfully removed, false otherwise.
-
addWildcard
Description copied from interface:ContentModelGroup
Adds the givenWildcard
to thisContentModelGroup
.- Specified by:
addWildcard
in interfaceContentModelGroup
- Parameters:
wildcard
- theWildcard
to add- Throws:
SchemaException
- when theWildcard
is <anyAttribute> and not <any>
-
setBase
Sets the base type that this type is derived from.- Parameters:
base
- the type that this type is derived from
-
setBaseType
Sets the base type for this ComplexType.- Overrides:
setBaseType
in classXMLType
- Parameters:
baseType
- the base type which this ComplexType extends or restricts
-
setBlock
Sets the value of the 'block' attribute for this ComplexType.- Parameters:
block
- the value of the block attribute for this ComplexType definition.
-
setBlock
Sets the value of the 'block' attribute for this ComplexType.- Parameters:
block
- the value of the block attribute for this ComplexType definition.
-
setComplexContent
public void setComplexContent(boolean complexContent) Sets whether or not this complexType is a 'complexContent'.- Parameters:
complexContent
- true if this complexType is a 'complexContent'
-
setContentType
Sets the content type of this complexType. The Content Type holds the information about the content of the complexType. For instance, if this complexType is a simpleContent then the simpleType information will be hold in the content type.- Parameters:
contentType
- the ContentType for this complexType
-
setFinal
Sets the value of the 'final' attribute for this ComplexType definition.- Parameters:
finalList
- the value of the final attribute for this ComplexType definition.
-
setFinal
Sets the value of the 'final' attribute for this ComplexType definition.- Parameters:
finalValue
- the value of the final attribute for this ComplexType definition.
-
setRedefined
public void setRedefined()Sets this Group has redefined. -
setSimpleContent
public void setSimpleContent(boolean simpleContent) Sets whether or not this complexType is a 'simpleContent'.- Parameters:
simpleContent
- true if this complexType is a 'simpleContent'
-
setRestriction
public void setRestriction(boolean restricted) Sets whether or not this complexType is a restriction.- Parameters:
restricted
- true if this complexType is a restriction
-
useResolver
-
addElementDecl
Adds the given ElementDecl to thisContentModelGroup
.- Specified by:
addElementDecl
in interfaceContentModelGroup
- Parameters:
elementDecl
- the ElementDecl to add- Throws:
SchemaException
- when an ElementDecl already exists with the same name as the given ElementDecl
-
removeElementDecl
Removes the given ElementDecl from this ContentModelGroup.- Specified by:
removeElementDecl
in interfaceContentModelGroup
- Parameters:
element
- the ElementDecl to remove.- Returns:
- true if the element has been successfully removed, false otherwise.
-
addGroup
Adds the given Group to thisContentModelGroup
.- Specified by:
addGroup
in interfaceContentModelGroup
- Parameters:
group
- the Group to add- Throws:
SchemaException
- when a group with the same name as the specified group already exists in the current scope
-
removeGroup
Removes the given Group from this ContentModelGroup.- Specified by:
removeGroup
in interfaceContentModelGroup
- Parameters:
group
- the Group to remove.- Returns:
- true if the group has been successfully removed, false otherwise.
-
addGroup
Adds the given ModelGroup Definition to thisContentModelGroup
.- Specified by:
addGroup
in interfaceContentModelGroup
- Parameters:
group
- the ModelGroup to add- Throws:
SchemaException
- when a group with the same name as the specified group already exists in the current scope
-
removeGroup
Removes the given ModelGroup Definition from this ContentModelGroup.- Specified by:
removeGroup
in interfaceContentModelGroup
- Parameters:
group
- the ModelGroup Definition to remove.- Returns:
- true if the group has been successfully removed, false otherwise.
-
enumerate
Returns an enumeration of all the Particles of this ContentModelGroup.- Specified by:
enumerate
in interfaceContentModelGroup
- Returns:
- an enumeration of the Particles contained within this ContentModelGroup
-
getElementDecl
Returns the element declaration with the given name, or null if no element declaration with that name exists in this ContentModelGroup.- Specified by:
getElementDecl
in interfaceContentModelGroup
- Parameters:
name
- the name of the element.- Returns:
- the ElementDecl with the given name, or null if no ElementDecl exists in this ContentModelGroup.
-
getMaxOccurs
public int getMaxOccurs()Returns the maximum number of occurances that this ContentModelGroup may appear.- Specified by:
getMaxOccurs
in interfaceContentModelGroup
- Returns:
- the maximum number of occurances that this ContentModelGroup may appear. A non positive (n invalid input: '<' 1) value indicates that the value is unspecified (ie. unbounded).
-
getMinOccurs
public int getMinOccurs()Returns the minimum number of occurances that this ContentModelGroup must appear.- Specified by:
getMinOccurs
in interfaceContentModelGroup
- Returns:
- the minimum number of occurances that this ContentModelGroup must appear A negative (n invalid input: '<' 0) value indicates that the value is unspecified.
-
getParticle
Returns the Particle at the specified index- Specified by:
getParticle
in interfaceContentModelGroup
- Parameters:
index
- the index of the particle to return- Returns:
- the CMParticle at the specified index
-
getParticleCount
public int getParticleCount()Returns the number of particles contained within this ContentModelGroup.- Specified by:
getParticleCount
in interfaceContentModelGroup
- Returns:
- the number of particles
-
getStructureType
public short getStructureType()Returns the type of this Schema Structure.- Specified by:
getStructureType
in classStructure
- Returns:
- the type of this Schema Structure
-
validate
Checks the validity of this ComplexType defintion.- Specified by:
validate
in classStructure
- Throws:
ValidationException
- when this ComplexType definition is invalid.
-
setParent
Sets the parent for this ComplexType. -
isEmptiable
public boolean isEmptiable()- Returns:
- true if the content model for this ComplexType is emptiable.
-