See: Description
Interface | Description |
---|---|
ILcdXMLDecoderLibrary |
Interface for XML decoder libraries, responsible for configuring a
TLcdXMLDecoder
so that it can be used for unmarshalling XML documents to Java object graphs. |
ILcdXMLDocumentContext |
Interface for accessing the context of an XML document being decoded.
|
ILcdXMLElementInfo |
Contains XML-related information specific to a single XML element.
|
ILcdXMLEncoderLibrary |
Interface for XML encoder libraries, responsible for configuring a
TLcdXMLEncoder
so that it can be used for marshalling Java object graphs to XML documents. |
ILcdXMLMappingLibrary |
Interface for XML mapping libraries, responsible for configuring a
TLcdXMLMapping . |
ILcdXMLMarshaller<T> |
An
ILcdXMLMarshaller is responsible for marshalling (serializing) Java object graphs into XML data. |
ILcdXMLObjectFactory<T> |
Interface for object factories that can create objects for a specific XML Schema type or element.
It separates the creation of objects from the XML parsing and object initialization. |
ILcdXMLUnmarshaller<T> |
An
ILcdXMLUnmarshaller is responsible for unmarshalling (deserializing) XML data into newly created Java
content trees. |
Class | Description |
---|---|
|
Deprecated
The use of this class has been deprecated.
|
TLcdXMLDecoder |
Main class for unmarshalling an XML document into a Java object graph, using
ILcdXMLUnmarshaller 's. |
TLcdXMLEncoder |
Utility class for marshalling Java object graphs into XML documents, using
ILcdXMLMarshaller 's. |
TLcdXMLJavaClassResolver |
An XML configuration class which is used by the XML binding framework to decide for which interface
or super class of a class a marshaller will be searched, in case no marshaller is available
for the class itself.
|
TLcdXMLMapping |
Contains a set of object factories that can be used to create a Java instance
representing an element from the XML document.
|
TLcdXMLMarshallerProvider |
Provider of
ILcdXMLMarshaller 's that can marshal instances of a specified Java class to a
specified XML element. |
TLcdXMLObjectFactoryProvider |
Provider of
ILcdXMLObjectFactory 's that can create a Java object for a specified
XML element. |
TLcdXMLUnmarshallerProvider |
Provider of
ILcdXMLUnmarshaller 's that can unmarshal a specified XML element to instances
of a specified Java class. |
TLcdXMLXPathConstants |
This class provides two additional constants that can be used when working with
XPathExpression instances working on Luciad domain objects. |
Enum | Description |
---|---|
ILcdXMLDocumentContext.Scope |
A type-safe enumeration, representing all possible scopes to be used
in XML document contexts.
|
com.luciad.format.xml
and com.luciad.format.xml.schema
packages. It is advised to use the framework in this package for new projects.
ILcdXMLUnmarshaller
classes for each of the supported XML elements.
ILcdXMLDecoderLibrary
that instantiates all
unmarshallers
and registers them on a TLcdXMLUnmarshallerProvider
.
TLcdXMLDecoder
instance with this library.decode
method.
ILcdXMLUnmarshaller
is the core interface for XML unmarshalling. Implementations
of this interface are responsible for unmarshalling (deserializing) XML data into newly created Java object graphs. The
actual parsing of the XML content is done via a StAX XMLStreamReader
which is passed to the unmarshaller.
Typically, an unmarshaller is capable of unmarshalling instances of one specific XML element into instances of one
specific Java class. See the class documentation of ILcdXMLUnmarshaller
for more information on how to implement
a basic unmarshaller.
TLcdXMLUnmarshallerProvider
acts as the central repository on which unmarshallers
for
all supported elements should be registered; unmarshallers can then query the unmarshaller provider to retrieve
unmarshallers
for each of their children.
As the order in which unmarshallers are registered on the unmarshaller provider is unspecified, it cannot be garantueed
that
unmarshallers for child elements are available already at the moment an unmarshaller is created. Unmarshallers should
therefore only retrieve child unmarshallers from the unmarshaller provider from within their unmarshal methods, not from
within
their constructor.
TLcdXMLDecoder
is the main decoder class from which the unmarshalling process
is initiated. It has a TLcdXMLUnmarshallerProvider
which provides the decoder with the necessary
unmarshallers.
It takes care of setting up an input stream and XMLStreamWriter, looking up an unmarshaller for
the XML document's root element in the TLcdXMLUnmarshallerProvider
and delegates the unmarshalling process to
this unmarshaller.
ILcdXMLDecoderLibrary
allows to group unmarshallers into larger building
blocks.
A decoder library is responsible for instantiating all of its unmarshallers and configure them on
the unmarshaller provider of the XML decoder.
Libraries are the main API building blocks for distributing sets of unmarshallers; they remove the need
to put all individual unmarshaller classes in a public API.
To support large and complex XML document hierarchies, multiple libraries can be combined and configured
together on a single XML decoder.
ILcdXMLMarshaller
classes for each of the supported XML elements.ILcdXMLEncoderLibrary
that groups all
marshallers
and registers them on a TLcdXMLMarshallerProvider
.
TLcdXMLEncoder
instance with this library.encode
method.
ILcdXMLMarshaller
,
TLcdXMLMarshallerProvider
, TLcdXMLEncoder
and ILcdXMLMarshallerLibary
are similar in use to their unmarshaller counterparts.
TLcdXMLEncoder
has a TLcdXMLJavaClassResolver
which provides
functionality for mapping a Java class to another class or an interface. Whenever no marshaller is found for the class
to be marshalled, this resolver will make a list of all Java classes/interfaces this class extends
or implements, and choose one of them to bind against, based on a priority list. This allows to register
marshallers on the marshaller provider for super classes or interfaces only, and let the class resolver take
care of the mapping of derived classes to one of these base classes/interfaces.