Package 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:
Serializable
,ContentModelGroup
,Referable
An XML Schema ModelGroup : invalid input: '<'xsd:group>
- Version:
- $Revision$ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $
- Author:
- Keith Visco
- See Also:
-
Field Summary
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
ConstructorsConstructorDescriptionCreates a new ModelGroup, with no nameModelGroup
(String name, Schema schema) Creates a new ModelGroup with the given nameModelGroup
(Schema schema) Creates a new ModelGroup definition -
Method Summary
Modifier and TypeMethodDescriptionvoid
addModelGroup
(ModelGroup modelGroup) Adds the given ModelGroup to this ModelGroupReturns an enumeration of all the Particles of this ContentModelGroupReturns the ContentModelGroup for this group Only used for aelement Returns an ordered Enumeration of all the ContentModelType definitions (element, group, modelGroupRef)+getName()
Returns the name of this ModelGroup.getName
(boolean ignoreRef) Returns the name of this Model Group definitionReturns the reference if anyReturns the Id used to Refer to this ObjectReturns the schema that contains this modelGroup definitionshort
Returns the type of this Schema Structureboolean
Returns true if this ModelGroup is referencing another oneboolean
Returns true if this group is a redefinition.boolean
Returns true if this model group definition simply references another model group Definitionvoid
Sets this Group has redefined.void
setReference
(String reference) Sets the reference for this ModelGroup definitionvoid
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, isEmptiable, isModelGroupDefinition, removeElementDecl, removeGroup, removeGroup, removeWildcard, setId, setIsModelGroupDefinition, setName, setOrder, setParent
Methods inherited from class org.exolab.castor.xml.schema.Particle
getMaxOccurs, getMinOccurs, isMaxOccursSet, isMinOccursSet, setMaxOccurs, setMinOccurs
Methods inherited from class org.exolab.castor.xml.schema.Annotated
addAnnotation, getAnnotations, removeAnnotation
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.exolab.castor.xml.schema.ContentModelGroup
getMaxOccurs, getMinOccurs
-
Constructor Details
-
ModelGroup
public ModelGroup()Creates a new ModelGroup, with no name -
ModelGroup
Creates a new ModelGroup definition- Parameters:
schema
- the XML Schema to which this ModelGroup belongs
-
ModelGroup
-
-
Method Details
-
addModelGroup
Adds the given ModelGroup to this ModelGroup- Parameters:
modelGroup
- the ModelGroup to add to this ModelGroup
-
enumerate
Returns an enumeration of all the Particles of this ContentModelGroup- Specified by:
enumerate
in interfaceContentModelGroup
- Overrides:
enumerate
in classGroup
- Returns:
- an enumeration of the Particles contained within this ContentModelGroup
- See Also:
-
getDeclarations
Returns an ordered Enumeration of all the ContentModelType definitions (element, group, modelGroupRef)+ -
getContentModelGroup
Returns the ContentModelGroup for this group Only used for aelement - Overrides:
getContentModelGroup
in classGroup
- Returns:
- the ContentModelGroup for this group
-
getName
-
getName
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
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 classGroup
- Returns:
- the type of this Schema Structure
- See Also:
-
getReferenceId
Returns the Id used to Refer to this Object- Specified by:
getReferenceId
in interfaceReferable
- Overrides:
getReferenceId
in classGroup
- Returns:
- the Id used to Refer to this Object
- See Also:
-
getReference
-
hasReference
public boolean hasReference()Returns true if this ModelGroup is referencing another one- Returns:
- true if this ModelGroup is referencing another one
-
validate
Checks the validity of this Schema defintion.- Overrides:
validate
in classGroup
- Throws:
ValidationException
- when this Schema definition is invalid.
-
getSchema
Returns the schema that contains this modelGroup definition -
setSchema
Sets the Schema that contains this group.- Parameters:
schema
- the Schema that contains this group.
-