Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
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
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 |
Constructor Summary | |
| |
|
Method Summary | |
void |
|
void | |
void |
|
void |
|
Enumeration |
|
ContentModelGroup |
|
ElementDecl |
|
String |
|
String |
|
Order |
|
Structure |
|
Particle |
|
int |
|
String |
|
short |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
void | |
protected void | |
void |
|
Methods inherited from class org.exolab.castor.xml.schema.Particle | |
getMaxOccurs , getMinOccurs , setMaxOccurs , setMinOccurs |
Methods inherited from class org.exolab.castor.xml.schema.Annotated | |
addAnnotation , getAnnotations , removeAnnotation |
Methods inherited from class org.exolab.castor.xml.schema.Structure | |
getStructureType , isValid , validate |
public Group()
Creates a new Group, with no name
public Group(String name)
Creates a new Group with the given name
- Parameters:
name
- of the Group
public void addElementDecl(ElementDecl elementDecl) throws SchemaException
Adds the given ElementDecl to this ContentModelGroup
- Specified by:
- addElementDecl in interface ContentModelGroup
- Parameters:
elementDecl
- the ElementDecl to add
- Throws:
SchemaException
- when an ElementDecl already exists with the same name as the given ElementDecl
public void addGroup(Group group) throws SchemaException
Adds the given Group to this ContentModelGroup
- Specified by:
- addGroup in interface ContentModelGroup
- 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
public void addGroup(ModelGroup group) throws SchemaException
Adds the given ModelGroup Definition to this Group
- Specified by:
- addGroup in interface ContentModelGroup
- 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
public void addWildcard(Wildcard wildcard) throws SchemaException
Adds a wildcard to this Group model
- Specified by:
- addWildcard in interface ContentModelGroup
- Parameters:
- Throws:
SchemaException
- thrown when the wildcard is anelement
public Enumeration enumerate()
Returns an enumeration of all the Particles of this ContentModelGroup
- Specified by:
- enumerate in interface ContentModelGroup
- Returns:
- an enumeration of the Particles contained within this ContentModelGroup
public ContentModelGroup getContentModelGroup()
Returns the ContentModelGroup for this group Only used for aelement
- Returns:
- the ContentModelGroup for this group
public ElementDecl getElementDecl(String name)
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 interface ContentModelGroup
- Parameters:
name
- the name of the element.
- Returns:
- the ElementDecl with the given name, or null if no ElementDecl exists in this ContentModelGroup.
public String getId()
Returns the ID for this Group
- Returns:
- the ID for this Group, or null if no ID is present
public String getName()
Returns the name of this Group, or null if no name was defined.
- Returns:
- the name of this Group, or null if no name was defined
public Order getOrder()
Returns the compositor for this Group
- Returns:
- the compositor for this Group
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.
public Particle getParticle(int index)
Returns the Particle at the specified index
- Specified by:
- getParticle in interface ContentModelGroup
- Parameters:
index
- the index of the particle to return
public int getParticleCount()
Returns the number of particles contained within this ContentModelGroup
- Specified by:
- getParticleCount in interface ContentModelGroup
- Returns:
- the number of particles
public String getReferenceId()
Returns the Id used to Refer to this Object
- Specified by:
- getReferenceId in interface Referable
- Returns:
- the Id used to Refer to this Object
- See Also:
Referable
public short getStructureType()
Returns the type of this Schema Structure
- Overrides:
- getStructureType in interface Structure
- Returns:
- the type of this Schema Structure
public boolean hasAny()
A helper method that returns true if this group contains anelement.
- Returns:
- method that returns true if this group contains an
element.
public boolean isModelGroupDefinition()
Deprecated. Since Castor 0.9.2, to handle properly the
element the class ModelGroup has been created Tells if the group is a model group definition
- Returns:
- true if the group is a model group definition (
tag), false otherwise ( , , or tags.
public boolean removeElementDecl(ElementDecl element)
Removes the given ElementDecl from this ContentModelGroup.
- Specified by:
- removeElementDecl in interface ContentModelGroup
- Parameters:
- Returns:
- true if the element has been successfully removed, false otherwise.
public boolean removeGroup(Group group)
Removes the given Group from this Group.
- Specified by:
- removeGroup in interface ContentModelGroup
- Parameters:
group
- the Group to remove.
- Returns:
- true if the group has been successfully removed, false otherwise.
public boolean removeGroup(ModelGroup group)
Removes the given ModelGroup Definition from this Group.
- Specified by:
- removeGroup in interface ContentModelGroup
- Parameters:
group
- the ModelGroup Definition to remove.
- Returns:
- true if the group has been successfully removed, false otherwise.
public boolean removeWildcard(Wildcard wildcard)
Removes the given Wildcard from this Group.
- Specified by:
- removeWildcard in interface ContentModelGroup
- Parameters:
- Returns:
- true if the wildcard has been successfully removed, false otherwise.
public void setId(String id)
Sets the ID for this Group
- Parameters:
id
- the ID for this Group
public void setIsModelGroupDefinition(boolean isModelGroupDefinition)
Deprecated. Since Castor 0.9.2, to handle properly the
element the class ModelGroup has been created Sets if the group is a model group definition
public void setName(String name)
Sets the name of this Group
- Parameters:
name
- the new name for this Group
public void setOrder(Order order)
Sets the Order option for this Group
- Parameters:
order
- the type of order that this group is restricted to
protected void setParent(Structure parent)
Sets the parent for this Group
- Parameters:
parent
- the parent Structure for this Group
public void validate() throws ValidationException
Checks the validity of this Group defintion.
- Throws:
ValidationException
- when this Group definition is invalid.