Public Member Functions

org.exolab.castor.xml.schema.ModelGroup Class Reference

Inheritance diagram for org.exolab.castor.xml.schema.ModelGroup:
org.exolab.castor.xml.schema.Group org.exolab.castor.xml.schema.Particle org.exolab.castor.xml.schema.ContentModelGroup org.exolab.castor.xml.schema.Referable org.exolab.castor.xml.schema.Annotated org.exolab.castor.xml.schema.Structure

List of all members.

Public Member Functions

 ModelGroup ()
 ModelGroup (Schema schema)
 ModelGroup (String name, Schema schema)
void addModelGroup (ModelGroup modelGroup)
Enumeration enumerate ()
Enumeration getDeclarations ()
ContentModelGroup getContentModelGroup ()
String getName ()
String getName (boolean ignoreRef)
boolean isReference ()
void setRedefined ()
boolean isRedefined ()
void setReference (String reference)
short getStructureType ()
String getReferenceId ()
ModelGroup getReference ()
boolean hasReference ()
void validate () throws ValidationException
Schema getSchema ()
void setSchema (Schema schema)

Detailed Description

An XML Schema ModelGroup : <xsd:group>

Author:
Keith Visco
Version:
Revision:
1.2
Date:
2004/09/21 14:04:35

Constructor & Destructor Documentation

org.exolab.castor.xml.schema.ModelGroup.ModelGroup (  ) 

Creates a new ModelGroup, with no name

org.exolab.castor.xml.schema.ModelGroup.ModelGroup ( Schema  schema  ) 

Creates a new ModelGroup definition

Parameters:
schema,the XML Schema to which this ModelGroup belongs
org.exolab.castor.xml.schema.ModelGroup.ModelGroup ( String  name,
Schema  schema 
)

Creates a new ModelGroup with the given name

Parameters:
name of the ModelGroup

Member Function Documentation

void org.exolab.castor.xml.schema.ModelGroup.addModelGroup ( ModelGroup  modelGroup  ) 

Adds the given ModelGroup to this ModelGroup

Parameters:
modelGroup the ModelGroup to add to this ModelGroup
Enumeration org.exolab.castor.xml.schema.ModelGroup.enumerate (  ) 

Returns an enumeration of all the Particles of this ContentModelGroup

Returns:
an enumeration of the Particles contained within this ContentModelGroup

Reimplemented from org.exolab.castor.xml.schema.Group.

References org.exolab.castor.xml.schema.ContentModelGroup.enumerate(), and org.exolab.castor.xml.schema.ModelGroup.getContentModelGroup().

Enumeration org.exolab.castor.xml.schema.ModelGroup.getDeclarations (  ) 

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

String org.exolab.castor.xml.schema.ModelGroup.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
String org.exolab.castor.xml.schema.ModelGroup.getReferenceId (  ) 

Returns the Id used to Refer to this Object

Returns:
the Id used to Refer to this Object
See also:
Referable

Reimplemented from org.exolab.castor.xml.schema.Group.

References org.exolab.castor.xml.schema.ModelGroup.getName().

Schema org.exolab.castor.xml.schema.ModelGroup.getSchema (  ) 

Returns the schema that contains this modelGroup definition

Referenced by org.exolab.castor.builder.binding.XMLBindingComponent.getSchema().

short org.exolab.castor.xml.schema.ModelGroup.getStructureType (  ) 

Returns the type of this Schema Structure

Returns:
the type of this Schema Structure

Reimplemented from org.exolab.castor.xml.schema.Group.

Referenced by org.exolab.castor.xml.schema.ModelGroup.validate().

boolean org.exolab.castor.xml.schema.ModelGroup.hasReference (  ) 

Returns true if this ModelGroup is referencing another one

Returns:
true if this ModelGroup is referencing another one
boolean org.exolab.castor.xml.schema.ModelGroup.isRedefined (  ) 

Returns true if this group is a redefinition.

Returns:
true if this group is a redefinition.

Referenced by org.exolab.castor.xml.schema.Schema.addModelGroup(), and org.exolab.castor.xml.schema.ModelGroup.validate().

boolean org.exolab.castor.xml.schema.ModelGroup.isReference (  ) 

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

Returns:
true if this model group definition is a reference

Referenced by org.exolab.castor.builder.binding.XMLBindingComponent.getSchema(), and org.exolab.castor.xml.schema.ContentModelGroupImpl.removeGroup().

void org.exolab.castor.xml.schema.ModelGroup.setRedefined (  ) 
void org.exolab.castor.xml.schema.ModelGroup.setReference ( String  reference  ) 

Sets the reference for this ModelGroup definition

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

Referenced by org.exolab.castor.xml.schema.reader.ModelGroupUnmarshaller.ModelGroupUnmarshaller().

void org.exolab.castor.xml.schema.ModelGroup.setSchema ( Schema  schema  ) 

Sets the Schema that contains this group.

Parameters:
schema the Schema that contains this group.

The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties