org.jibx.binding.def
Class BindingDefinition

java.lang.Object
  extended by org.jibx.binding.def.BindingBuilder.ContainerBase
      extended by org.jibx.binding.def.BindingDefinition
All Implemented Interfaces:
IContainer

public class BindingDefinition
extends BindingBuilder.ContainerBase
implements IContainer

Binding definition. This is the root of the object graph for a binding.

Version:
1.0
Author:
Dennis M. Sosnoski

Field Summary
private static java.lang.String CLASSES_ARRAYNAME
           
private static java.lang.String CREATEMARSHAL_METHODNAME
           
private static java.lang.String CREATEUNMARSHAL_METHODNAME
           
static java.lang.String CURRENT_VERSION_NAME
          Current distribution file name.
(package private) static java.lang.String DEFAULT_AUTOPREFIX
          Default prefix for automatic ID generation.
private static int FACTORY_INSTACCESS
           
private static java.lang.String FACTORY_INSTNAME
           
private static java.lang.String FACTORY_INTERFACE
           
private static java.lang.String[] FACTORY_INTERFACES
           
private static java.lang.String FACTORY_SUFFIX
           
static java.lang.String GENERATE_PREFIX
          Prefix used in all code generation for methods and classes.
private static java.lang.String GETCLASSES_METHODNAME
           
private static java.lang.String GETDEFINEDNSS_METHODNAME
           
private static java.lang.String GETDEFINEDPREFS_METHODNAME
           
private static java.lang.String GETDISTRIB_METHODNAME
           
private static java.lang.String GETELEMENTNAMES_METHODNAME
           
private static java.lang.String GETELEMENTNSS_METHODNAME
           
private static java.lang.String GETINST_METHODNAME
           
private static java.lang.String GETTYPEINDEX_METHODNAME
           
private static java.lang.String GETVERSION_METHODNAME
           
private static java.lang.String GNAMES_ARRAYNAME
           
private static java.lang.String GURIS_ARRAYNAME
           
private static java.lang.String IDNAMES_ARRAYNAME
           
private  DefinitionContext m_activeContext
          Inner definition context constructed for binding.
private  java.util.ArrayList m_extraClasses
          Classes handled by in-line marshaller/unmarshaller references.
private  java.util.ArrayList m_extraMarshallers
          Marshaller classes used in-line.
private  java.util.ArrayList m_extraUnmarshallers
          Unmarshaller classes used in-line.
private  int m_index
          Index number of this binding.
private  boolean m_isAddConstructors
          Add default constructors where needed flag.
private  boolean m_isForceClasses
          Generate marshaller/unmarshaller classes for top-level non-base abstract mappings flag.
private  boolean m_isForwards
          Support forward references to IDs flag.
private  boolean m_isIdGlobal
          Use global ID values flag.
private  boolean m_isInput
          Input binding flag.
private  boolean m_isMappedDone
          Flag for done assigning indexes to mapped classes.
private  boolean m_isOutput
          Output binding flag.
private  boolean m_isSchemaInstanceUsed
          Flag for schema instance namespace used in binding.
private  boolean m_isTrackSource
          Generate souce tracking interface flag.
private  int m_mumIndex
          Next index number for marshaller/unmarshaller slots used in-line.
private  java.lang.String m_name
          Binding name.
private  java.util.ArrayList m_namespacePrefixes
          Original prefixes for namespaces.
private  org.jibx.binding.util.ArrayMap m_namespaceUris
          Namespaces URIs included in binding.
private  DefinitionContext m_outerContext
          Outer definition context with default definitions.
private  java.lang.String m_targetPackage
          Package for generated context factory.
private  java.io.File m_targetRoot
          File root for generated context factory.
private  org.jibx.binding.util.ArrayMap m_uniqueIds
          Classes using unique (per class) identifiers.
private static java.lang.String MARSHALCONTEXT_IMPLEMENTATION
           
private static java.lang.String MARSHALCONTEXT_INTERFACE
           
private static java.lang.String MARSHALCONTEXTINIT_SIGNATURE
           
private static java.lang.String MARSHALLER_ARRAYNAME
           
private static java.lang.String PREFIXES_ARRAYNAME
           
static StringConversion s_base64Conversion
           
private static java.util.ArrayList s_bindings
          Table of defined bindings.
private static byte[] s_blanks
           
private static StringConversion s_booleanConversion
           
private static StringConversion s_byteConversion
           
private static StringConversion s_charConversion
           
private static StringConversion s_dateConversion
           
private static StringConversion s_doubleConversion
           
private static StringConversion s_floatConversion
           
private static StringConversion s_intConversion
           
private static StringConversion s_longConversion
           
private static org.jibx.binding.util.ArrayMap s_mappedClasses
          Classes included in any binding.
static StringConversion s_objectConversion
           
private static StringConversion s_shortConversion
           
private static StringConversion s_sqlDateConversion
           
private static StringConversion s_sqlTimeConversion
           
static StringConversion s_stringConversion
           
private static StringConversion s_timestampConversion
           
private static java.lang.String STRING_ARRAYTYPE
           
private static java.lang.String STRINGINT_MAPTYPE
           
private static java.lang.String STRINGINTADD_METHOD
           
private static java.lang.String STRINGINTADD_SIGNATURE
           
private static java.lang.String STRINGINTGET_METHOD
           
private static java.lang.String STRINGINTGET_SIGNATURE
           
private static java.lang.String STRINGINTINIT_SIGNATURE
           
private static int TYPEMAP_MINIMUM_SIZE
          Minimum size to use map for index from type name.
private static java.lang.String TYPEMAP_NAME
           
private static java.lang.String UNMARSHALCONTEXT_IMPLEMENTATION
           
private static java.lang.String UNMARSHALCONTEXT_INTERFACE
           
private static java.lang.String UNMARSHALCONTEXTINIT_SIGNATURE
           
private static java.lang.String UNMARSHALLER_ARRAYNAME
           
private static java.lang.String UNSUPPORTED_EXCEPTION_CLASS
           
private static java.lang.String URIS_ARRAYNAME
           
 
Fields inherited from class org.jibx.binding.def.BindingBuilder.ContainerBase
m_accessLevel, m_autoLink, m_container, m_nameStyle, m_stripPrefix, m_stripSuffix, m_styleDefault
 
Constructor Summary
BindingDefinition(java.lang.String name, boolean ibind, boolean obind, java.lang.String tpack, boolean glob, boolean forward, boolean source, boolean force)
          Constructor.
 
Method Summary
 void generateCode(boolean verbose)
          Generate code.
static BindingDefinition getBinding(int index)
          Get indexed binding.
 BindingDefinition getBindingRoot()
          Get root of binding definition.
 BoundClass getBoundClass()
          Get class linked to binding element.
 java.lang.String getDefaultPackage()
          Get default package used for code generation.
 java.io.File getDefaultRoot()
          Get root directory for default code generation package.
 DefinitionContext getDefinitionContext()
          Get definition context for binding element.
 int getIdClassIndex(java.lang.String name)
          Get index for ID'ed class from binding.
 int getIndex()
          Get index number of binding.
 int getMappedClassIndex(java.lang.String name)
          Get index for mapped class from binding.
 int getMarshallerUnmarshallerIndex(java.lang.String clas)
          Get marshaller/unmarshaller slot index in binding.
 int getNamespaceUriIndex(java.lang.String uri, java.lang.String prefix)
          Get index for namespace URI in binding.
 java.lang.String getPrefix()
          Get prefix for method or class generation.
 int getStyleDefault()
          Get default style for value expression.
 boolean hasNamespaces()
           
static void indent(int depth)
           
 boolean isAddConstructors()
          Check if default constructor generation is enabled.
 boolean isContentOrdered()
          Check if content children are ordered.
 boolean isForwards()
          Check if forward ids are supported by unmarshalling binding.
 boolean isIdGlobal()
          Check if global ids are used by binding.
 boolean isInput()
          Check if binding is defined for unmarshalling.
 boolean isOutput()
          Check if binding is defined for marshalling.
 boolean isTrackSource()
          Check if source tracking is supported by unmarshalling binding.
 void print()
           
static void reset()
          Discard cached information and reset in preparation for a new binding run.
 void setFactoryLocation(java.lang.String tpack, java.io.File root)
          Set location for binding factory class generation.
 boolean setIdChild(IComponent child)
          Set ID property.
 void setMarshallerUnmarshallerClasses(int slot, java.lang.String mclas, java.lang.String uclas)
          Set marshaller and unmarshaller class names for slot.
 void setSchemaInstanceUsed()
          Set flag for schema instance namespace used in binding.
 
Methods inherited from class org.jibx.binding.def.BindingBuilder.ContainerBase
unmarshal
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CURRENT_VERSION_NAME

public static final java.lang.String CURRENT_VERSION_NAME
Current distribution file name. This is filled in by the Ant build process to match the current distribution.

See Also:
Constant Field Values

GENERATE_PREFIX

public static final java.lang.String GENERATE_PREFIX
Prefix used in all code generation for methods and classes.

See Also:
Constant Field Values

DEFAULT_AUTOPREFIX

static final java.lang.String DEFAULT_AUTOPREFIX
Default prefix for automatic ID generation.

See Also:
Constant Field Values

TYPEMAP_MINIMUM_SIZE

private static final int TYPEMAP_MINIMUM_SIZE
Minimum size to use map for index from type name.

See Also:
Constant Field Values

s_bindings

private static java.util.ArrayList s_bindings
Table of defined bindings.


s_mappedClasses

private static org.jibx.binding.util.ArrayMap s_mappedClasses
Classes included in any binding.


s_byteConversion

private static StringConversion s_byteConversion

s_charConversion

private static StringConversion s_charConversion

s_doubleConversion

private static StringConversion s_doubleConversion

s_floatConversion

private static StringConversion s_floatConversion

s_intConversion

private static StringConversion s_intConversion

s_longConversion

private static StringConversion s_longConversion

s_shortConversion

private static StringConversion s_shortConversion

s_booleanConversion

private static StringConversion s_booleanConversion

s_dateConversion

private static StringConversion s_dateConversion

s_sqlDateConversion

private static StringConversion s_sqlDateConversion

s_sqlTimeConversion

private static StringConversion s_sqlTimeConversion

s_timestampConversion

private static StringConversion s_timestampConversion

s_base64Conversion

public static StringConversion s_base64Conversion

s_stringConversion

public static StringConversion s_stringConversion

s_objectConversion

public static StringConversion s_objectConversion

FACTORY_SUFFIX

private static final java.lang.String FACTORY_SUFFIX
See Also:
Constant Field Values

FACTORY_INTERFACE

private static final java.lang.String FACTORY_INTERFACE
See Also:
Constant Field Values

FACTORY_INTERFACES

private static final java.lang.String[] FACTORY_INTERFACES

FACTORY_INSTNAME

private static final java.lang.String FACTORY_INSTNAME
See Also:
Constant Field Values

FACTORY_INSTACCESS

private static final int FACTORY_INSTACCESS
See Also:
Constant Field Values

MARSHALLER_ARRAYNAME

private static final java.lang.String MARSHALLER_ARRAYNAME
See Also:
Constant Field Values

UNMARSHALLER_ARRAYNAME

private static final java.lang.String UNMARSHALLER_ARRAYNAME
See Also:
Constant Field Values

STRING_ARRAYTYPE

private static final java.lang.String STRING_ARRAYTYPE
See Also:
Constant Field Values

CLASSES_ARRAYNAME

private static final java.lang.String CLASSES_ARRAYNAME
See Also:
Constant Field Values

URIS_ARRAYNAME

private static final java.lang.String URIS_ARRAYNAME
See Also:
Constant Field Values

PREFIXES_ARRAYNAME

private static final java.lang.String PREFIXES_ARRAYNAME
See Also:
Constant Field Values

GNAMES_ARRAYNAME

private static final java.lang.String GNAMES_ARRAYNAME
See Also:
Constant Field Values

GURIS_ARRAYNAME

private static final java.lang.String GURIS_ARRAYNAME
See Also:
Constant Field Values

IDNAMES_ARRAYNAME

private static final java.lang.String IDNAMES_ARRAYNAME
See Also:
Constant Field Values

TYPEMAP_NAME

private static final java.lang.String TYPEMAP_NAME
See Also:
Constant Field Values

CREATEMARSHAL_METHODNAME

private static final java.lang.String CREATEMARSHAL_METHODNAME
See Also:
Constant Field Values

MARSHALCONTEXT_INTERFACE

private static final java.lang.String MARSHALCONTEXT_INTERFACE
See Also:
Constant Field Values

MARSHALCONTEXT_IMPLEMENTATION

private static final java.lang.String MARSHALCONTEXT_IMPLEMENTATION
See Also:
Constant Field Values

MARSHALCONTEXTINIT_SIGNATURE

private static final java.lang.String MARSHALCONTEXTINIT_SIGNATURE
See Also:
Constant Field Values

CREATEUNMARSHAL_METHODNAME

private static final java.lang.String CREATEUNMARSHAL_METHODNAME
See Also:
Constant Field Values

UNMARSHALCONTEXT_INTERFACE

private static final java.lang.String UNMARSHALCONTEXT_INTERFACE
See Also:
Constant Field Values

UNMARSHALCONTEXT_IMPLEMENTATION

private static final java.lang.String UNMARSHALCONTEXT_IMPLEMENTATION
See Also:
Constant Field Values

UNMARSHALCONTEXTINIT_SIGNATURE

private static final java.lang.String UNMARSHALCONTEXTINIT_SIGNATURE
See Also:
Constant Field Values

GETINST_METHODNAME

private static final java.lang.String GETINST_METHODNAME
See Also:
Constant Field Values

UNSUPPORTED_EXCEPTION_CLASS

private static final java.lang.String UNSUPPORTED_EXCEPTION_CLASS
See Also:
Constant Field Values

GETVERSION_METHODNAME

private static final java.lang.String GETVERSION_METHODNAME
See Also:
Constant Field Values

GETDISTRIB_METHODNAME

private static final java.lang.String GETDISTRIB_METHODNAME
See Also:
Constant Field Values

GETDEFINEDNSS_METHODNAME

private static final java.lang.String GETDEFINEDNSS_METHODNAME
See Also:
Constant Field Values

GETDEFINEDPREFS_METHODNAME

private static final java.lang.String GETDEFINEDPREFS_METHODNAME
See Also:
Constant Field Values

GETCLASSES_METHODNAME

private static final java.lang.String GETCLASSES_METHODNAME
See Also:
Constant Field Values

GETELEMENTNSS_METHODNAME

private static final java.lang.String GETELEMENTNSS_METHODNAME
See Also:
Constant Field Values

GETELEMENTNAMES_METHODNAME

private static final java.lang.String GETELEMENTNAMES_METHODNAME
See Also:
Constant Field Values

GETTYPEINDEX_METHODNAME

private static final java.lang.String GETTYPEINDEX_METHODNAME
See Also:
Constant Field Values

STRINGINT_MAPTYPE

private static final java.lang.String STRINGINT_MAPTYPE
See Also:
Constant Field Values

STRINGINTINIT_SIGNATURE

private static final java.lang.String STRINGINTINIT_SIGNATURE
See Also:
Constant Field Values

STRINGINTADD_METHOD

private static final java.lang.String STRINGINTADD_METHOD
See Also:
Constant Field Values

STRINGINTADD_SIGNATURE

private static final java.lang.String STRINGINTADD_SIGNATURE
See Also:
Constant Field Values

STRINGINTGET_METHOD

private static final java.lang.String STRINGINTGET_METHOD
See Also:
Constant Field Values

STRINGINTGET_SIGNATURE

private static final java.lang.String STRINGINTGET_SIGNATURE
See Also:
Constant Field Values

m_name

private final java.lang.String m_name
Binding name.


m_index

private final int m_index
Index number of this binding.


m_isInput

private final boolean m_isInput
Input binding flag.


m_isOutput

private final boolean m_isOutput
Output binding flag.


m_isIdGlobal

private final boolean m_isIdGlobal
Use global ID values flag.


m_isForwards

private final boolean m_isForwards
Support forward references to IDs flag.


m_isTrackSource

private final boolean m_isTrackSource
Generate souce tracking interface flag.


m_isForceClasses

private final boolean m_isForceClasses
Generate marshaller/unmarshaller classes for top-level non-base abstract mappings flag.


m_isAddConstructors

private boolean m_isAddConstructors
Add default constructors where needed flag.


m_targetPackage

private java.lang.String m_targetPackage
Package for generated context factory.


m_targetRoot

private java.io.File m_targetRoot
File root for generated context factory.


m_uniqueIds

private org.jibx.binding.util.ArrayMap m_uniqueIds
Classes using unique (per class) identifiers. This is null and unused when using global ID values.


m_namespaceUris

private org.jibx.binding.util.ArrayMap m_namespaceUris
Namespaces URIs included in binding.


m_namespacePrefixes

private java.util.ArrayList m_namespacePrefixes
Original prefixes for namespaces.


m_outerContext

private DefinitionContext m_outerContext
Outer definition context with default definitions.


m_activeContext

private DefinitionContext m_activeContext
Inner definition context constructed for binding.


m_isMappedDone

private boolean m_isMappedDone
Flag for done assigning indexes to mapped classes.


m_isSchemaInstanceUsed

private boolean m_isSchemaInstanceUsed
Flag for schema instance namespace used in binding.


m_mumIndex

private int m_mumIndex
Next index number for marshaller/unmarshaller slots used in-line.


m_extraClasses

private java.util.ArrayList m_extraClasses
Classes handled by in-line marshaller/unmarshaller references.


m_extraMarshallers

private java.util.ArrayList m_extraMarshallers
Marshaller classes used in-line.


m_extraUnmarshallers

private java.util.ArrayList m_extraUnmarshallers
Unmarshaller classes used in-line.


s_blanks

private static byte[] s_blanks
Constructor Detail

BindingDefinition

public BindingDefinition(java.lang.String name,
                         boolean ibind,
                         boolean obind,
                         java.lang.String tpack,
                         boolean glob,
                         boolean forward,
                         boolean source,
                         boolean force)
                  throws JiBXException
Constructor. Sets all defaults, including the default name provided, and initializes the definition context for the outermost level of the binding.

Parameters:
name - binding name
ibind - input binding flag
obind - output binding flag
tpack - target package
glob - global IDs flag
forward - support forward referenced IDs flag
source - add source tracking for unmarshalled objects flag
force - create marshaller/unmarshaller classes for top-level non-base mappings
Throws:
JiBXException - if error in transformation
Method Detail

getBoundClass

public BoundClass getBoundClass()
Get class linked to binding element. Implementation of IContainer interface, just returns null in this case.

Returns:
information for class linked by binding

getStyleDefault

public int getStyleDefault()
Get default style for value expression. Implementation of IContainer interface.

Specified by:
getStyleDefault in interface IContainer
Overrides:
getStyleDefault in class BindingBuilder.ContainerBase
Returns:
default style type for values

setIdChild

public boolean setIdChild(IComponent child)
Set ID property. This parent binding component interface method should never be called for the binding definition, and will throw a runtime exception if it is called.

Parameters:
child - child defining the ID property
Returns:
false

getDefaultPackage

public java.lang.String getDefaultPackage()
Get default package used for code generation.

Returns:
default code generation package

getDefaultRoot

public java.io.File getDefaultRoot()
Get root directory for default code generation package.

Returns:
root for default code generation

setFactoryLocation

public void setFactoryLocation(java.lang.String tpack,
                               java.io.File root)
Set location for binding factory class generation.

Parameters:
tpack - target package for generated context factory
root - target root for generated context factory

getIndex

public int getIndex()
Get index number of binding.

Returns:
index number for this binding definition

isInput

public boolean isInput()
Check if binding is defined for unmarshalling.

Returns:
true if defined, false if not

isOutput

public boolean isOutput()
Check if binding is defined for marshalling.

Returns:
true if defined, false if not

isIdGlobal

public boolean isIdGlobal()
Check if global ids are used by binding.

Returns:
true if defined, false if not

isForwards

public boolean isForwards()
Check if forward ids are supported by unmarshalling binding.

Returns:
true if supported, false if not

isTrackSource

public boolean isTrackSource()
Check if source tracking is supported by unmarshalling binding.

Returns:
true if defined, false if not

isAddConstructors

public boolean isAddConstructors()
Check if default constructor generation is enabled.

Returns:
true if default constructor generation enabled, false if not

getPrefix

public java.lang.String getPrefix()
Get prefix for method or class generation.

Returns:
prefix for names created by this binding

getMappedClassIndex

public int getMappedClassIndex(java.lang.String name)
Get index for mapped class from binding. If the class is not already included in any binding it is first added to the list of bound classes. All bindings use the same index numbers to allow easy lookup of the appropriate marshaller and unmarshaller within a particular binding, but this does mean that all bindings dealing with a common set of classes need to be compiled together. This uses the same sequence of values as the getMarshallerUnmarshallerIndex(java.lang.String) method but differs in that the values returned by this method are unique per class. This method is intended for use with <mapping> definitions. It is an error to call this method after calling the getMarshallerUnmarshallerIndex(java.lang.String) method.

Parameters:
name - fully qualified name of mapped class
Returns:
index number of class

getMarshallerUnmarshallerIndex

public int getMarshallerUnmarshallerIndex(java.lang.String clas)
Get marshaller/unmarshaller slot index in binding. This uses the same sequence of values as the getMappedClassIndex(java.lang.String) method but differs in that the same class may have more than one marshaller/unmarshaller slot defined. It's intended for user-defined marshallers/unmarshallers where use is specific to a particular context. After the slot has been assigned by this method, the setMarshallerUnmarshallerClasses(int, java.lang.String, java.lang.String) method must be used to set the actual class names.

Parameters:
clas - fully qualified name of class handled by marshaller/unmarshaller
Returns:
slot number for marshaller/unmarshaller

setMarshallerUnmarshallerClasses

public void setMarshallerUnmarshallerClasses(int slot,
                                             java.lang.String mclas,
                                             java.lang.String uclas)
Set marshaller and unmarshaller class names for slot.

Parameters:
slot - assigned marshaller/unmarshaller slot number
mclas - fully qualified name of marshaller class
uclas - fully qualified name of unmarshaller class

getIdClassIndex

public int getIdClassIndex(java.lang.String name)
Get index for ID'ed class from binding. If the class is not already included it is first added to the binding. If globally unique IDs are used this always returns 0.

Parameters:
name - fully qualified name of ID'ed class
Returns:
index number of class

getNamespaceUriIndex

public int getNamespaceUriIndex(java.lang.String uri,
                                java.lang.String prefix)
Get index for namespace URI in binding. If the URI is not already included it is first added to the binding. The empty namespace URI is always given index number 0.

Parameters:
uri - namespace URI to be included in binding
prefix - prefix used with namespace
Returns:
index number of namespace

setSchemaInstanceUsed

public void setSchemaInstanceUsed()
Set flag for schema instance namespace used in binding.


generateCode

public void generateCode(boolean verbose)
                  throws JiBXException
Generate code. First sets linkages and executes code generation for each top-level mapping defined in this binding, which in turn propagates the code generation all the way down. Then generates the actual binding factory for this binding. TODO: handle unidirectional bindings properly

Parameters:
verbose - flag for verbose output
Throws:
JiBXException - if error in code generation

getBinding

public static BindingDefinition getBinding(int index)
Get indexed binding.

Parameters:
index - number of binding to be returned
Returns:
binding at the specified index

reset

public static void reset()
Discard cached information and reset in preparation for a new binding run.


isContentOrdered

public boolean isContentOrdered()
Description copied from interface: IContainer
Check if content children are ordered.

Specified by:
isContentOrdered in interface IContainer
Returns:
true if ordered, false if not

hasNamespaces

public boolean hasNamespaces()

getBindingRoot

public BindingDefinition getBindingRoot()
Description copied from interface: IContainer
Get root of binding definition.

Specified by:
getBindingRoot in interface IContainer
Returns:
binding definition root

getDefinitionContext

public DefinitionContext getDefinitionContext()
Description copied from interface: IContainer
Get definition context for binding element.

Specified by:
getDefinitionContext in interface IContainer
Returns:
binding definition context

indent

public static void indent(int depth)

print

public void print()


Project Web Site