org.exolab.castor.xml.schema

Class ModelGroup

Implemented Interfaces:
ContentModelGroup, Referable, java.io.Serializable

public class ModelGroup
extends Group

An XML Schema ModelGroup

Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:09:32 $

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

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

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
isReference()
Returns true if this model group definition simply references another model group Definition
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 org.exolab.castor.xml.schema.Group

addElementDecl, addGroup, addGroup, addWildcard, enumerate, getContentModelGroup, getElementDecl, getId, getName, getOrder, getParent, getParticle, getParticleCount, getReferenceId, getStructureType, hasAny, isModelGroupDefinition, removeElementDecl, removeGroup, removeGroup, removeWildcard, setId, setIsModelGroupDefinition, setName, setOrder, setParent, validate

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

ModelGroup

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


ModelGroup

public ModelGroup(String name,
                  Schema schema)
Creates a new ModelGroup with the given name

Parameters:
name - of the ModelGroup


ModelGroup

public ModelGroup(Schema schema)
Creates a new ModelGroup definition

Parameters:

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

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
Overrides:
getContentModelGroup in interface Group

Returns:
the ContentModelGroup for this group


getDeclarations

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


getName

public String getName()
Returns the name of this ModelGroup.
Overrides:
getName in interface Group

Returns:
the name of this ModelGroup.


getName

public String getName(boolean ignoreRef)
Returns the name of this Model Group definition

Parameters:

Returns:
the name of this element declaration


getReference

public ModelGroup getReference()
Returns the reference if any


getReferenceId

public String getReferenceId()
Returns the Id used to Refer to this Object
Specified by:
getReferenceId in interface Referable
Overrides:
getReferenceId in interface Group

Returns:
the Id used to Refer to this Object

See Also:
Referable


getSchema

public Schema getSchema()
Returns the schema that contains this modelGroup definition


getStructureType

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

Returns:
the type of this Schema Structure


hasReference

public boolean hasReference()
Returns true if this ModelGroup is referencing another one


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


setReference

public void setReference(String reference)
Sets the reference for this ModelGroup definition

Parameters:
reference - the name of the ModelGroup that this definition references


setSchema

public void setSchema(Schema schema)
Sets the Schema that contains this group.

Parameters:
schema - the Schema that contains this group.


validate

public void validate()
            throws ValidationException
Checks the validity of this Schema defintion.
Overrides:
validate in interface Group

Throws:
ValidationException - when this Schema definition is invalid.


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