org.jibx.schema.elements
Class GroupElement

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.GroupElement
All Implemented Interfaces:
IComponent, INamed

public class GroupElement
extends AnnotatedBase
implements INamed

Top-level group element definition.

Author:
Dennis M. Sosnoski

Field Summary
private  long DEFINITION_MASK
          Mask bits for allowed child elements.
private  FilteredSegmentList m_definitionList
          Filtered list of composited particle elements.
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
GroupElement()
          Constructor.
 
Method Summary
 CommonCompositorDefinition getDefinition()
          Get definition element.
 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 setDefinition(CommonCompositorDefinition element)
          Set definition 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.


DEFINITION_MASK

private long DEFINITION_MASK
Mask bits for allowed child elements.


m_definitionList

private final FilteredSegmentList m_definitionList
Filtered list of composited particle elements.


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

GroupElement

public GroupElement()
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)

getDefinition

public CommonCompositorDefinition getDefinition()
Get definition element.

Returns:
definition element, or null if not set

setDefinition

public void setDefinition(CommonCompositorDefinition element)
Set definition element.

Parameters:
element - definition 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