Package org.exolab.castor.xml.schema
Class AttributeGroupDecl
java.lang.Object
org.exolab.castor.xml.schema.Structure
org.exolab.castor.xml.schema.Annotated
org.exolab.castor.xml.schema.AttributeGroup
org.exolab.castor.xml.schema.AttributeGroupDecl
- All Implemented Interfaces:
Serializable
An XML Schema Attribute Group Definition
- Version:
- $Revision: 6230 $ $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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAttribute
(AttributeDecl attrDecl) Adds the given attribute definition to this AttributeGroupvoid
addReference
(AttributeGroupReference attrGroup) Adds the given AttributeGroupReference to this AttributeGroupReturns the wilcard used in this complexType (can be null)getAttribute
(String name) Returns the AttributeDecl associated with the given nameReturns an Enumeration of all the attributes of this attribute group.Returns the AttributeGroupReference of THIS attribute group.Returns the attributes of THIS attribute group.getName()
Returns the name of this AttributeGroupReturns the Schema that this AttributeGroupDecl belongs to.short
Returns the type of this Schema Structureboolean
isEmpty()
Returns true if this AttributeGroup does not contain any AttributeDecls or any non-empty AttributeGroupsboolean
Returns true if this attributeGroupDecl is a redefinition.boolean
removeAttribute
(AttributeDecl attr) Removes the given AttributeDecl from this AttributeGroup.boolean
removeReference
(AttributeGroupReference attrGroupReference) Removes the given AttributeGroupReference from this AttributeGroup.void
setAnyAttribute
(Wildcard wildcard) Sets the wildcard (anyAttribute) of this attribute Groupvoid
Sets the name of this AttributeGroupvoid
Sets this Group has redefined.void
validate()
Checks the validity of this Attribute declarationMethods inherited from class org.exolab.castor.xml.schema.AttributeGroup
getId, setId
Methods inherited from class org.exolab.castor.xml.schema.Annotated
addAnnotation, getAnnotations, removeAnnotation
-
Constructor Details
-
AttributeGroupDecl
Creates a new AttributeGroup definition- Parameters:
schema
- the Schema that this AttributeGroup belongs to.
-
-
Method Details
-
addAttribute
Adds the given attribute definition to this AttributeGroup- Parameters:
attrDecl
- the AttributeDecl to add
-
addReference
Adds the given AttributeGroupReference to this AttributeGroup- Parameters:
attrGroup
- the AttributeGroupReference to add
-
getLocalAttributes
Returns the attributes of THIS attribute group. (not those of the nested groups) -
getLocalAttributeGroupReferences
Returns the AttributeGroupReference of THIS attribute group. (not those of the nested groups) -
getAnyAttribute
Returns the wilcard used in this complexType (can be null)- Specified by:
getAnyAttribute
in classAttributeGroup
- Returns:
- the wilcard used in this complexType (can be null)
-
getAttribute
Returns the AttributeDecl associated with the given name- Specified by:
getAttribute
in classAttributeGroup
- Returns:
- the AttributeDecl associated with the given name, or null if no AttributeDecl with the given name was found.
-
getAttributes
Returns an Enumeration of all the attributes of this attribute group. The enumeration includes attributes from all AttributeGroupReferences contained in this AttributeGroup.- Specified by:
getAttributes
in classAttributeGroup
- Returns:
- an Enumeration of all the attributes of this attribute group.
-
getName
Returns the name of this AttributeGroup- Returns:
- the name of this AttributeGroup, or null, if no name was defined.
-
getSchema
Returns the Schema that this AttributeGroupDecl belongs to.- Returns:
- the Schema that this AttributeGroupDecl belongs to
-
isEmpty
public boolean isEmpty()Returns true if this AttributeGroup does not contain any AttributeDecls or any non-empty AttributeGroups- Specified by:
isEmpty
in classAttributeGroup
- Returns:
- true if this AttributeGroup does not contain any AttributeDecls or any non-empty AttributeGroups
-
isRedefined
public boolean isRedefined()Returns true if this attributeGroupDecl is a redefinition.- Returns:
- true if this attributeGroupDecl is a redefinition.
-
removeAttribute
Removes the given AttributeDecl from this AttributeGroup.- Parameters:
attr
- the attribute to remove.
-
removeReference
Removes the given AttributeGroupReference from this AttributeGroup.- Parameters:
attrGroupReference
- the AttributeGroupReference to remove.
-
setAnyAttribute
Sets the wildcard (anyAttribute) of this attribute Group- Throws:
SchemaException
- thrown when a wildcard as already be set or when the wildCard is not an <anyAttribute>.
-
setName
Sets the name of this AttributeGroup- Parameters:
name
- the name of this AttributeGroup
-
setRedefined
public void setRedefined()Sets this Group has redefined. -
getStructureType
public short getStructureType()Returns the type of this Schema Structure- Overrides:
getStructureType
in classAttributeGroup
- Returns:
- the type of this Schema Structure
-
validate
Checks the validity of this Attribute declaration- Overrides:
validate
in classAttributeGroup
- Throws:
ValidationException
- when this Attribute declaration is invalid
-