org.exolab.castor.xml.schema

Class Group

Implemented Interfaces:
ContentModelGroup, Referable, java.io.Serializable
Known Direct Subclasses:
ModelGroup

public class Group
extends Particle
implements ContentModelGroup, Referable

An XML Schema Group
Version:
$Revision: 1.2 $ $Date: 2003/05/22 18:16:15 $
Author:
Keith Visco
See Also:
Serialized Form

Field Summary

Fields inherited from class org.exolab.castor.xml.schema.Particle

UNBOUNDED

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

Group()
Creates a new Group, with no name
Group(String name)
Creates a new Group with the given name

Method Summary

void
addElementDecl(ElementDecl elementDecl)
Adds the given ElementDecl to this ContentModelGroup
void
addGroup(Group group)
Adds the given Group to this ContentModelGroup
void
addGroup(ModelGroup group)
Adds the given ModelGroup Definition to this Group
void
addWildcard(Wildcard wildcard)
Adds a wildcard to this Group model
Enumeration
enumerate()
Returns an enumeration of all the Particles of this ContentModelGroup
ContentModelGroup
getContentModelGroup()
Returns the ContentModelGroup for this group Only used for a element
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.
String
getId()
Returns the ID for this Group
String
getName()
Returns the name of this Group, or null if no name was defined.
Order
getOrder()
Returns the compositor for this Group
Structure
getParent()
Returns the parent of this Group, this value may be null if no parent has been set.
Particle
getParticle(int index)
Returns the Particle at the specified index
int
getParticleCount()
Returns the number of particles contained within this ContentModelGroup
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 element.
boolean
isModelGroupDefinition()
Deprecated. Since Castor 0.9.2, to handle properly the element the class ModelGroup has been created
boolean
removeElementDecl(ElementDecl element)
Removes the given ElementDecl from this ContentModelGroup.
boolean
removeGroup(Group group)
Removes the given Group from this Group.
boolean
removeGroup(ModelGroup group)
Removes the given ModelGroup Definition from this Group.
boolean
removeWildcard(Wildcard wildcard)
Removes the given Wildcard from this Group.
void
setId(String id)
Sets the ID for this Group
void
setIsModelGroupDefinition(boolean isModelGroupDefinition)
Deprecated. Since Castor 0.9.2, to handle properly the element the class ModelGroup has been created
void
setName(String name)
Sets the name of this Group
void
setOrder(Order order)
Sets the Order option for this Group
protected void
setParent(Structure parent)
Sets the parent for this Group
void
validate()
Checks the validity of this Group defintion.

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

Constructor Details

Group

public Group()
Creates a new Group, with no name

Group

public Group(String name)
Creates a new Group with the given name
Parameters:
name - of the Group

Method Details

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

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

addGroup

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

addWildcard

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

enumerate

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

getContentModelGroup

public ContentModelGroup getContentModelGroup()
Returns the ContentModelGroup for this group Only used for a element
Returns:
the ContentModelGroup for this group

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.

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.

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

getParticleCount

public int getParticleCount()
Returns the number of particles contained within this ContentModelGroup
Specified by:
getParticleCount in interface ContentModelGroup
Returns:
the number of particles

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

getStructureType

public short getStructureType()
Returns the type of this Schema Structure
Overrides:
getStructureType in interface Structure
Returns:
the type of this Schema Structure

hasAny

public boolean hasAny()
A helper method that returns true if this group contains an element.
Returns:
method that returns true if this group contains an element.

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 (, , or tags.

removeElementDecl

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.

removeGroup

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.

removeGroup

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.

removeWildcard

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.

setId

public void setId(String id)
Sets the ID for this Group
Parameters:
id - the ID for 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

setName

public void setName(String name)
Sets the name of this Group
Parameters:
name - the new name for this Group

setOrder

public void setOrder(Order order)
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)
Sets the parent for this Group
Parameters:
parent - the parent Structure for this Group

validate

public void validate()
            throws ValidationException
Checks the validity of this Group defintion.
Overrides:
validate in interface Structure
Throws:
ValidationException - when this Group definition is invalid.

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com