|
| |
|
| 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 known Subclasses: org.exolab.castor.xml.schema.ModelGroup,
| Group | | public Group()(Code) | | Creates a new Group, with no name
|
| Group | | public Group(String name)(Code) | | Creates a new Group with the given name
Parameters:
name - of the Group |
| addElementDecl | | public void addElementDecl(ElementDecl elementDecl) throws SchemaException(Code) | | Adds the given ElementDecl to this ContentModelGroup
Parameters:
elementDecl - the ElementDecl to add
exception:
SchemaException - when an ElementDecl alreadyexists with the same name as the given ElementDecl |
| addGroup | | public void addGroup(Group group) throws SchemaException(Code) | | Adds the given Group to this ContentModelGroup
Parameters:
group - the Group to add
exception:
SchemaException - when a group with the same name as thespecified group already exists in the current scope |
| addGroup | | public void addGroup(ModelGroup group) throws SchemaException(Code) | | Adds the given ModelGroup Definition to this Group
Parameters:
group - the ModelGroup to add
exception:
SchemaException - when a group with the same name as thespecified group already exists in the current scope |
| addWildcard | | public void addWildcard(Wildcard wildcard) throws SchemaException(Code) | | Adds a wildcard to this Group model
Parameters:
wildcard - the Wildcard to add
exception:
SchemaException - thrown when the wildcardis an element |
| enumerate | | public Enumeration enumerate()(Code) | | Returns an enumeration of all the Particles of this
ContentModelGroup
an enumeration of the Particles containedwithin this ContentModelGroup |
| getContentModelGroup | | public ContentModelGroup getContentModelGroup()(Code) | | Returns the ContentModelGroup for this group
Only used for a element
the ContentModelGroup for this group |
| getElementDecl | | public ElementDecl getElementDecl(String name)(Code) | | Returns the element declaration with the given name, or null if no
element declaration with that name exists in this ContentModelGroup.
Parameters:
name - the name of the element. the ElementDecl with the given name, or null if noElementDecl exists in this ContentModelGroup. |
| getId | | public String getId()(Code) | | Returns the ID for this Group
the ID for this Group, or null if no ID is present |
| getName | | public String getName()(Code) | | Returns the name of this Group, or null if no name was defined.
the name of this Group, or null if no name was defined |
| getOrder | | public Order getOrder()(Code) | | Returns the compositor for this Group
the compositor for this Group |
| getParent | | public Structure getParent()(Code) | | Returns the parent of this Group, this value may be null if
no parent has been set.
the parent Structure of this Group. |
| getParticle | | public Particle getParticle(int index)(Code) | | Returns the Particle at the specified index
Parameters:
index - the index of the particle to return the CMParticle at the specified index |
| getParticleCount | | public int getParticleCount()(Code) | | Returns the number of particles contained within
this ContentModelGroup
the number of particles |
| getReferenceId | | public String getReferenceId()(Code) | | Returns the Id used to Refer to this Object
the Id used to Refer to this Object
See Also: Referable |
| getStructureType | | public short getStructureType()(Code) | | Returns the type of this Schema Structure
the type of this Schema Structure |
| hasAny | | public boolean hasAny()(Code) | | A helper method that returns true if this group
contains an
element.
method that returns true if this groupcontains an element. |
| isEmptiable | | public boolean isEmptiable()(Code) | | true if this Particle is emptiable |
| isModelGroupDefinition | | public boolean isModelGroupDefinition()(Code) | | Tells if the group is a model group definition
true if the group is a model group definition ( tag), falseotherwise , , or tags. |
| removeElementDecl | | public boolean removeElementDecl(ElementDecl element)(Code) | | Removes the given ElementDecl from this ContentModelGroup.
Parameters:
element - the ElementDecl to remove. true if the element has been successfully removed, false otherwise. |
| removeGroup | | public boolean removeGroup(Group group)(Code) | | Removes the given Group from this Group.
Parameters:
group - the Group to remove. true if the group has been successfully removed, false otherwise. |
| removeGroup | | public boolean removeGroup(ModelGroup group)(Code) | | Removes the given ModelGroup Definition from this Group.
Parameters:
group - the ModelGroup Definition to remove. true if the group has been successfully removed, false otherwise. |
| removeWildcard | | public boolean removeWildcard(Wildcard wildcard)(Code) | | Removes the given Wildcard from this Group.
Parameters:
wildcard - the Wildcard to remove. true if the wildcard has been successfully removed, false otherwise. |
| setId | | public void setId(String id)(Code) | | Sets the ID for this Group
Parameters:
id - the ID for this Group |
| setIsModelGroupDefinition | | public void setIsModelGroupDefinition(boolean isModelGroupDefinition)(Code) | | Sets if the group is a model group definition
|
| setName | | public void setName(String name)(Code) | | Sets the name of this Group
Parameters:
name - the new name for this Group |
| setOrder | | public void setOrder(Order order)(Code) | | Sets the Order option for this Group
Parameters:
order - the type of order that this group is restricted to |
| setParent | | protected void setParent(Structure parent)(Code) | | Sets the parent for this Group
Parameters:
parent - the parent Structure for this Group |
| Fields inherited from org.exolab.castor.xml.schema.Particle | public static int UNBOUNDED(Code)(Java Doc)
|
|
|
|