org.jibx.schema.elements

Class AttributeElement

java.lang.Object

org.jibx.schema.elements.SchemaBase

org.jibx.schema.elements.OpenAttrBase

org.jibx.schema.elements.AnnotatedBase

org.jibx.schema.elements.AttributeElement

All Implemented Interfaces:

IComponent, INamed, IReference

public class AttributeElement
extends AnnotatedBase
implements INamed, IReference

Base representation for both local and global attribute element definition.

Author:

Dennis M. Sosnoski

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPTIONAL_USE
static int	PROHIBITED_USE
static int	REQUIRED_USE
static org.jibx.util.StringArray	s_allowedAttributes List of allowed attribute names.
static org.jibx.runtime.EnumSet	s_useValues

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

Constructors

Constructor and Description
AttributeElement() Constructor.

Method Summary

Modifier and Type	Method and Description
String	getDefault() Get 'default' attribute value.
org.jibx.runtime.QName	getEffectiveQName() Get effective qualified name for attribute (whether defined directly, or by reference).
String	getFixed() Get 'fixed' attribute value.
int	getForm() Get 'form' attribute type code.
String	getFormText() Get 'form' attribute name value.
String	getName() Get 'name' attribute value.
org.jibx.runtime.QName	getQName() Get qualified name set directly on attribute.
org.jibx.runtime.QName	getRef() Get 'ref' attribute value.
AttributeElement	getReference() Get the referenced attribute declaration.
org.jibx.runtime.QName	getType() Get 'type' attribute value.
CommonTypeDefinition	getTypeDefinition() Get type definition.
int	getUse() Get 'use' attribute type code.
String	getUseText() Get 'use' attribute text.
boolean	isInlineType() Check if the attribute uses an inline type definition.
protected void	preset(org.jibx.runtime.IUnmarshallingContext ictx) Pre-set method to be called by data binding while parsing element start tag.
void	prevalidate(ValidationContext vctx) Prevalidate component information.
void	setDefault(String dflt) Set the 'default' attribute value.
void	setFixed(String fixed) Set 'fixed' attribute value.
void	setForm(int type) Set 'form' attribute type code.
void	setName(String name) Set 'name' attribute value.
void	setRef(org.jibx.runtime.QName ref) Set 'ref' attribute value.
void	setType(org.jibx.runtime.QName type) Set 'type' attribute value.
void	setTypeDefinition(CommonTypeDefinition def) Set type definition.
void	setUse(int code) Set 'use' attribute type code.
void	validate(ValidationContext vctx) Validate component information.

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, 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 org.jibx.util.StringArray s_allowedAttributes

List of allowed attribute names.

OPTIONAL_USE

public static final int OPTIONAL_USE

See Also:

Constant Field Values

PROHIBITED_USE

public static final int PROHIBITED_USE

See Also:

Constant Field Values

REQUIRED_USE

public static final int REQUIRED_USE

See Also:

Constant Field Values

s_useValues

public static final org.jibx.runtime.EnumSet s_useValues

Constructor Detail

AttributeElement

public AttributeElement()

Constructor.

Method Detail

preset

protected void preset(org.jibx.runtime.IUnmarshallingContext ictx)
               throws org.jibx.runtime.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:

org.jibx.runtime.JiBXException - on error

getType

public org.jibx.runtime.QName getType()

Get 'type' attribute value.

Returns:

type (null if not set)

setType

public void setType(org.jibx.runtime.QName type)

Set 'type' attribute value. Note that this method should only be used prior to validation, since it will only set the type name and not link the actual type information.

Parameters:

type - (null if not set)

getDefault

public String getDefault()

Get 'default' attribute value.

Returns:

default (null if not set)

setDefault

public void setDefault(String dflt)

Set the 'default' attribute value.

Parameters:

dflt - (null if not set)

getFixed

public String getFixed()

Get 'fixed' attribute value.

Returns:

fixed (null if not set)

setFixed

public void setFixed(String fixed)

Set 'fixed' attribute value.

Parameters:

fixed - (null if not set)

getUse

public int getUse()

Get 'use' attribute type code.

Returns:

type code applied to this attribute

setUse

public void setUse(int code)

Set 'use' attribute type code.

Parameters:

code - (-1 to unset)

getUseText

public String getUseText()

Get 'use' attribute text.

Returns:

text (null if not set)

getQName

public org.jibx.runtime.QName getQName()

Get qualified name set directly on attribute. This method is only usable after prevalidation.

Specified by:

getQName in interface INamed

Returns:

qname (null if a reference)

getEffectiveQName

public org.jibx.runtime.QName getEffectiveQName()

Get effective qualified name for attribute (whether defined directly, or by reference). This method is only usable after prevalidation.

Returns:

qname

getReference

public AttributeElement getReference()

Get the referenced attribute declaration. This method is only usable after validation.

Returns:

referenced attribute declaration, or null if not a reference

isInlineType

public boolean isInlineType()

Check if the attribute uses an inline type definition.

Returns:

true if inline, false if not

getTypeDefinition

public CommonTypeDefinition getTypeDefinition()

Get type definition. This returns the actual type definition for the attribute, irrespective of whether the attribute uses an attribute reference, a type reference, or an inline type definition. It is only usable after validation.

Returns:

type definition

setTypeDefinition

public void setTypeDefinition(CommonTypeDefinition def)

Set type definition. If the supplied type definition is a global type it is used by reference; if a local type it is used inline.

Parameters:

def - type definition

getName

public String getName()

Get 'name' attribute value.

Specified by:

getName in interface INamed

Returns:

name

See Also:

DefRefAttributeGroup.getName()

getRef

public org.jibx.runtime.QName getRef()

Get 'ref' attribute value.

Specified by:

getRef in interface IReference

Returns:

ref

See Also:

DefRefAttributeGroup.getRef()

setName

public void setName(String name)

Set 'name' attribute value.

Parameters:

name - Name

See Also:

DefRefAttributeGroup.setName(java.lang.String)

setRef

public void setRef(org.jibx.runtime.QName ref)

Set 'ref' attribute value.

Parameters:

ref - attribute value

See Also:

DefRefAttributeGroup.setRef(org.jibx.runtime.QName)

getForm

public int getForm()

Get 'form' attribute type code.

Returns:

form

See Also:

FormChoiceAttribute.getForm()

getFormText

public String getFormText()

Get 'form' attribute name value.

Returns:

form

See Also:

FormChoiceAttribute.getFormText()

setForm

public void setForm(int type)

Set 'form' attribute type code.

Parameters:

type - code

See Also:

FormChoiceAttribute.setForm(int)

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

validate

public void validate(ValidationContext vctx)

Description copied from class: SchemaBase

Validate component information. The validation step is used for checking the interactions between components, such as name references to other components. The SchemaBase.prevalidate(org.jibx.schema.validation.ValidationContext) method will always be called for every component in the schema definition before this method is called for any component. This empty base class implementation should be overridden by each subclass that requires validation handling.

Specified by:

validate in interface IComponent

Overrides:

validate in class SchemaBase

Parameters:

vctx - validation context