Class Group

Method Details

• addWildcard

  public void addWildcard(Wildcard wildcard) throws SchemaException

  Adds the given Wildcard to this ContentModelGroup.

  Specified by:

  addWildcard in interface ContentModelGroup

  Parameters:

  wildcard - the Wildcard to add

  Throws:

  SchemaException - when the Wildcard is <anyAttribute> and not <any>

  See Also:

  • ContentModelGroup.addWildcard(org.exolab.castor.xml.schema.Wildcard)

• removeWildcard

  public boolean removeWildcard(Wildcard wildcard)

  Removes the given Wildcard from this ContentModelGroup.

  Specified by:

  removeWildcard in interface ContentModelGroup

  Parameters:

  wildcard - the Wildcard 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 the ContentModelGroup for this group. Only used for a element

  Returns:

  the ContentModelGroup for this group

• getId

  public String getId()

  Returns the ID for this Group.

  Returns:

  the ID for this Group, or null if no ID is present

• getName

  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

• getOrder

  public Order getOrder()

  Returns the compositor for this Group.

  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 the element 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 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 <all/>, , or tags.

  See Also:

  • ModelGroup

• getReferenceId

  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

• setName

  public void setName(String name)

  Sets the name of this Group.

  Parameters:

  name - the new name for this Group

• setId

  public void setId(String id)

  Sets the ID for this Group.

  Parameters:

  id - the ID for this Group

• setOrder

  public void setOrder(Order order)

  Sets the Order for this Group.

  Parameters:

  order - the type of Order that this Group is restricted to

• addElementDecl

  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

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

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

  See Also:

  • ContentModelGroup.addGroup(org.exolab.castor.xml.schema.Group)

• removeGroup

  public boolean removeGroup(Group group)

  Removes the given Group from this ContentModelGroup.

  Specified by:

  removeGroup in interface ContentModelGroup

  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 given ModelGroup definition to this ContentModelGroup.

  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

  See Also:

  • ContentModelGroup.addGroup(org.exolab.castor.xml.schema.ModelGroup)

• removeGroup

  public boolean removeGroup(ModelGroup group)

  Removes the given ModelGroup definition from this ContentModelGroup.

  Specified by:

  removeGroup in interface ContentModelGroup

  Parameters:

  group - the ModelGroup 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 Enumeration<Annotated> enumerate()

  Returns an enumeration of all the Particles contained within this ContentModelGroup.

  Specified by:

  enumerate in interface ContentModelGroup

  Returns:

  an enumeration of all the Particles contained within this ContentModelGroup

  See Also:

  • ContentModelGroup.enumerate()

• getElementDecl

  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.

  See Also:

  • ContentModelGroup.getElementDecl(java.lang.String)

• getParticle

  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

  Returns:

  the CMParticle at the specified index

  See Also:

  • ContentModelGroup.getParticle(int)

• getParticleCount

  public int getParticleCount()

  Returns the number of particles contained within this ContentModelGroup.

  Specified by:

  getParticleCount in interface ContentModelGroup

  Returns:

  the number of particles

  See Also:

  • ContentModelGroup.getParticleCount()

• getStructureType

  public short getStructureType()

  Returns the type of this Schema Structure.

  Specified by:

  getStructureType in class Structure

  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 this Group defintion.

  Specified by:

  validate in class Structure

  Throws:

  ValidationException - when this Group definition is invalid.

• setParent

  protected void setParent(Structure parent)

  Sets the parent for this Group.

  Parameters:

  parent - the parent Structure for this Group

• isEmptiable

  public boolean isEmptiable()

  Indicates whether this Particle is 'emptiable'

  Overrides:

  isEmptiable in class Particle

  Returns:

  true if this Particle is 'emptiable'