Package org.exolab.castor.xml.schema
Class RedefineSchema
- java.lang.Object
-
- org.exolab.castor.xml.schema.Structure
-
- org.exolab.castor.xml.schema.Annotated
-
- org.exolab.castor.xml.schema.RedefineSchema
-
- All Implemented Interfaces:
java.io.Serializable
public class RedefineSchema extends Annotated
This class is a wrapper used to save meta information concerning redefined structures from an XML schema.
This wrapper is identified by:
- a reference to the schema redefined
- the schema location of the redefined schema
- A vector containing the names of the structures redefined
- Version:
- $Revision: 8667 $ $Date: 2006-04-13 06:47:36 -0600 (Thu, 13 Apr 2006) $
- Author:
- Arnaud Blandin
- See Also:
- Serialized Form
-
-
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
Constructors Constructor Description RedefineSchema(Schema parentSchema)
Default constructor to create a RedefineSchema that contains only AnnotationsRedefineSchema(Schema parentSchema, Schema originalSchema)
Constructs a new RedefineSchema structure
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addAttributeGroup(AttributeGroupDecl attrGroup)
Adds a AttributeGroup name in the list of redefined attributeGroups.void
addComplexType(ComplexType complexType)
Adds the given complexType in the list of redefined complexTypes.void
addGroup(ModelGroup group)
Adds a group name in the list of redefined groups.void
addSimpleType(SimpleType simpleType)
Adds a simpleType in the list of redefined simpleTypes.java.util.Collection<AttributeGroup>
enumerateAttributeGroups()
Enumerates the attributeGroup names.java.util.Collection<ComplexType>
enumerateComplexTypes()
Enumerates the complexType names.java.util.Collection<ModelGroup>
enumerateGroups()
Enumerates the group names.java.util.Collection<SimpleType>
enumerateSimpleTypes()
Enumerates the simpleType names.AttributeGroupDecl
getAttributeGroup(java.lang.String name)
Returns the AttributeGroup corresponding to the given canonical name (unqualified name).ComplexType
getComplexType(java.lang.String name)
Returns the ComplexType corresponding to the given name.ModelGroup
getModelGroup(java.lang.String name)
Returns the Model Group of the given name that is contained in this RedefineSchema.Schema
getOriginalSchema()
Returns the schema imported used for the redefinitions.Schema
getParentSchema()
Returns the parent schema in which this RedefineSchema is used.java.lang.String
getSchemaLocation()
Returns the URI of the imported schema.SimpleType
getSimpleType(java.lang.String name)
Returns the SimpleType corresponding to the given name.short
getStructureType()
Returns the type of this Redefine Structureboolean
hasAttributeGroupRedefinition(java.lang.String name)
Returns true if this redefinition contains a redefinition for an AttributeGroup with the given name.boolean
hasComplexTypeRedefinition(java.lang.String name)
Returns true if this redefinition contains a redefinition for a complexType with the given name.boolean
hasGroupRedefinition(java.lang.String name)
Returns true if this redefinition contains a redefinition for a group with the given name.boolean
hasRedefinition()
Returns true if at least one structure other than an annotation is present.boolean
hasSimpleTypeRedefinition(java.lang.String name)
Returns true if this redefinition contains a redefinition for a simpleType with the given name.boolean
removeAttributeGroup(AttributeGroupDecl attrGroup)
Removes the attributeGroup with the given name from the redefine structure.boolean
removeComplexType(ComplexType complexType)
Removes the complexType with the given name from the redefine structure.boolean
removeGroup(ModelGroup group)
Removes the given ModelGroup from the redefine structure.boolean
removeSimpleType(SimpleType simpleType)
Removes the given simpleType from the redefine structure.void
validate()
Checks the validity of this Schema defintion.-
Methods inherited from class org.exolab.castor.xml.schema.Annotated
addAnnotation, getAnnotations, removeAnnotation
-
-
-
-
Method Detail
-
addComplexType
public void addComplexType(ComplexType complexType) throws SchemaException
Adds the given complexType in the list of redefined complexTypes.- Parameters:
complexType
- the ComplexType to add.- Throws:
SchemaException
-
enumerateComplexTypes
public java.util.Collection<ComplexType> enumerateComplexTypes()
Enumerates the complexType names.- Returns:
- an enumeration of the names of the redefined ComplexTypes
-
getComplexType
public ComplexType getComplexType(java.lang.String name)
Returns the ComplexType corresponding to the given name.- Parameters:
name
- the name of the ComplexType to look for.- Returns:
- the ComplexType corresponding to the gven name.
-
hasComplexTypeRedefinition
public boolean hasComplexTypeRedefinition(java.lang.String name)
Returns true if this redefinition contains a redefinition for a complexType with the given name.- Parameters:
name
- the canonical name of the complexType.
-
removeComplexType
public boolean removeComplexType(ComplexType complexType)
Removes the complexType with the given name from the redefine structure.- Parameters:
complexType
- The complexType to be removed from this Redefined Structure.
-
addSimpleType
public void addSimpleType(SimpleType simpleType) throws SchemaException
Adds a simpleType in the list of redefined simpleTypes.- Parameters:
simpleType
- the SimpleType to add.- Throws:
SchemaException
-
enumerateSimpleTypes
public java.util.Collection<SimpleType> enumerateSimpleTypes()
Enumerates the simpleType names.- Returns:
- an enumeration of the names of the redefined SimpleTypes.
-
getSimpleType
public SimpleType getSimpleType(java.lang.String name)
Returns the SimpleType corresponding to the given name.- Parameters:
name
- the name of the SimpleType to look for.- Returns:
- the SimpleType corresponding to the gven name.
-
hasSimpleTypeRedefinition
public boolean hasSimpleTypeRedefinition(java.lang.String name)
Returns true if this redefinition contains a redefinition for a simpleType with the given name.- Parameters:
name
- the canonical name of the simpleType.
-
removeSimpleType
public boolean removeSimpleType(SimpleType simpleType)
Removes the given simpleType from the redefine structure.- Parameters:
simpleType
- the simpleType to be removed from this Redefined Structure.
-
addGroup
public void addGroup(ModelGroup group) throws SchemaException
Adds a group name in the list of redefined groups.- Throws:
SchemaException
-
getModelGroup
public ModelGroup getModelGroup(java.lang.String name)
Returns the Model Group of the given name that is contained in this RedefineSchema.- Parameters:
name
- the name of the ModelGroup to retrieve.- Returns:
- the ModelGroup of the given name contained in this RedefineSchema.
-
enumerateGroups
public java.util.Collection<ModelGroup> enumerateGroups()
Enumerates the group names.- Returns:
- an enumeration of the names of the redefined groups.
-
hasGroupRedefinition
public boolean hasGroupRedefinition(java.lang.String name)
Returns true if this redefinition contains a redefinition for a group with the given name.- Parameters:
name
- the canonical name of the complexType.
-
removeGroup
public boolean removeGroup(ModelGroup group)
Removes the given ModelGroup from the redefine structure.- Parameters:
group
- the ModelGroup to be removed from this Redefined Structure.
-
addAttributeGroup
public void addAttributeGroup(AttributeGroupDecl attrGroup) throws SchemaException
Adds a AttributeGroup name in the list of redefined attributeGroups.- Throws:
SchemaException
-
getAttributeGroup
public AttributeGroupDecl getAttributeGroup(java.lang.String name)
Returns the AttributeGroup corresponding to the given canonical name (unqualified name).- Returns:
- the AttributeGroup corresponding to the given canonical name (unqualified name).
-
enumerateAttributeGroups
public java.util.Collection<AttributeGroup> enumerateAttributeGroups()
Enumerates the attributeGroup names.- Returns:
- an enumeration of the names of the redefined AttributeGroups.
-
hasAttributeGroupRedefinition
public boolean hasAttributeGroupRedefinition(java.lang.String name)
Returns true if this redefinition contains a redefinition for an AttributeGroup with the given name.- Parameters:
name
- the canonical name of the complexType.
-
removeAttributeGroup
public boolean removeAttributeGroup(AttributeGroupDecl attrGroup)
Removes the attributeGroup with the given name from the redefine structure.- Parameters:
attrGroup
- the attributeGroup to be removed from this Redefined Structure.
-
hasRedefinition
public boolean hasRedefinition()
Returns true if at least one structure other than an annotation is present.- Returns:
- true if at least one structure other than an annotation is present.
-
getSchemaLocation
public java.lang.String getSchemaLocation()
Returns the URI of the imported schema.- Returns:
- the URI of the imported schema.
-
getOriginalSchema
public Schema getOriginalSchema()
Returns the schema imported used for the redefinitions.- Returns:
- the original schema imported.
-
getParentSchema
public Schema getParentSchema()
Returns the parent schema in which this RedefineSchema is used.- Returns:
- the parent schema in which this Redefined Schema is used.
-
getStructureType
public short getStructureType()
Returns the type of this Redefine Structure- Specified by:
getStructureType
in classStructure
- Returns:
- the type of this Redefin Structure
-
validate
public void validate() throws ValidationException
Description copied from class:Structure
Checks the validity of this Schema defintion.- Specified by:
validate
in classStructure
- Throws:
ValidationException
- when this Schema definition is invalid.
-
-