Public Member Functions

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

Inheritance diagram for org.exolab.castor.xml.schema.AttributeGroupDecl:
org.exolab.castor.xml.schema.AttributeGroup org.exolab.castor.xml.schema.Annotated org.exolab.castor.xml.schema.Structure

List of all members.

Public Member Functions

 AttributeGroupDecl (Schema schema)
void addAttribute (AttributeDecl attrDecl)
void addReference (AttributeGroupReference attrGroup)
Enumeration getLocalAttributes ()
Enumeration getLocalAttributeGroupReferences ()
Wildcard getAnyAttribute ()
AttributeDecl getAttribute (String name)
Enumeration getAttributes ()
String getName ()
Schema getSchema ()
boolean isEmpty ()
boolean isRedefined ()
boolean removeAttribute (AttributeDecl attr)
boolean removeReference (AttributeGroupReference attrGroupReference)
void setAnyAttribute (Wildcard wildcard) throws SchemaException
void setName (String name)
void setRedefined ()
short getStructureType ()
void validate () throws ValidationException

Detailed Description

An XML Schema Attribute Group Definition

Author:
Keith Visco
Version:
Revision:
1.4
Date:
2004/10/01 13:25:21

Constructor & Destructor Documentation

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

Creates a new AttributeGroup definition

Parameters:
schema the Schema that this AttributeGroup belongs to.

Member Function Documentation

void org.exolab.castor.xml.schema.AttributeGroupDecl.addAttribute ( AttributeDecl  attrDecl  ) 

Adds the given attribute definition to this AttributeGroup

Parameters:
attrDecl the AttributeDecl to add

References org.exolab.castor.xml.schema.AttributeDecl.setParent().

Referenced by org.exolab.castor.xml.schema.ComplexType.addAttributeDecl().

void org.exolab.castor.xml.schema.AttributeGroupDecl.addReference ( AttributeGroupReference  attrGroup  ) 
Wildcard org.exolab.castor.xml.schema.AttributeGroupDecl.getAnyAttribute (  )  [virtual]

Returns the wilcard used in this complexType (can be null)

Returns:
the wilcard used in this complexType (can be null)

Implements org.exolab.castor.xml.schema.AttributeGroup.

AttributeDecl org.exolab.castor.xml.schema.AttributeGroupDecl.getAttribute ( String  name  )  [virtual]

Returns the AttributeDecl associated with the given name

Returns:
the AttributeDecl associated with the given name, or null if no AttributeDecl with the given name was found.

Implements org.exolab.castor.xml.schema.AttributeGroup.

References org.exolab.castor.xml.schema.AttributeGroupReference.getAttribute(), and org.exolab.castor.xml.schema.AttributeDecl.getName().

Referenced by org.exolab.castor.xml.schema.ComplexType.getAttributeDecl().

Enumeration org.exolab.castor.xml.schema.AttributeGroupDecl.getAttributes (  )  [virtual]

Returns an Enumeration of all the attributes of this attribute group. The enumeration includes attributes from all AttributeGroupReferences contained in this AttributeGroup.

Returns:
an Enumeration of all the attributes of this attribute group.

Implements org.exolab.castor.xml.schema.AttributeGroup.

Referenced by org.exolab.castor.xml.schema.ComplexType.getAttributeDecls().

Enumeration org.exolab.castor.xml.schema.AttributeGroupDecl.getLocalAttributeGroupReferences (  ) 

Returns the AttributeGroupReference of THIS attribute group. (not those of the nested groups)

Referenced by org.exolab.castor.xml.schema.ComplexType.getAttributeGroupReferences().

Enumeration org.exolab.castor.xml.schema.AttributeGroupDecl.getLocalAttributes (  ) 

Returns the attributes of THIS attribute group. (not those of the nested groups)

Referenced by org.exolab.castor.xml.schema.ComplexType.getLocalAttributeDecls().

String org.exolab.castor.xml.schema.AttributeGroupDecl.getName (  ) 

Returns the name of this AttributeGroup

Returns:
the name of this AttributeGroup, or null, if no name was defined.

Referenced by org.exolab.castor.xml.schema.Schema.removeAttributeGroup(), and org.exolab.castor.xml.schema.AttributeGroupDecl.setAnyAttribute().

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

Returns the Schema that this AttributeGroupDecl belongs to.

Returns:
the Schema that this AttributeGroupDecl belongs to
short org.exolab.castor.xml.schema.AttributeGroupDecl.getStructureType (  )  [virtual]

Returns the type of this Schema Structure

Returns:
the type of this Schema Structure

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

boolean org.exolab.castor.xml.schema.AttributeGroupDecl.isEmpty (  )  [virtual]

Returns true if this AttributeGroup does not contain any AttributeDecls or any non-empty AttributeGroups

Returns:
true if this AttributeGroup does not contain any AttributeDecls or any non-empty AttributeGroups

Implements org.exolab.castor.xml.schema.AttributeGroup.

boolean org.exolab.castor.xml.schema.AttributeGroupDecl.isRedefined (  ) 

Returns true if this attributeGroupDecl is a redefinition.

Returns:
true if this attributeGroupDecl is a redefinition.
boolean org.exolab.castor.xml.schema.AttributeGroupDecl.removeAttribute ( AttributeDecl  attr  ) 

Removes the given AttributeDecl from this AttributeGroup.

Parameters:
attr the attribute to remove.

Referenced by org.exolab.castor.xml.schema.ComplexType.removeAttributeDecl().

boolean org.exolab.castor.xml.schema.AttributeGroupDecl.removeReference ( AttributeGroupReference  attrGroupReference  ) 
void org.exolab.castor.xml.schema.AttributeGroupDecl.setAnyAttribute ( Wildcard  wildcard  )  throws SchemaException

Sets the wildcard (anyAttribute) of this attribute Group

Exceptions:
SchemaException thrown when a wildcard as already be set or when the wildCard is not an <anyAttribute>.

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

void org.exolab.castor.xml.schema.AttributeGroupDecl.setName ( String  name  ) 
void org.exolab.castor.xml.schema.AttributeGroupDecl.setRedefined (  ) 
void org.exolab.castor.xml.schema.AttributeGroupDecl.validate (  )  throws ValidationException [virtual]

Checks the validity of this Attribute declaration

Exceptions:
ValidationException when this Attribute declaration is invalid

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

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


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