|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jibx.binding.def.BindingBuilder.ContainerBase
org.jibx.binding.def.BindingDefinition
public class BindingDefinition
Binding definition. This is the root of the object graph for a binding.
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 |
---|
public static final java.lang.String CURRENT_VERSION_NAME
public static final java.lang.String GENERATE_PREFIX
static final java.lang.String DEFAULT_AUTOPREFIX
private static final int TYPEMAP_MINIMUM_SIZE
private static java.util.ArrayList s_bindings
private static org.jibx.binding.util.ArrayMap s_mappedClasses
private static StringConversion s_byteConversion
private static StringConversion s_charConversion
private static StringConversion s_doubleConversion
private static StringConversion s_floatConversion
private static StringConversion s_intConversion
private static StringConversion s_longConversion
private static StringConversion s_shortConversion
private static StringConversion s_booleanConversion
private static StringConversion s_dateConversion
private static StringConversion s_sqlDateConversion
private static StringConversion s_sqlTimeConversion
private static StringConversion s_timestampConversion
public static StringConversion s_base64Conversion
public static StringConversion s_stringConversion
public static StringConversion s_objectConversion
private static final java.lang.String FACTORY_SUFFIX
private static final java.lang.String FACTORY_INTERFACE
private static final java.lang.String[] FACTORY_INTERFACES
private static final java.lang.String FACTORY_INSTNAME
private static final int FACTORY_INSTACCESS
private static final java.lang.String MARSHALLER_ARRAYNAME
private static final java.lang.String UNMARSHALLER_ARRAYNAME
private static final java.lang.String STRING_ARRAYTYPE
private static final java.lang.String CLASSES_ARRAYNAME
private static final java.lang.String URIS_ARRAYNAME
private static final java.lang.String PREFIXES_ARRAYNAME
private static final java.lang.String GNAMES_ARRAYNAME
private static final java.lang.String GURIS_ARRAYNAME
private static final java.lang.String IDNAMES_ARRAYNAME
private static final java.lang.String TYPEMAP_NAME
private static final java.lang.String CREATEMARSHAL_METHODNAME
private static final java.lang.String MARSHALCONTEXT_INTERFACE
private static final java.lang.String MARSHALCONTEXT_IMPLEMENTATION
private static final java.lang.String MARSHALCONTEXTINIT_SIGNATURE
private static final java.lang.String CREATEUNMARSHAL_METHODNAME
private static final java.lang.String UNMARSHALCONTEXT_INTERFACE
private static final java.lang.String UNMARSHALCONTEXT_IMPLEMENTATION
private static final java.lang.String UNMARSHALCONTEXTINIT_SIGNATURE
private static final java.lang.String GETINST_METHODNAME
private static final java.lang.String UNSUPPORTED_EXCEPTION_CLASS
private static final java.lang.String GETVERSION_METHODNAME
private static final java.lang.String GETDISTRIB_METHODNAME
private static final java.lang.String GETDEFINEDNSS_METHODNAME
private static final java.lang.String GETDEFINEDPREFS_METHODNAME
private static final java.lang.String GETCLASSES_METHODNAME
private static final java.lang.String GETELEMENTNSS_METHODNAME
private static final java.lang.String GETELEMENTNAMES_METHODNAME
private static final java.lang.String GETTYPEINDEX_METHODNAME
private static final java.lang.String STRINGINT_MAPTYPE
private static final java.lang.String STRINGINTINIT_SIGNATURE
private static final java.lang.String STRINGINTADD_METHOD
private static final java.lang.String STRINGINTADD_SIGNATURE
private static final java.lang.String STRINGINTGET_METHOD
private static final java.lang.String STRINGINTGET_SIGNATURE
private final java.lang.String m_name
private final int m_index
private final boolean m_isInput
private final boolean m_isOutput
private final boolean m_isIdGlobal
private final boolean m_isForwards
private final boolean m_isTrackSource
private final boolean m_isForceClasses
private boolean m_isAddConstructors
private java.lang.String m_targetPackage
private java.io.File m_targetRoot
private org.jibx.binding.util.ArrayMap m_uniqueIds
null
and unused when using global ID values.
private org.jibx.binding.util.ArrayMap m_namespaceUris
private java.util.ArrayList m_namespacePrefixes
private DefinitionContext m_outerContext
private DefinitionContext m_activeContext
private boolean m_isMappedDone
private boolean m_isSchemaInstanceUsed
private int m_mumIndex
private java.util.ArrayList m_extraClasses
private java.util.ArrayList m_extraMarshallers
private java.util.ArrayList m_extraUnmarshallers
private static byte[] s_blanks
Constructor Detail |
---|
public BindingDefinition(java.lang.String name, boolean ibind, boolean obind, java.lang.String tpack, boolean glob, boolean forward, boolean source, boolean force) throws JiBXException
name
- binding nameibind
- input binding flagobind
- output binding flagtpack
- target packageglob
- global IDs flagforward
- support forward referenced IDs flagsource
- add source tracking for unmarshalled objects flagforce
- create marshaller/unmarshaller classes for top-level
non-base mappings
JiBXException
- if error in transformationMethod Detail |
---|
public BoundClass getBoundClass()
IContainer
interface, just returns
null
in this case.
public int getStyleDefault()
IContainer
interface.
getStyleDefault
in interface IContainer
getStyleDefault
in class BindingBuilder.ContainerBase
public boolean setIdChild(IComponent child)
child
- child defining the ID property
false
public java.lang.String getDefaultPackage()
public java.io.File getDefaultRoot()
public void setFactoryLocation(java.lang.String tpack, java.io.File root)
tpack
- target package for generated context factoryroot
- target root for generated context factorypublic int getIndex()
public boolean isInput()
true
if defined, false
if notpublic boolean isOutput()
true
if defined, false
if notpublic boolean isIdGlobal()
true
if defined, false
if notpublic boolean isForwards()
true
if supported, false
if notpublic boolean isTrackSource()
true
if defined, false
if notpublic boolean isAddConstructors()
true
if default constructor generation enabled,
false
if notpublic java.lang.String getPrefix()
public int getMappedClassIndex(java.lang.String name)
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.
name
- fully qualified name of mapped class
public int getMarshallerUnmarshallerIndex(java.lang.String clas)
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.
clas
- fully qualified name of class handled by
marshaller/unmarshaller
public void setMarshallerUnmarshallerClasses(int slot, java.lang.String mclas, java.lang.String uclas)
slot
- assigned marshaller/unmarshaller slot numbermclas
- fully qualified name of marshaller classuclas
- fully qualified name of unmarshaller classpublic int getIdClassIndex(java.lang.String name)
0
.
name
- fully qualified name of ID'ed class
public int getNamespaceUriIndex(java.lang.String uri, java.lang.String prefix)
0
.
uri
- namespace URI to be included in bindingprefix
- prefix used with namespace
public void setSchemaInstanceUsed()
public void generateCode(boolean verbose) throws JiBXException
verbose
- flag for verbose output
JiBXException
- if error in code generationpublic static BindingDefinition getBinding(int index)
index
- number of binding to be returned
public static void reset()
public boolean isContentOrdered()
IContainer
isContentOrdered
in interface IContainer
true
if ordered, false
if notpublic boolean hasNamespaces()
public BindingDefinition getBindingRoot()
IContainer
getBindingRoot
in interface IContainer
public DefinitionContext getDefinitionContext()
IContainer
getDefinitionContext
in interface IContainer
public static void indent(int depth)
public void print()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |