org.jibx.schema.elements
Class AttributeGroupElement

java.lang.Object
  extended by org.jibx.schema.elements.SchemaBase
      extended by org.jibx.schema.elements.OpenAttrBase
          extended by org.jibx.schema.elements.AnnotatedBase
              extended by org.jibx.schema.elements.AttributeGroupElement
All Implemented Interfaces:
IComponent, INamed

public class AttributeGroupElement
extends AnnotatedBase
implements INamed

Top-level group element definition.

Author:
Dennis M. Sosnoski

Field Summary
private  long ANYATTRIBUTE_MASK
          Mask bits for any attribute child elements.
private  long ATTRIBUTE_MASK
          Mask bits for attribute child elements.
private  FilteredSegmentList m_anyAttributeList
          Filtered list of anyAttribute definition (zero or one).
private  FilteredSegmentList m_attributeList
          Filtered list of attribute definitions.
private  java.lang.String m_name
          'name' attribute value.
private  QName m_qname
          Qualified name (only defined after validation).
static StringArray s_allowedAttributes
          List of allowed attribute names.
 
Fields inherited from class org.jibx.schema.elements.SchemaBase
ALL_TYPE, ANNOTATION_TYPE, ANY_TYPE, ANYATTRIBUTE_TYPE, APPINFO_TYPE, ATTRIBUTE_TYPE, ATTRIBUTEGROUP_TYPE, CHOICE_TYPE, COMPLEXCONTENT_TYPE, COMPLEXTYPE_TYPE, DOCUMENTATION_TYPE, ELEMENT_MASKS, ELEMENT_NAMES, ELEMENT_TYPE, ENUMERATION_TYPE, EXTENSION_TYPE, FIELD_TYPE, FRACTIONDIGITS_TYPE, GROUP_TYPE, IMPORT_TYPE, INCLUDE_TYPE, KEY_TYPE, KEYREF_TYPE, LENGTH_TYPE, LIST_TYPE, MAXEXCLUSIVE_TYPE, MAXINCLUSIVE_TYPE, MAXLENGTH_TYPE, MINEXCLUSIVE_TYPE, MININCLUSIVE_TYPE, MINLENGTH_TYPE, NOTATION_TYPE, PATTERN_TYPE, REDEFINE_TYPE, RESTRICTION_TYPE, SCHEMA_TYPE, SELECTOR_TYPE, SEQUENCE_TYPE, SIMPLECONTENT_TYPE, SIMPLETYPE_TYPE, TOTALDIGITS_TYPE, UNION_TYPE, UNIQUE_TYPE, WHITESPACE_TYPE
 
Fields inherited from interface org.jibx.schema.IComponent
SCHEMA_NAMESPACE
 
Constructor Summary
AttributeGroupElement()
          Constructor.
 
Method Summary
 AnyAttributeElement getAnyAttribute()
          Get anyAttribute child element.
 FilteredSegmentList getAttributeList()
          Get list of attribute and attributeGroup child elements.
 java.lang.String getName()
          Get 'name' attribute value.
 QName getQName()
          Get qualified name for element.
protected  void preset(IUnmarshallingContext ictx)
          Pre-set method to be called by data binding while parsing element start tag.
 void prevalidate(ValidationContext vctx)
          Prevalidate component information.
 void setAnyAttribute(AnyAttributeElement element)
          Set anyAttribute child element.
 void setName(java.lang.String name)
          Set 'name' attribute value.
 
Methods inherited from class org.jibx.schema.elements.AnnotatedBase
getAnnotation, getId, setAnnotation, setId
 
Methods inherited from class org.jibx.schema.elements.OpenAttrBase
addExtraAttribute, clearExtraAttributes, compactChildren, detachChild, getChild, getChildCount, getChildIterator, getChildrenWritable, getExtraAttributes, preget, replaceChild, validateAttributes
 
Methods inherited from class org.jibx.schema.elements.SchemaBase
addNamespaceDeclaration, bit, clearNamespaceDeclarations, getExtension, getNamespaceDeclarations, getParent, getSchema, isGlobal, name, readNamespaces, setExtension, setParent, type, validate, validateAttributes, writeNamespaces
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

s_allowedAttributes

public static final StringArray s_allowedAttributes
List of allowed attribute names.


ATTRIBUTE_MASK

private long ATTRIBUTE_MASK
Mask bits for attribute child elements.


ANYATTRIBUTE_MASK

private long ANYATTRIBUTE_MASK
Mask bits for any attribute child elements.


m_attributeList

private final FilteredSegmentList m_attributeList
Filtered list of attribute definitions.


m_anyAttributeList

private final FilteredSegmentList m_anyAttributeList
Filtered list of anyAttribute definition (zero or one).


m_name

private java.lang.String m_name
'name' attribute value.


m_qname

private QName m_qname
Qualified name (only defined after validation).

Constructor Detail

AttributeGroupElement

public AttributeGroupElement()
Constructor.

Method Detail

getName

public java.lang.String getName()
Get 'name' attribute value.

Specified by:
getName in interface INamed
Returns:
name

setName

public void setName(java.lang.String name)
Set 'name' attribute value.

Parameters:
name -

getQName

public QName getQName()
Get qualified name for element. This method is only usable after prevalidation.

Specified by:
getQName in interface INamed
Returns:
qname (null if not defined)

getAttributeList

public FilteredSegmentList getAttributeList()
Get list of attribute and attributeGroup child elements.

Returns:
list of attributes

getAnyAttribute

public AnyAttributeElement getAnyAttribute()
Get anyAttribute child element.

Returns:
element, or null if none

setAnyAttribute

public void setAnyAttribute(AnyAttributeElement element)
Set anyAttribute child element.

Parameters:
element - element, or null if unsetting

preset

protected void preset(IUnmarshallingContext ictx)
               throws JiBXException
Description copied from class: SchemaBase
Pre-set method to be called by data binding while parsing element start tag. The base class implementation just sets the parent element link and reads in any extra namespaces defined on the element. Subclasses which override this implementation must call the base implementation during their processing.

Overrides:
preset in class SchemaBase
Parameters:
ictx - unmarshalling context
Throws:
JiBXException - on error

prevalidate

public void prevalidate(ValidationContext vctx)
Description copied from class: SchemaBase
Prevalidate component information. The prevalidation step is used to check isolated aspects of a component, such as the settings for enumerated values. This empty base class implementation should be overridden by each subclass that requires prevalidation handling.

Specified by:
prevalidate in interface IComponent
Overrides:
prevalidate in class AnnotatedBase
Parameters:
vctx - validation context


Project Web Site