Class ModelGroup

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

org.exolab.castor.xml.schema.ModelGroup

All Implemented Interfaces:

Serializable, ContentModelGroup, Referable

public class ModelGroup
extends Group

An XML Schema ModelGroup : invalid input: '<'xsd:group>

Version:

$Revision: 6230 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author:

Keith Visco

See Also:

• Serialized Form

Field Summary

Fields inherited from class Particle

UNBOUNDED

Modifier and Type	Field	Description
static int	UNBOUNDED	A constant to represent an UNBOUNDED particle

Fields inherited from class 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

Modifier and Type	Field	Description
static final short	ANNOTATION
static final short	ANYTYPE
static final short	APPINFO
static final short	ATTRIBUTE
static final short	ATTRIBUTE_GROUP
static final short	COMPLEX_CONTENT
static final short	COMPLEX_TYPE
static final short	DOCUMENTATION
static final short	ELEMENT
static final short	FACET
static final short	GROUP
static final short	IDENTITY_FIELD
static final short	IDENTITY_SELECTOR
static final short	KEY
static final short	KEYREF
static final short	LIST
static final short	MODELGROUP
static final short	MODELGROUP_REF
static final short	REDEFINE
static final short	SCHEMA
static final short	SIMPLE_CONTENT
static final short	SIMPLE_TYPE
static final short	UNION
static final short	UNIQUE
static final short	UNKNOWN
static final short	WILDCARD

Constructor Summary

Constructors

Constructor	Description
ModelGroup()	Creates a new ModelGroup, with no name
ModelGroup(String name, Schema schema)	Creates a new ModelGroup with the given name
ModelGroup(Schema schema)	Creates a new ModelGroup definition

Method Summary

Modifier and Type	Method	Description
void	addModelGroup(ModelGroup modelGroup)	Adds the given ModelGroup to this ModelGroup
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
Enumeration	getDeclarations()	Returns an ordered Enumeration of all the ContentModelType definitions (element, group, modelGroupRef)+
String	getName()	Returns the name of this ModelGroup.
String	getName(boolean ignoreRef)	Returns the name of this Model Group definition
ModelGroup	getReference()	Returns the reference if any
String	getReferenceId()	Returns the Id used to Refer to this Object
Schema	getSchema()	Returns the schema that contains this modelGroup definition
short	getStructureType()	Returns the type of this Schema Structure
boolean	hasReference()	Returns true if this ModelGroup is referencing another one
boolean	isRedefined()	Returns true if this group is a redefinition.
boolean	isReference()	Returns true if this model group definition simply references another model group Definition
void	setRedefined()	Sets this Group has redefined.
void	setReference(String reference)	Sets the reference for this ModelGroup definition
void	setSchema(Schema schema)	Sets the Schema that contains this group.
void	validate()	Checks the validity of this Schema defintion.

Methods inherited from class Group

addElementDecl, addGroup, addGroup, addWildcard, getElementDecl, getId, getOrder, getParent, getParticle, getParticleCount, hasAny, isEmptiable, isModelGroupDefinition, removeElementDecl, removeGroup, removeGroup, removeWildcard, setId, setIsModelGroupDefinition, setName, setOrder, setParent

Modifier and Type	Method	Description
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 ContentModelGroup.
void	addWildcard(Wildcard wildcard)	Adds the given Wildcard to this ContentModelGroup.
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.
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.
boolean	hasAny()	A helper method that returns true if this group contains an <any> element.
boolean	isEmptiable()	Indicates whether this Particle is 'emptiable'
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 ContentModelGroup.
boolean	removeGroup(ModelGroup group)	Removes the given ModelGroup definition from this ContentModelGroup.
boolean	removeWildcard(Wildcard wildcard)	Removes the given Wildcard from this ContentModelGroup.
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 for this Group.
protected void	setParent(Structure parent)	Sets the parent for this Group.

Methods inherited from class Particle

getMaxOccurs, getMinOccurs, isMaxOccursSet, isMinOccursSet, setMaxOccurs, setMinOccurs

Modifier and Type	Method	Description
final int	getMaxOccurs()	Returns the maximum number of occurances that this CMParticle may appear
final int	getMinOccurs()	Returns the minimum number of occurances that this CMParticle must appear
protected final boolean	isMaxOccursSet()	Indicates whetehr maxOccurs has been set.
protected final boolean	isMinOccursSet()	Indicates whether minOccurs has been set.
final void	setMaxOccurs(int maxOccurs)	Sets the maximum number of occurances that this CMParticle must appear within it's parent context
final void	setMinOccurs(int minOccurs)	Sets the minimum number of occurances that this CMParticle must appear within it's parent context

Methods inherited from class Annotated

addAnnotation, getAnnotations, removeAnnotation

Modifier and Type	Method	Description
void	addAnnotation(Annotation annotation)	Adds the given Annotation to this Annotated Structure.
Enumeration<Annotation>	getAnnotations()	Returns an Enumeration of the Annotations contained within this Annotated type.
void	removeAnnotation(Annotation annotation)	Removes the given Annotation from this Annotated Structure.

Methods inherited from class Structure

isValid

Modifier and Type	Method	Description
boolean	isValid()	Calls validate() to determine if this Schema Definition is valid.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ContentModelGroup

getMaxOccurs, getMinOccurs

Modifier and Type	Method	Description
int	getMaxOccurs()	Returns the maximum number of occurrences that this ContentModelGroup may appear.
int	getMinOccurs()	Returns the minimum number of occurrences that this ContentModelGroup must appear.

Constructor Details

ModelGroup

public ModelGroup()

Creates a new ModelGroup, with no name

ModelGroup

public ModelGroup(Schema schema)

Creates a new ModelGroup definition

Parameters:

schema - the XML Schema to which this ModelGroup belongs

ModelGroup

public ModelGroup(String name,
 Schema schema)

Creates a new ModelGroup with the given name

Parameters:

name - of the ModelGroup

Method Details

addModelGroup

public void addModelGroup(ModelGroup modelGroup)

Adds the given ModelGroup to this ModelGroup

Parameters:

modelGroup - the ModelGroup to add to this ModelGroup

enumerate

public Enumeration enumerate()

Returns an enumeration of all the Particles of this ContentModelGroup

Specified by:

enumerate in interface ContentModelGroup

Overrides:

enumerate in class Group

Returns:

an enumeration of the Particles contained within this ContentModelGroup

See Also:

• ContentModelGroup.enumerate()

getDeclarations

public Enumeration getDeclarations()

Returns an ordered Enumeration of all the ContentModelType definitions (element, group, modelGroupRef)+

getContentModelGroup

public ContentModelGroup getContentModelGroup()

Returns the ContentModelGroup for this group Only used for a element

Overrides:

getContentModelGroup in class Group

Returns:

the ContentModelGroup for this group

getName

public String getName()

Returns the name of this ModelGroup.

Overrides:

getName in class Group

Returns:

the name of this ModelGroup.

getName

public String getName(boolean ignoreRef)

Returns the name of this Model Group definition

Parameters:

ignoreRef - If True the name of the referenced model group (if specified) is returned

Returns:

the name of this element declaration

isReference

public boolean isReference()

Returns true if this model group definition simply references another model group Definition

Returns:

true if this model group definition is a reference

setRedefined

public void setRedefined()

Sets this Group has redefined.

isRedefined

public boolean isRedefined()

Returns true if this group is a redefinition.

Returns:

true if this group is a redefinition.

setReference

public void setReference(String reference)

Sets the reference for this ModelGroup definition

Parameters:

reference - the name of the ModelGroup that this definition references

getStructureType

public short getStructureType()

Returns the type of this Schema Structure

Overrides:

getStructureType in class Group

Returns:

the type of this Schema Structure

See Also:

• Structure.getStructureType()

getReferenceId

public String getReferenceId()

Returns the Id used to Refer to this Object

Specified by:

getReferenceId in interface Referable

Overrides:

getReferenceId in class Group

Returns:

the Id used to Refer to this Object

See Also:

• Referable

getReference

public ModelGroup getReference()

Returns the reference if any

Returns:

the reference if any

hasReference

public boolean hasReference()

Returns true if this ModelGroup is referencing another one

Returns:

true if this ModelGroup is referencing another one

validate

public void validate()
              throws ValidationException

Checks the validity of this Schema defintion.

Overrides:

validate in class Group

Throws:

ValidationException - when this Schema definition is invalid.

getSchema

public Schema getSchema()

Returns the schema that contains this modelGroup definition

setSchema

public void setSchema(Schema schema)

Sets the Schema that contains this group.

Parameters:

schema - the Schema that contains this group.