Package org.jibx.binding.def
Class MappingDirect
java.lang.Object
org.jibx.binding.def.PassThroughComponent
org.jibx.binding.def.LinkableBase
org.jibx.binding.def.MappingBase
org.jibx.binding.def.MappingDirect
- All Implemented Interfaces:
IComponent
,ILinkable
,IMapping
Direct mapping using supplied marshaller and unmarshaller.
- Author:
- Dennis M. Sosnoski
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final BoundClass
Class file to use for added code.private final boolean
Flag for abstract mapping.private boolean
Flag for code added to class (if appropriate).private final DirectObject
Direct mapping implementation.Fields inherited from class org.jibx.binding.def.MappingBase
ABSTRACTMARSHALLER_INTERFACE, CHECKEXTENDS_FULLNAME, CHECKEXTENDS_METHODNAME, CHECKEXTENDS_SIGNATURE, GETINDEX_METHODNAME, GETINDEX_SIGNATURE, GETMARSHALLER_METHOD, GETMARSHALLER_SIGNATURE, GETNAME_METHODNAME, GETNAME_SIGNATURE, GETUNMARSHALLER_METHOD, GETUNMARSHALLER_SIGNATURE, IMARSHALLABLE_INTERFACE, IUNMARSHALLABLE_INTERFACE, MARSHALLABLE_METHODNAME, MARSHALLABLE_SIGNATURE, MARSHALLER_INTERFACE, MARSHALLERMARSHAL_METHOD, MARSHALLERMARSHAL_SIGNATURE, UNMARSHALLABLE_METHODNAME, UNMARSHALLABLE_SIGNATURE, UNMARSHALLER_INTERFACE, UNMARSHALLERUNMARSHAL_METHOD, UNMARSHALLERUNMARSHAL_SIGNATURE
Fields inherited from class org.jibx.binding.def.PassThroughComponent
m_component
-
Constructor Summary
ConstructorsConstructorDescriptionMappingDirect
(IContainer contain, String type, String tname, DirectObject dir, boolean abs) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add extension to abstract mapping.void
Add namespace.buildRef
(IContainer parent, IContextObj objc, String type, PropertyDefinition prop) Build reference to mapping.void
generateCode
(boolean force) Generate required code for mapping.Get the actual binding for a mapping.Get the mapped class information.Get class name handled by mapping.Get binding component implementing mapping.Get marshaller class used for mapping.getName()
Get mapped element name.Get namespaces defined for mapping.Get class name of type to be assumed for references to this mapping.Get unmarshaller class used for mapping.Get element wrapper name.boolean
Check if mapping is abstract.boolean
isBase()
Check if mapping has extensions.void
print
(int depth) void
Establish and validate linkages between binding components.Methods inherited from class org.jibx.binding.def.MappingBase
addIMarshallableMethod, addIUnmarshallableMethod, getMappingName, getTypeName
Methods inherited from class org.jibx.binding.def.LinkableBase
handleRecursion, isLinked
Methods inherited from class org.jibx.binding.def.PassThroughComponent
genAttributeMarshal, genAttributeUnmarshal, genAttrPresentTest, genContentMarshal, genContentPresentTest, genContentUnmarshal, genLoadId, genNewInstance, getType, hasAttribute, hasContent, hasId, isOptional, setWrappedComponent
-
Field Details
-
m_mappingImpl
Direct mapping implementation. -
m_boundClass
Class file to use for added code. -
m_isAbstract
private final boolean m_isAbstractFlag for abstract mapping. -
m_isGenerated
private boolean m_isGeneratedFlag for code added to class (if appropriate).
-
-
Constructor Details
-
MappingDirect
public MappingDirect(IContainer contain, String type, String tname, DirectObject dir, boolean abs) throws JiBXException Constructor.- Parameters:
contain
- containing binding definition structuretype
- bound class nametname
- qualified type name (null
if not specified)dir
- direct object informationabs
- abstract mapping flag- Throws:
JiBXException
- on mapping definition conflict
-
-
Method Details
-
getBoundClass
Get the mapped class information. This implements the method used by the base class.- Specified by:
getBoundClass
in classMappingBase
- Returns:
- information for mapped class
-
getBoundType
Description copied from interface:IMapping
Get class name handled by mapping.- Returns:
- name of class bound by mapping
-
getReferenceType
Description copied from interface:IMapping
Get class name of type to be assumed for references to this mapping.- Returns:
- reference type class name name
-
getImplComponent
Description copied from interface:IMapping
Get binding component implementing mapping. This call is only valid for mappings with child components, not for mappings defined using marshallers or unmarshallers.- Returns:
- binding component implementing this mapping
-
getMarshaller
Description copied from interface:IMapping
Get marshaller class used for mapping.- Returns:
- marshaller class information
- Throws:
JiBXException
- if error in configuration
-
getUnmarshaller
Description copied from interface:IMapping
Get unmarshaller class used for mapping.- Returns:
- unmarshaller class information
- Throws:
JiBXException
- if error in configuration
-
getName
Description copied from interface:IMapping
Get mapped element name.- Returns:
- mapped element name information (may be
null
if no element name defined for mapping)
-
addNamespace
Description copied from interface:IMapping
Add namespace. This adds a namespace definition to those active for the mapping.- Parameters:
ns
- namespace definition to be added
-
isAbstract
public boolean isAbstract()Description copied from interface:IMapping
Check if mapping is abstract.- Returns:
true
if an abstract mapping,false
if not
-
isBase
public boolean isBase()Description copied from interface:IMapping
Check if mapping has extensions.- Returns:
true
if one or more mappings extend this mapping,false
if not
-
addExtension
Description copied from interface:IMapping
Add extension to abstract mapping. This call is only valid for abstract mappings.- Parameters:
mdef
- extension mapping definition
-
buildRef
public IComponent buildRef(IContainer parent, IContextObj objc, String type, PropertyDefinition prop) throws JiBXException Description copied from interface:IMapping
Build reference to mapping. Constructs and returns the component for handling the mapping.- Parameters:
parent
- containing binding definition structureobjc
- current object contexttype
- mapped value typeprop
- property definition (may benull
)- Returns:
- constructed mapping reference component
- Throws:
JiBXException
- if configuration error
-
getNamespaces
Description copied from interface:IMapping
Get namespaces defined for mapping.- Returns:
- namespace definitions (may be
null
if none)
-
generateCode
Description copied from interface:IMapping
Generate required code for mapping.- Parameters:
force
- add marshaller/unmarshaller classes for abstract non-base mappings flag (not passed on to children)- Throws:
JiBXException
- if error in transformation
-
getWrapperName
Description copied from interface:IComponent
Get element wrapper name. If the component defines an element as the container for content, this returns the name information for that element.- Specified by:
getWrapperName
in interfaceIComponent
- Overrides:
getWrapperName
in classPassThroughComponent
- Returns:
- component element name,
null
if no wrapper element
-
setLinkages
Description copied from interface:ILinkable
Establish and validate linkages between binding components. This is called after the basic binding structures have been set up. All linkages between components must be resolved by this method, in order to prevent problems due to the order of definitions between components. This implies that each component must in turn call the same method for each child component. None of the other method calls defined by this interface are valid until after this call.- Specified by:
setLinkages
in interfaceILinkable
- Overrides:
setLinkages
in classLinkableBase
- Throws:
JiBXException
- if error in configuration
-
getBinding
Description copied from interface:IMapping
Get the actual binding for a mapping. This is only usable with mappings defined by a binding; if the mapping is instead defined by specifying marshaller and unmarshaller classes this will just return null.- Returns:
- binding structure, or
null
if none
-
print
public void print(int depth) - Specified by:
print
in interfaceIComponent
- Overrides:
print
in classLinkableBase
-