AttributeGroupReference (Castor JavaDoc)

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.AttributeGroupReference

All Implemented Interfaces:

java.io.Serializable
```
public final class AttributeGroupReference
extends AttributeGroup
```
An XML Schema Attribute Group Definition

Version:

$Revision: 5951 $ $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 Description

AttributeGroupReference(Schema schema, java.lang.String reference)
Creates a new AttributeGroup definition

Constructors
Constructor	Description
`AttributeGroupReference(Schema schema, java.lang.String reference)`	Creates a new AttributeGroup definition

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Wildcard`	`getAnyAttribute()`	Returns the anyAttribute set in this attribute group if any.
`AttributeDecl`	`getAttribute(java.lang.String name)`	Returns the AttributeDecl associated with the given name
`java.util.Enumeration`	`getAttributes()`	Returns an enumeration of the AttributeDecls and AttributeGroups of this AttributeGroup
`java.lang.String`	`getReference()`	Gets the name of the attribute group this class refers to.
`boolean`	`isEmpty()`	Returns true if this AttributeGroup does not contain any AttributeDecls or any non-empty AttributeGroups
`AttributeGroup`	`resolveReference()`	Resolves the attribute group reference

Methods inherited from class org.exolab.castor.xml.schema.Annotated
addAnnotation, getAnnotations, removeAnnotation

Methods inherited from class org.exolab.castor.xml.schema.AttributeGroup
getId, getStructureType, setId, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- Constructor Detail
  - AttributeGroupReference
```
public AttributeGroupReference(Schema schema,
                               java.lang.String reference)
```
    Creates a new AttributeGroup definition
    
    Parameters:
    
    schema - the Schema that this AttributeGroup belongs to.
- Method Detail
  - getAnyAttribute
```
public Wildcard getAnyAttribute()
```
    Returns the anyAttribute set in this attribute group if any.
    
    Specified by:
    
    getAnyAttribute in class AttributeGroup
    
    Returns:
    
    the anyAttribute set in this attribute group if any.
  - getReference
```
public java.lang.String getReference()
```
    Gets the name of the attribute group this class refers to.
  - resolveReference
```
public AttributeGroup resolveReference()
```
    Resolves the attribute group reference
    
    Returns:
    
    the attribute group defined at the schema level that is refered to by this class.
  - getAttribute
```
public AttributeDecl getAttribute(java.lang.String name)
```
    Returns the AttributeDecl associated with the given name
    
    Specified by:
    
    getAttribute in class AttributeGroup
    
    Returns:
    
    the AttributeDecl associated with the given name, or null if no AttributeDecl with the given name was found.
  - getAttributes
```
public java.util.Enumeration getAttributes()
```
    Returns an enumeration of the AttributeDecls and AttributeGroups of this AttributeGroup
    
    Specified by:
    
    getAttributes in class AttributeGroup
    
    Returns:
    
    an Enumeration of the AttributeDecls and AttributeGroups of this AttributeGroup
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this AttributeGroup does not contain any AttributeDecls or any non-empty AttributeGroups
    
    Specified by:
    
    isEmpty in class AttributeGroup
    
    Returns:
    
    true if this AttributeGroup does not contain any AttributeDecls or any non-empty AttributeGroups

Class AttributeGroupReference

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeGroupReference

Method Detail

getAnyAttribute

getReference

resolveReference

getAttribute

getAttributes

isEmpty