org.jibx.schema.elements
Class AnnotatedBase

java.lang.Object
  extended by org.jibx.schema.elements.SchemaBase
      extended by org.jibx.schema.elements.OpenAttrBase
          extended by org.jibx.schema.elements.AnnotatedBase
All Implemented Interfaces:
IComponent
Direct Known Subclasses:
AttributeElement, AttributeGroupElement, AttributeGroupRefElement, CommonCompositorBase, CommonContentBase, CommonTypeDefinition, CommonTypeDerivation, ElementElement, FacetElement, GroupElement, KeyBase, ListElement, NotationElement, SchemaLocationBase, SelectionBase, UnionElement, WildcardBase

public abstract class AnnotatedBase
extends OpenAttrBase

Base class for all element structures in schema definition which support annotations. The 'id' attribute handling is also implemented in this class, since it goes together with the annotation support in the schema for schema. Finally, this class maintains the parent element relationship.

Author:
Dennis M. Sosnoski

Field Summary
private  AnnotationElement m_annotation
          Annotation for this element (null if none).
private  java.lang.String m_id
          "id" attribute value.
static StringArray s_allowedAttributes
          Enumeration 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
protected AnnotatedBase(int type)
          Constructor.
 
Method Summary
 AnnotationElement getAnnotation()
          Get annotation.
 java.lang.String getId()
          Get "id" attribute value.
 void prevalidate(ValidationContext vctx)
          Prevalidate component information.
 void setAnnotation(AnnotationElement ann)
          Set annotation.
 void setId(java.lang.String id)
          Set "id" value for element.
 
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, preset, 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
Enumeration of allowed attribute names


m_annotation

private AnnotationElement m_annotation
Annotation for this element (null if none).


m_id

private java.lang.String m_id
"id" attribute value.

Constructor Detail

AnnotatedBase

protected AnnotatedBase(int type)
Constructor.

Parameters:
type - element type
Method Detail

getAnnotation

public final AnnotationElement getAnnotation()
Get annotation.

Returns:
annotation element (null if none)

setAnnotation

public final void setAnnotation(AnnotationElement ann)
Set annotation.

Parameters:
ann - annotation element (null if none)

getId

public java.lang.String getId()
Get "id" attribute value.

Returns:
id attribute value

setId

public void setId(java.lang.String id)
Set "id" value for element.

Parameters:
id - id attribute value

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 SchemaBase
Parameters:
vctx - validation context


Project Web Site