Package org.exolab.castor.xml.schema
Class Group
- java.lang.Object
-
- org.exolab.castor.xml.schema.Structure
-
- org.exolab.castor.xml.schema.Annotated
-
- org.exolab.castor.xml.schema.Particle
-
- org.exolab.castor.xml.schema.Group
-
- All Implemented Interfaces:
java.io.Serializable
,ContentModelGroup
,Referable
- Direct Known Subclasses:
ModelGroup
public class Group extends Particle implements ContentModelGroup, Referable
An XML Schema Group- Version:
- $Revision: 7996 $ $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.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
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addElementDecl(ElementDecl elementDecl)
Adds the given ElementDecl to this ContentModelGroup.void
addGroup(Group group)
Adds the givenGroup
to thisContentModelGroup
.void
addGroup(ModelGroup group)
Adds the givenModelGroup
definition to thisContentModelGroup
.void
addWildcard(Wildcard wildcard)
Adds the givenWildcard
to thisContentModelGroup
.java.util.Enumeration<Annotated>
enumerate()
Returns an enumeration of all theParticle
s contained within thisContentModelGroup
.ContentModelGroup
getContentModelGroup()
Returns theContentModelGroup
for this group.ElementDecl
getElementDecl(java.lang.String name)
Returns the element declaration with the given name, or null if no element declaration with that name exists in thisContentModelGroup
.java.lang.String
getId()
Returns the ID for thisGroup
.java.lang.String
getName()
Returns the name of thisGroup
, or null if no name was defined.Order
getOrder()
Returns the compositor for thisGroup
.Structure
getParent()
Returns the parent of this Group, this value may be null if no parent has been set.Particle
getParticle(int index)
Returns theParticle
at the specified index.int
getParticleCount()
Returns the number of particles contained within thisContentModelGroup
.java.lang.String
getReferenceId()
Returns the Id used to refer to this Object.short
getStructureType()
Returns the type of this Schema Structure.boolean
hasAny()
A helper method that returns true if this group contains an <any> element.boolean
isEmptiable()
Indicates whether thisParticle
is 'emptiable'boolean
isModelGroupDefinition()
Deprecated.Since Castor 0.9.2, to handle properly theelement the class ModelGroup
has been createdboolean
removeElementDecl(ElementDecl element)
Removes the given ElementDecl from this ContentModelGroup.boolean
removeGroup(Group group)
Removes the givenGroup
from thisContentModelGroup
.boolean
removeGroup(ModelGroup group)
Removes the givenModelGroup
definition from thisContentModelGroup
.boolean
removeWildcard(Wildcard wildcard)
Removes the givenWildcard
from thisContentModelGroup
.void
setId(java.lang.String id)
Sets the ID for thisGroup
.void
setIsModelGroupDefinition(boolean isModelGroupDefinition)
Deprecated.Since Castor 0.9.2, to handle properly theelement the class ModelGroup has been created void
setName(java.lang.String name)
Sets the name of thisGroup
.void
setOrder(Order order)
protected void
setParent(Structure parent)
Sets the parent for thisGroup
.void
validate()
Checks the validity of thisGroup
defintion.-
Methods inherited from class org.exolab.castor.xml.schema.Particle
getMaxOccurs, getMinOccurs, isMaxOccursSet, isMinOccursSet, setMaxOccurs, setMinOccurs
-
Methods inherited from class org.exolab.castor.xml.schema.Annotated
addAnnotation, getAnnotations, removeAnnotation
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.exolab.castor.xml.schema.ContentModelGroup
getMaxOccurs, getMinOccurs
-
-
-
-
Method Detail
-
addWildcard
public void addWildcard(Wildcard wildcard) throws SchemaException
Adds the givenWildcard
to thisContentModelGroup
.- Specified by:
addWildcard
in interfaceContentModelGroup
- Parameters:
wildcard
- theWildcard
to add- Throws:
SchemaException
- when theWildcard
is <anyAttribute> and not <any>- See Also:
ContentModelGroup.addWildcard(org.exolab.castor.xml.schema.Wildcard)
-
removeWildcard
public boolean removeWildcard(Wildcard wildcard)
Removes the givenWildcard
from thisContentModelGroup
.- Specified by:
removeWildcard
in interfaceContentModelGroup
- Parameters:
wildcard
- theWildcard
to remove.- Returns:
- true if the given
Wildcard
has been successfully removed, false otherwise. - See Also:
ContentModelGroup.removeWildcard(org.exolab.castor.xml.schema.Wildcard)
-
getContentModelGroup
public ContentModelGroup getContentModelGroup()
Returns theContentModelGroup
for this group. Only used for aelement - Returns:
- the ContentModelGroup for this group
-
getId
public java.lang.String getId()
Returns the ID for thisGroup
.- Returns:
- the ID for this
Group
, or null if no ID is present
-
getName
public java.lang.String getName()
Returns the name of thisGroup
, or null if no name was defined.- Returns:
- the name of this
Group
, or null if no name was defined
-
getOrder
public Order getOrder()
Returns the compositor for thisGroup
.- Returns:
- the compositor for this
Group
-
getParent
public Structure getParent()
Returns the parent of this Group, this value may be null if no parent has been set.- Returns:
- the parent Structure of this Group.
-
setIsModelGroupDefinition
public void setIsModelGroupDefinition(boolean isModelGroupDefinition)
Deprecated.Since Castor 0.9.2, to handle properly theelement the class ModelGroup has been created Sets if the group is a model group definition.- See Also:
ModelGroup
-
isModelGroupDefinition
public boolean isModelGroupDefinition()
Deprecated.Since Castor 0.9.2, to handle properly theelement the class ModelGroup
has been createdTells if the group is a model group definition.- Returns:
- true if the group is a model group definition (
tag), false otherwise <all/>, , or tags. - See Also:
ModelGroup
-
getReferenceId
public java.lang.String 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:
Referable
-
setName
public void setName(java.lang.String name)
Sets the name of thisGroup
.- Parameters:
name
- the new name for thisGroup
-
setId
public void setId(java.lang.String id)
Sets the ID for thisGroup
.- Parameters:
id
- the ID for thisGroup
-
setOrder
public void setOrder(Order order)
-
addElementDecl
public void addElementDecl(ElementDecl elementDecl) throws SchemaException
Adds the given ElementDecl to this ContentModelGroup.- 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- See Also:
ContentModelGroup.addElementDecl(org.exolab.castor.xml.schema.ElementDecl)
-
removeElementDecl
public boolean removeElementDecl(ElementDecl element)
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.
- See Also:
ContentModelGroup.removeElementDecl(org.exolab.castor.xml.schema.ElementDecl)
-
addGroup
public void addGroup(Group group) throws SchemaException
Adds the givenGroup
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- See Also:
ContentModelGroup.addGroup(org.exolab.castor.xml.schema.Group)
-
removeGroup
public boolean removeGroup(Group group)
Removes the givenGroup
from thisContentModelGroup
.- Specified by:
removeGroup
in interfaceContentModelGroup
- Parameters:
group
- the Group to remove.- Returns:
- true if the group has been successfully removed, false otherwise.
- See Also:
ContentModelGroup.removeGroup(org.exolab.castor.xml.schema.Group)
-
addGroup
public void addGroup(ModelGroup group) throws SchemaException
Adds the givenModelGroup
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- See Also:
ContentModelGroup.addGroup(org.exolab.castor.xml.schema.ModelGroup)
-
removeGroup
public boolean removeGroup(ModelGroup group)
Removes the givenModelGroup
definition from thisContentModelGroup
.- Specified by:
removeGroup
in interfaceContentModelGroup
- Parameters:
group
- theModelGroup
definition to remove.- Returns:
- true if the group has been successfully removed, false otherwise.
- See Also:
ContentModelGroup.removeGroup(org.exolab.castor.xml.schema.ModelGroup)
-
enumerate
public java.util.Enumeration<Annotated> enumerate()
Returns an enumeration of all theParticle
s contained within thisContentModelGroup
.- Specified by:
enumerate
in interfaceContentModelGroup
- Returns:
- an enumeration of all the
Particle
s contained within thisContentModelGroup
- See Also:
ContentModelGroup.enumerate()
-
getElementDecl
public ElementDecl getElementDecl(java.lang.String name)
Returns the element declaration with the given name, or null if no element declaration with that name exists in thisContentModelGroup
.- 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 thisContentModelGroup
. - See Also:
ContentModelGroup.getElementDecl(java.lang.String)
-
getParticle
public Particle getParticle(int index)
Returns theParticle
at the specified index.- Specified by:
getParticle
in interfaceContentModelGroup
- Parameters:
index
- the index of theParticle
to return- Returns:
- the CMParticle at the specified index
- See Also:
ContentModelGroup.getParticle(int)
-
getParticleCount
public int getParticleCount()
Returns the number of particles contained within thisContentModelGroup
.- Specified by:
getParticleCount
in interfaceContentModelGroup
- Returns:
- the number of particles
- See Also:
ContentModelGroup.getParticleCount()
-
getStructureType
public short getStructureType()
Returns the type of this Schema Structure.- Specified by:
getStructureType
in classStructure
- Returns:
- the type of this Schema Structure.
- See Also:
Structure.getStructureType()
-
hasAny
public boolean hasAny()
A helper method that returns true if this group contains an <any> element.- Returns:
- method that returns true if this group contains an <any> element.
-
validate
public void validate() throws ValidationException
Checks the validity of thisGroup
defintion.- Specified by:
validate
in classStructure
- Throws:
ValidationException
- when thisGroup
definition is invalid.
-
isEmptiable
public boolean isEmptiable()
Indicates whether thisParticle
is 'emptiable'- Overrides:
isEmptiable
in classParticle
- Returns:
- true if this Particle is 'emptiable'
-
-