Package org.apache.sis.xml
Class MarshalContext
Object
MarshalContext
Context of a marshalling or unmarshalling process.
- Since:
- 0.3
Defined in the sis-metadata module
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract LocaleReturns the locale to use for (un)marshalling, ornullif no locale were explicitly specified.abstract TimeZoneReturns the timezone to use for (un)marshalling, ornullif none was explicitly specified.abstract VersiongetVersion(String prefix) Returns the schema version of the XML document being (un)marshalled.
-
Constructor Details
-
MarshalContext
protected MarshalContext()Creates a new (un)marshalling context.
-
-
Method Details
-
getLocale
Returns the locale to use for (un)marshalling, ornullif no locale were explicitly specified. The locale returned by this method can be used for choosing a language in anInternationalString.This locale may vary in different fragments of the same XML document. In particular children of
Metadatainherit the locale specified by theMetadata.getLanguage()attribute.Handling of
Locale.ROOTLocale.ROOTis interpreted as a request for locale-neutral strings. The meaning of "locale-neutral" is implementation specific - this is usually very close to the English locale, but not necessarily. For examples dates are formatted according ISO standard instead of the rules of the English locale.Handling of
Anulllocalenullvalue means that the locale is unspecified. Callers are encouraged to use the root locale as the default value, but some flexibility is allowed.- Returns:
- the locale for the XML fragment being (un)marshalled, or
nullis unspecified. - See Also:
-
getTimeZone
Returns the timezone to use for (un)marshalling, ornullif none was explicitly specified.Handling of
Anulltimezonenullvalue means that the timezone is unspecified. Callers are encouraged to use the UTC timezone as the default value, but some flexibility is allowed.Upcoming API change — Java time API: return type may be changed toZoneIdwhen Apache SIS will target Java 8. This change may be applied in synchronization with GeoAPI 4.0.- Returns:
- the timezone for the XML fragment being (un)marshalled, or
nullif unspecified.
-
getVersion
Returns the schema version of the XML document being (un)marshalled. Theprefixargument can be any of the following values (case-sensitive):Supported schemas Prefix Standard Typical values gml Geographic Markup Language 3.0,3.2gmd Geographic MetaData 2007,2016- Parameters:
prefix- one of the above-cited prefix.- Returns:
- the version for the given schema, or
nullif unknown.
-