Package org.apache.sis.xml

package org.apache.sis.xml

Provides methods for marshalling and unmarshalling SIS objects in XML. The XML format is compliant with ISO 19115-3 specification for metadata, and compliant with GML for referencing objects.

The main class in this package is XML, which provides property keys that can be used for configuring (un)marshallers and convenience static methods. For example, the following code:

will produce a string like below:

Customizing the XML

In order to parse and format ISO 19115-3 compliant documents, SIS needs its own Marshaller and Unmarshaller instances (which are actually wrappers around standard instances). Those instances are created and cached by MarshallerPool, which is used internally by the above-cited XML class. However, developers can instantiate their own MarshallerPool in order to get more control on the marshalling and unmarshalling processes, including the namespace URLs and the errors handling.

The most common namespace URLs are defined in the Namespaces class. The parsing of some objects like URL and UUID, together with the behavior in case of parsing error, can be specified by the ValueConverter class.

Since:

0.3

Version:

1.3

Class	Description
IdentifiedObject	The interface for all SIS objects having identifiers.
IdentifierMap	A map view of some or all identifiers in an identified object.
IdentifierSpace<T>	Some identifier namespaces that are handled in a special way.
Implementation	Known JAXB implementations.
InputFactory	Provides access to XMLInputFactory methods as static methods working on a SIS-wide instance.
LegacyCodes	Mapping between some legacy codes (e.g.
MarshalContext	Context of a marshalling or unmarshalling process.
MarshallerPool	Creates and configures Marshaller or Unmarshaller objects for use with SIS.
Namespaces	Lists some namespaces URLs used by JAXB when (un)marshalling.
NilInternationalString	An empty InternationalString which is nil for the given reason.
NilObject	A marker interface for nil XML elements providing an explanation about why the information is absent.
NilObjectHandler	The handler for an object where all methods returns null or empty collections, except a few methods related to object identity.
NilReason	Explanation for a missing XML element.
OutputFactory	Provides access to XMLOutputFactory methods as static methods working on a SIS-wide instance.
Pooled	Base class of PooledMarshaller and PooledUnmarshaller.
PooledMarshaller	Wraps a Marshaller in order to have some control on the modifications applied on it.
PooledTemplate	The template to use for PooledMarshaller and PooledUnmarshaller initialization.
PooledUnmarshaller	Wraps a Unmarshaller in order to have some control on the modifications applied on it.
ReferenceResolver	Controls the (un)marshaller behavior regarding the xlink or uuidref attributes.
TransformedEvent<E extends XMLEvent>	Base class of events that are wrappers over the events emitted during the reading or writing of an XML document.
TransformedEvent.Attr	Wrapper over an attribute emitted during the reading or writing of an XML document.
TransformedEvent.End	Wrapper over an element emitted during the reading or writing of an XML document.
TransformedEvent.NS	Wrapper over a namespace emitted during the reading or writing of an XML document.
TransformedEvent.Start	Wrapper over an element emitted during the reading or writing of an XML document.
TransformedEvent.Type	The "xsi:type" attribute.
Transformer	Base class of XML reader or writer replacing the namespaces used in JAXB annotations by namespaces used in the XML document, or conversely (depending on the direction of the I/O operation).
TransformingNamespaces	In the associations between prefixes and namespaces, substitutes the namespaces used in JAXB annotations by the namespaces used in the XML document at marshalling time.
TransformingNamespaces.Inverse	Substitutes the XML namespaces used in XML documents by namespaces used in JAXB annotations.
TransformingNamespaces.Prefixes	Iterator for the prefixes to be returned by TransformingNamespaces.getPrefixes(String).
TransformingReader	A XML reader replacing the namespaces found in XML documents by the namespaces expected by SIS at unmarshalling time.
TransformingWriter	A writer replacing the namespaces used by JAXB by other namespaces to be used in the XML document at marshalling time.
TransformingWriter.Event	Wraps the StartElement produced by JAXB for using the namespaces used in the XML document.
TransformingWriter.NewDeferred	A sentinel value in the TransformingWriter.deferred queue meaning that after reaching this point, we need to reevaluate if the remaining elements should be written immediately of deferred again.
TransformVersion	The target version of standards for Transformer.
ValueConverter	Performs conversions of XML element or attribute values encountered during XML (un)marshalling.
XLink	The XML attributes defined by OGC in the xlink schema.
XLink.Actuate	Communicates the desired timing of traversal from the starting resource to the ending resource.
XLink.Show	Communicates the desired presentation of the ending resource on traversal from the starting resource.
XLink.Type	The type of a xlink.
XML	Provides convenience methods for marshalling and unmarshalling SIS objects.
XPointer	Parsers of pointers in x-paths, adapted to the syntax found in GML documents.