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:
Customizing the XML
In order to parse and format ISO 19115-3 compliant documents, SIS needs its ownMarshaller
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
-
ClassDescriptionThe interface for all SIS objects having identifiers.A map view of some or all identifiers in an identified object.Some identifier namespaces that are handled in a special way.Known JAXB implementations.Provides access to
XMLInputFactory
methods as static methods working on a SIS-wide instance.Mapping between some legacy codes (e.g.Context of a marshalling or unmarshalling process.Creates and configuresMarshaller
orUnmarshaller
objects for use with SIS.Lists some namespaces URLs used by JAXB when (un)marshalling.An emptyInternationalString
which is nil for the given reason.A marker interface for nil XML elements providing an explanation about why the information is absent.The handler for an object where all methods returns null or empty collections, except a few methods related to object identity.Explanation for a missing XML element.Provides access toXMLOutputFactory
methods as static methods working on a SIS-wide instance.Base class ofPooledMarshaller
andPooledUnmarshaller
.Wraps aMarshaller
in order to have some control on the modifications applied on it.The template to use forPooledMarshaller
andPooledUnmarshaller
initialization.Wraps aUnmarshaller
in order to have some control on the modifications applied on it.Controls the (un)marshaller behavior regarding thexlink
oruuidref
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.Wrapper over an attribute emitted during the reading or writing of an XML document.Wrapper over an element emitted during the reading or writing of an XML document.Wrapper over a namespace emitted during the reading or writing of an XML document.Wrapper over an element emitted during the reading or writing of an XML document.The"xsi:type"
attribute.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).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.Substitutes the XML namespaces used in XML documents by namespaces used in JAXB annotations.Iterator for the prefixes to be returned byTransformingNamespaces.getPrefixes(String)
.A XML reader replacing the namespaces found in XML documents by the namespaces expected by SIS at unmarshalling time.A writer replacing the namespaces used by JAXB by other namespaces to be used in the XML document at marshalling time.Wraps theStartElement
produced by JAXB for using the namespaces used in the XML document.A sentinel value in theTransformingWriter.deferred
queue meaning that after reaching this point, we need to reevaluate if the remaining elements should be written immediately of deferred again.The target version of standards forTransformer
.Performs conversions of XML element or attribute values encountered during XML (un)marshalling.The XML attributes defined by OGC in the xlink schema.Communicates the desired timing of traversal from the starting resource to the ending resource.Communicates the desired presentation of the ending resource on traversal from the starting resource.The type of axlink
.Provides convenience methods for marshalling and unmarshalling SIS objects.Parsers of pointers in x-paths, adapted to the syntax found in GML documents.