org.exolab.castor.xml.schema
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:
- java.io.Serializable, ContentModelGroup, Referable
public class ModelGroup
- extends Group
An XML Schema ModelGroup :
- Version:
- $Revision: 1.2 $ $Date: 2004/09/21 14:04:35 $
- Author:
- Keith Visco
- See Also:
- Serialized Form
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 |
ModelGroup()
Creates a new ModelGroup, with no name |
ModelGroup(Schema schema)
Creates a new ModelGroup definition |
ModelGroup(java.lang.String name,
Schema schema)
Creates a new ModelGroup with the given name |
Method Summary |
void |
addModelGroup(ModelGroup modelGroup)
Adds the given ModelGroup to this ModelGroup |
java.util.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 |
java.util.Enumeration |
getDeclarations()
Returns an ordered Enumeration of all the ContentModelType
definitions (element, group, modelGroupRef)+ |
java.lang.String |
getName()
Returns the name of this ModelGroup. |
java.lang.String |
getName(boolean ignoreRef)
Returns the name of this Model Group definition |
ModelGroup |
getReference()
Returns the reference if any |
java.lang.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(java.lang.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 org.exolab.castor.xml.schema.Group |
addElementDecl, addGroup, addGroup, addWildcard, getElementDecl, getId, getOrder, getParent, getParticle, getParticleCount, hasAny, isModelGroupDefinition, removeElementDecl, removeGroup, removeGroup, removeWildcard, setId, setIsModelGroupDefinition, setName, setOrder, setParent |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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(java.lang.String name,
Schema schema)
- Creates a new ModelGroup with the given name
- Parameters:
name
- of the ModelGroup
addModelGroup
public void addModelGroup(ModelGroup modelGroup)
- Adds the given ModelGroup to this ModelGroup
- Parameters:
modelGroup
- the ModelGroup to add to this ModelGroup
enumerate
public java.util.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
getDeclarations
public java.util.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 java.lang.String getName()
- Returns the name of this ModelGroup.
- Overrides:
getName
in class Group
- Returns:
- the name of this ModelGroup.
getName
public java.lang.String getName(boolean ignoreRef)
- Returns the name of this Model Group definition
- Parameters:
ingoreRef
- 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(java.lang.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
getReferenceId
public java.lang.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
hasReference
public boolean hasReference()
- 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.
Intalio Inc. (C) 1999-2004. All rights reserved http://www.intalio.com