org.jibx.binding.model

Class MappingElement

java.lang.Object

org.jibx.binding.model.ElementBase

org.jibx.binding.model.NestingElementBase

org.jibx.binding.model.ContainerElementBase

org.jibx.binding.model.TemplateElementBase

org.jibx.binding.model.MappingElementBase

org.jibx.binding.model.MappingElement

public class MappingElement
extends MappingElementBase

Model component for mapping element of normal binding definition.

Author:

Dennis M. Sosnoski

Field Summary

Fields inherited from class org.jibx.binding.model.MappingElementBase

s_allowedAttributes

Fields inherited from class org.jibx.binding.model.TemplateElementBase

m_topChildren

Fields inherited from class org.jibx.binding.model.ElementBase

BINDING_ELEMENT, COLLECTION_ELEMENT, ELEMENT_NAMES, FORMAT_ELEMENT, INCLUDE_ELEMENT, INPUT_ELEMENT, MAPPING_ELEMENT, NAMESPACE_ELEMENT, OUTPUT_ELEMENT, SPLIT_ELEMENT, STRUCTURE_ELEMENT, TEMPLATE_ELEMENT, VALUE_ELEMENT

Constructor Summary

Constructors

Constructor and Description
MappingElement() Default constructor.

Method Summary

Modifier and Type	Method and Description
MappingElement	getExtendsMapping() Get mapping extended by this one.
void	validate(ValidationContext vctx) Validate element information.
void	validateExtension(ValidationContext vctx) Special validation method to link extension mappings to base mappings.
void	verifyConstruction(ValidationContext vctx) Verify that instances of the mapped class can be constructed.

Methods inherited from class org.jibx.binding.model.MappingElementBase

getExtendsName, getName, getNameAttributes, getNamespace, getPrefix, getTypeName, getTypeQName, getUri, isAbstract, isDefaultTemplate, prevalidate, setAbstract, setExtendsName, setName, setPrefix, setTypeName, setTypeQName, setUri

Methods inherited from class org.jibx.binding.model.TemplateElementBase

addExtensionType, addTopChild, getClassName, getExtensionTypes, getHandledClass, getObjectType, getType, hasObject, isImplicit, isOptional, setClassName, topChildIterator, topChildren

Methods inherited from class org.jibx.binding.model.ContainerElementBase

checkCompatibleChildren, classifyComponents, getAttributeComponents, getChildObjectType, getContentComponents, getCreateClass, getCreateType, getFactory, getFactoryName, getId, getLabel, getMarshaller, getMarshallerName, getPostset, getPostsetName, getPreget, getPregetName, getPreset, getPresetName, getUnmarshaller, getUnmarshallerName, getUsing, isAllowRepeats, isChoice, isClassified, isFlexible, isNillable, isOrdered, setAllowRepeats, setChoice, setComponents, setCreateType, setFactoryName, setFlexible, setIdChild, setLabel, setMarshallerName, setNillable, setOrdered, setPostsetName, setPregetName, setPresetName, setUnmarshallerName, setUsing, verifyConstruction

Methods inherited from class org.jibx.binding.model.NestingElementBase

addChild, childIterator, children, getDefaultStyle, getDefinitions, getStyle, getStyleName, setStyleName

Methods inherited from class org.jibx.binding.model.ElementBase

getComment, name, setComment, toString, type, validateAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MappingElement

public MappingElement()

Default constructor.

Method Detail

getExtendsMapping

public MappingElement getExtendsMapping()

Get mapping extended by this one.

Returns:

mapping extended by this one

verifyConstruction

public void verifyConstruction(ValidationContext vctx)

Verify that instances of the mapped class can be constructed. This method may be called during the validate(ValidationContext) processing of other elements. If this mapping has any extensions, the check is ignored. TODO: check that at least one of the extensions can be created

Parameters:

vctx - Validation Context

validate

public void validate(ValidationContext vctx)

Description copied from class: ElementBase

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

Overrides:

validate in class MappingElementBase

Parameters:

vctx - validation context

validateExtension

public void validateExtension(ValidationContext vctx)

Special validation method to link extension mappings to base mappings. This is called as a special step following registration, so that the normal validation pass can make use of the linkage information.

Parameters:

vctx - validation context