org.exolab.castor.xml.schema

Class AttributeGroup

java.lang.Object

org.exolab.castor.xml.schema.Structure

org.exolab.castor.xml.schema.Annotated

org.exolab.castor.xml.schema.AttributeGroup

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AttributeGroupDecl, AttributeGroupReference

public abstract class AttributeGroup
extends Annotated

An XML Schema Attribute Group Definition

Version:

$Revision$ $Date: 2006-04-14 04:14:43 -0600 (Fri, 14 Apr 2006) $

Author:

Keith Visco

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 and Description
AttributeGroup()

Method Summary

Modifier and Type	Method and Description
abstract Wildcard	getAnyAttribute() Returns the anyAttribute set in this attribute group if any.
abstract AttributeDecl	getAttribute(String name) Returns the AttributeDecl associated with the given name
abstract Enumeration<AttributeDecl>	getAttributes() Returns an Enumeration of all the attributes of this attribute group.
String	getId() Returns the id of this AttributeGroup
short	getStructureType() Returns the type of this Schema Structure
abstract boolean	isEmpty() Returns true if this AttributeGroup does not contain any AttributeDecls or any non-empty AttributeGroupReferences
void	setId(String id) Sets the id of this AttributeGroup
void	validate() Checks the validity of this Attribute declaration

Methods inherited from class org.exolab.castor.xml.schema.Annotated

addAnnotation, getAnnotations, removeAnnotation

Methods inherited from class org.exolab.castor.xml.schema.Structure

isValid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributeGroup

public AttributeGroup()

Method Detail

getAnyAttribute

public abstract Wildcard getAnyAttribute()

Returns the anyAttribute set in this attribute group if any.

Returns:

the anyAttribute set in this attribute group if any.

getAttribute

public abstract AttributeDecl getAttribute(String name)

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.

getAttributes

public abstract Enumeration<AttributeDecl> getAttributes()

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.

getId

public String getId()

Returns the id of this AttributeGroup

Returns:

the id of this AttributeGroup, or null, if no id was defined.

isEmpty

public abstract boolean isEmpty()

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

Returns:

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

getStructureType

public short getStructureType()

Returns the type of this Schema Structure

Specified by:

getStructureType in class Structure

Returns:

the type of this Schema Structure

setId

public void setId(String id)

Sets the id of this AttributeGroup

Parameters:

id - the id of this AttributeGroup

validate

public void validate()
              throws ValidationException

Checks the validity of this Attribute declaration

Specified by:

validate in class Structure

Throws:

ValidationException - when this Attribute declaration is invalid