Package org.jibx.schema.elements
Class ElementElement
java.lang.Object
org.jibx.schema.elements.SchemaBase
org.jibx.schema.elements.OpenAttrBase
org.jibx.schema.elements.AnnotatedBase
org.jibx.schema.elements.ElementElement
- All Implemented Interfaces:
IArity
,IComponent
,INamed
,IReference
<element> element definition. The same code is used for both global and local element definitions, with the
differences checked during validation.
TODO: implement common base class for attribute and element?
- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
private long
Mask bits for identity constraint children.private long
Mask bits for inline type definition child.private boolean
'abstract' attribute value.private AllEnumSet
'block' attribute value.private String
'default' attribute value.private DefRefAttributeGroup
Name or reference.private AllEnumSet
'final' attribute value.private String
'fixed' attribute value.private FormChoiceAttribute
Form of name.private final FilteredSegmentList
Filtered list of identity constraint elements (zero or more).private final FilteredSegmentList
Filtered list of inline type definition elements (zero or one only).private boolean
'nillable' attribute value.private OccursAttributeGroup
Occurs attribute group.private QName
Qualified name (only defined after validation).private ElementElement
Element definition (from 'ref' attribute -null
if none).private QName
'substitutionGroup' attribute information.private QName
'type' attribute value.private CommonTypeDefinition
Complex or simple type definition (from 'type' attribute, or inline definition -null
if none).static final int
static final int
static final StringArray
List of allowed attribute names.static final EnumSet
static final EnumSet
static final int
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 -
Method Summary
Modifier and TypeMethodDescriptionprivate void
Clear any type information.getBlock()
Get 'block' attribute.Get 'default' attribute value.Get effective qualified name for element (whether defined directly, or by reference).getFinal()
Get 'final' attribute.getFixed()
Get 'fixed' attribute value.int
getForm()
Get 'form' attribute type code.Get 'form' attribute name value.Get list of identity constraint child elements.Get 'maxOccurs' attribute value.Get 'minOccurs' attribute value.getName()
Get 'name' attribute value.getQName()
Get qualified name set directly on element.getRef()
Get 'ref' attribute value.Get the referenced element declaration.Get 'substitutionGroup' attribute value.getType()
Get 'type' attribute value.Get type definition.boolean
Check 'abstract' attribute value.boolean
Check if the element uses an inline type definition.boolean
Check 'nillable' attribute value.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
setAbstract
(boolean abs) Set 'abstract' attribute value.void
setDefault
(String dflt) Set the 'default' attribute value.void
Set 'fixed' attribute value.void
setForm
(int type) Set 'form' attribute type code.void
setMaxOccurs
(Count count) Set 'maxOccurs' attribute value.void
setMinOccurs
(Count count) Get 'maxOccurs' attribute value.void
Set 'name' attribute value.void
setNillable
(boolean nil) Set 'nillable' attribute value.void
Set 'ref' attribute value.void
setSubstitutionGroup
(QName qname) Set 'substitutionGroup' attribute value.void
Set 'type' attribute value.void
Set type definition (either inline, or as reference).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
-
Field Details
-
s_allowedAttributes
List of allowed attribute names. -
INLINE_TYPE_MASK
private long INLINE_TYPE_MASKMask bits for inline type definition child. -
IDENTITY_CONSTRAINT_MASK
private long IDENTITY_CONSTRAINT_MASKMask bits for identity constraint children. -
EXTENSION_BLOCK
public static final int EXTENSION_BLOCK- See Also:
-
RESTRICTION_BLOCK
public static final int RESTRICTION_BLOCK- See Also:
-
SUBSTITUTION_BLOCK
public static final int SUBSTITUTION_BLOCK- See Also:
-
s_blockValues
-
EXTENSION_FINAL
public static final int EXTENSION_FINAL- See Also:
-
RESTRICTION_FINAL
public static final int RESTRICTION_FINAL- See Also:
-
s_derivationValues
-
m_inlineTypeList
Filtered list of inline type definition elements (zero or one only). -
m_identityConstraintList
Filtered list of identity constraint elements (zero or more). -
m_defRef
Name or reference. -
m_formChoice
Form of name. -
m_occurs
Occurs attribute group. -
m_type
'type' attribute value. -
m_default
'default' attribute value. -
m_fixed
'fixed' attribute value. -
m_abstract
private boolean m_abstract'abstract' attribute value. -
m_nillable
private boolean m_nillable'nillable' attribute value. -
m_block
'block' attribute value. -
m_final
'final' attribute value. -
m_substitutionGroup
'substitutionGroup' attribute information. -
m_refElement
Element definition (from 'ref' attribute -null
if none). -
m_typeDefinition
Complex or simple type definition (from 'type' attribute, or inline definition -null
if none). -
m_qname
Qualified name (only defined after validation).
-
-
Constructor Details
-
ElementElement
public ElementElement()Constructor.
-
-
Method Details
-
clearType
private void clearType()Clear any type information. This method is only visible for internal use, to be called in the process of setting new type information. -
preset
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 classSchemaBase
- Parameters:
ictx
- unmarshalling context- Throws:
JiBXException
- on error
-
getType
Get 'type' attribute value.- Returns:
- type (
null
if not set)
-
setType
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
Get 'default' attribute value.- Returns:
- default (
null
if not set)
-
setDefault
Set the 'default' attribute value.- Parameters:
dflt
- (null
if not set)
-
getFixed
Get 'fixed' attribute value.- Returns:
- fixed (
null
if not set)
-
setFixed
Set 'fixed' attribute value.- Parameters:
fixed
- (null
if not set)
-
isAbstract
public boolean isAbstract()Check 'abstract' attribute value.- Returns:
- abstract attribute value
-
setAbstract
public void setAbstract(boolean abs) Set 'abstract' attribute value.- Parameters:
abs
- abstract attribute value
-
isNillable
public boolean isNillable()Check 'nillable' attribute value.- Returns:
- nillable attribute value (
null
if not set)
-
setNillable
public void setNillable(boolean nil) Set 'nillable' attribute value.- Parameters:
nil
- nillable attribute value (null
if not set)
-
getFinal
Get 'final' attribute.- Returns:
- final
-
getBlock
Get 'block' attribute.- Returns:
- block
-
getSubstitutionGroup
Get 'substitutionGroup' attribute value.- Returns:
- substitutionGroup (
null
if not set)
-
setSubstitutionGroup
Set 'substitutionGroup' attribute value.- Parameters:
qname
- (null
if not set)
-
getReference
Get the referenced element declaration. This method is only usable after validation.- Returns:
- referenced element definition, or
null
if not a reference
-
getQName
Get qualified name set directly on element. This method is only usable after prevalidation. -
getEffectiveQName
Get effective qualified name for element (whether defined directly, or by reference). This method is only usable after prevalidation.- Returns:
- qname
-
isInlineType
public boolean isInlineType()Check if the element uses an inline type definition.- Returns:
true
if inline,false
if not
-
getTypeDefinition
Get type definition. This returns the actual type definition for the element, irrespective of whether the element uses an element reference, a type reference, or an inline type definition. It is only usable after validation.- Returns:
- type definition (
null
if empty type definition)
-
setTypeDefinition
Set type definition (either inline, or as reference).- Parameters:
def
- inline type definition
-
getIdentityConstraintList
Get list of identity constraint child elements.- Returns:
- list
-
getName
Get 'name' attribute value. -
getRef
Get 'ref' attribute value.- Specified by:
getRef
in interfaceIReference
- Returns:
- ref
- See Also:
-
setName
Set 'name' attribute value.- Parameters:
name
-- See Also:
-
setRef
Set 'ref' attribute value.- Parameters:
ref
-- See Also:
-
getForm
public int getForm()Get 'form' attribute type code.- Returns:
- form
- See Also:
-
getFormText
Get 'form' attribute name value.- Returns:
- form
- See Also:
-
setForm
public void setForm(int type) Set 'form' attribute type code.- Parameters:
type
-- See Also:
-
getMaxOccurs
Get 'maxOccurs' attribute value.- Specified by:
getMaxOccurs
in interfaceIArity
- Returns:
- count
- See Also:
-
getMinOccurs
Get 'minOccurs' attribute value.- Specified by:
getMinOccurs
in interfaceIArity
- Returns:
- count
- See Also:
-
setMaxOccurs
Set 'maxOccurs' attribute value.- Specified by:
setMaxOccurs
in interfaceIArity
- Parameters:
count
-- See Also:
-
setMinOccurs
Get 'maxOccurs' attribute value.- Specified by:
setMinOccurs
in interfaceIArity
- Parameters:
count
-- See Also:
-
prevalidate
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 interfaceIComponent
- Overrides:
prevalidate
in classAnnotatedBase
- Parameters:
vctx
- validation context
-
validate
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. TheSchemaBase.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 interfaceIComponent
- Overrides:
validate
in classSchemaBase
- Parameters:
vctx
- validation context
-