de.aristaflow.adept2.extensions.datatypes

Class LocalisationUdt

java.lang.Object

de.aristaflow.adept2.extensions.datatypes.AbstractXmlBasedUdt

de.aristaflow.adept2.extensions.datatypes.LocalisationUdt

public class LocalisationUdt
extends AbstractXmlBasedUdt

This class represents a map-structure providing localisation for values of any ProcessConstants.AdeptDataType. By mapping arbitrary locales to localised values this allows for localisation of the value of any data element.
There are methods for accessing the localised value directly or by considering the usual localisation behaviour of using the localisation for the closest locale. Use the empty string for the default locale that applies of no localisation for a more specific locale is present.

The map-structure is stored in an appropriate XML representation in a UDTValue. Wrap such a UDTValue by this class for simplified access to and manipulation of the localisation data.

Author:

Ulrich Kreher

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ENTRY The name of the XML-element for an entry of the localisation map.
protected ProcessConstants.AdeptDataType	innerType The data type of the localised values of this localisation UDT.
protected static java.lang.String	LOCALE_ELEMENT_COUNTRY The name of the XML-element for the country of a locale.
protected static java.lang.String	LOCALE_ELEMENT_LANGUAGE The name of the XML-element for the language of a locale.
protected static java.lang.String	LOCALE_ELEMENT_LOCALISATION The name of the XML-element for the localised value.
protected static java.lang.String	LOCALE_ELEMENT_VARIANT The name of the XML-element for the variant of a locale.
protected java.util.Map<java.util.Locale,java.io.Serializable>	localisationMap The map containing the localisation values indexed by the corresponding locale.
protected static java.lang.String	TYPE The name of the XML-attribute for the inner type that is an ProcessConstants.AdeptDataType.
static java.lang.String	UDT_NAME The UDT name of this data type.
protected static java.lang.String	XML_NAMESPACE The namespace for the XML-representation of this UDT.
protected static java.lang.String	XSD_FILE_NAME The filename for the XSD of this UDT.

Fields inherited from class de.aristaflow.adept2.extensions.datatypes.AbstractXmlBasedUdt

logger, xmlElementName, xmlNamespace

Constructor Summary

Constructors

Constructor and Description
LocalisationUdt(java.io.InputStream stream) Creates a new localisation UDT for the designated InputStream.
LocalisationUdt(java.util.Map<java.util.Locale,java.io.Serializable> localisationMap, ProcessConstants.AdeptDataType innerType) Creates a new localisation UDT for localisations of values of the designated type.
LocalisationUdt(ProcessConstants.AdeptDataType innerType) Creates a new localisation UDT for localisations of values of the designated type.
LocalisationUdt(UDTValue value) Creates a new localisation UDT for the designated UDTValue.

Method Summary

Modifier and Type	Method and Description
java.io.Serializable	getClosestLocalisation(java.util.Locale locale) Gets the localisation value that is closest to the designated locale.
java.io.Serializable	getLocalisationDirect(java.util.Locale locale) Gets the localisation value for the designated locale directly.
protected java.lang.String	getXsdFileName() Gets the file name of the XSD of this UDT.
java.lang.String	loadFromStream(java.io.InputStream in) Loads and data from the designated InputStream by parsing the corresponding XML.
protected void	marshal(org.w3c.dom.Element parent) Marshals the data of this UDT as XML by adding it to the designated top-level element.
protected void	marshalLocalisation(java.util.Locale locale, java.io.Serializable localised, org.w3c.dom.Element parent) Marshals a localisation element (one entry) to the designated parent element using the designated locale and localised value.
void	setLocalisation(java.util.Locale locale, java.io.Serializable localisation) Sets the designated localisation value for the designated value.
protected void	unmarshalLocalisation(org.w3c.dom.Node locElem) Unmarshals a localisation element (one entry) from the designated node and adds it to the localisation map.

Methods inherited from class de.aristaflow.adept2.extensions.datatypes.AbstractXmlBasedUdt

createDocument, getNamespace, getUdtName, loadFromUdtValue, loadXmlSchema, marshalBoolean, marshalByteArray, marshalDate, marshalDouble, marshalLong, marshalURI, saveToStream, saveToUdtValue, unmarshalBoolean, unmarshalByteArray, unmarshalDate, unmarshalDouble, unmarshalLong, unmarshalURI

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UDT_NAME

public static final java.lang.String UDT_NAME

The UDT name of this data type.

See Also:

Constant Field Values

XML_NAMESPACE

protected static final java.lang.String XML_NAMESPACE

The namespace for the XML-representation of this UDT.

See Also:

Constant Field Values

XSD_FILE_NAME

protected static final java.lang.String XSD_FILE_NAME

The filename for the XSD of this UDT.

See Also:

Constant Field Values

TYPE

protected static final java.lang.String TYPE

The name of the XML-attribute for the inner type that is an ProcessConstants.AdeptDataType.

See Also:

Constant Field Values

ENTRY

protected static final java.lang.String ENTRY

The name of the XML-element for an entry of the localisation map.

See Also:

Constant Field Values

LOCALE_ELEMENT_LANGUAGE

protected static final java.lang.String LOCALE_ELEMENT_LANGUAGE

The name of the XML-element for the language of a locale.

See Also:

Constant Field Values

LOCALE_ELEMENT_COUNTRY

protected static final java.lang.String LOCALE_ELEMENT_COUNTRY

The name of the XML-element for the country of a locale.

See Also:

Constant Field Values

LOCALE_ELEMENT_VARIANT

protected static final java.lang.String LOCALE_ELEMENT_VARIANT

The name of the XML-element for the variant of a locale.

See Also:

Constant Field Values

LOCALE_ELEMENT_LOCALISATION

protected static final java.lang.String LOCALE_ELEMENT_LOCALISATION

The name of the XML-element for the localised value.

See Also:

Constant Field Values

localisationMap

protected final java.util.Map<java.util.Locale,java.io.Serializable> localisationMap

The map containing the localisation values indexed by the corresponding locale.

innerType

protected ProcessConstants.AdeptDataType innerType

The data type of the localised values of this localisation UDT.

Constructor Detail

LocalisationUdt

public LocalisationUdt(ProcessConstants.AdeptDataType innerType)

Creates a new localisation UDT for localisations of values of the designated type.

Parameters:

innerType - The type of the values to be localised.

LocalisationUdt

public LocalisationUdt(java.util.Map<java.util.Locale,java.io.Serializable> localisationMap,
                       ProcessConstants.AdeptDataType innerType)

Creates a new localisation UDT for localisations of values of the designated type. This type has to conform to the type of the values in the provided map.

Parameters:

localisationMap - A map providing default localisation values for this UDT. This may be null.

innerType - The type of the values to be localised.

LocalisationUdt

public LocalisationUdt(UDTValue value)
                throws java.io.IOException,
                       XMLFormatException

Creates a new localisation UDT for the designated UDTValue.

Parameters:

value - The UDTValue from which to retrieve the localisation data.

Throws:

java.io.IOException - If an error occurs while reading the UDTValue, an IOException will be thrown.

XMLFormatException - If the document is not well-formed or does not conform to its schema (if provided), an XMLFormatException will be thrown.

LocalisationUdt

public LocalisationUdt(java.io.InputStream stream)
                throws java.io.IOException,
                       XMLFormatException

Creates a new localisation UDT for the designated InputStream.

Parameters:

stream - The InputStream from which to retrieve the localisation data.

Throws:

java.io.IOException - If an error occurs while reading the InputStream, an IOException will be thrown.

XMLFormatException - If the document is not well-formed or does not conform to its schema (if provided), an XMLFormatException will be thrown.

Method Detail

getXsdFileName

protected java.lang.String getXsdFileName()

Description copied from class: AbstractXmlBasedUdt

Gets the file name of the XSD of this UDT. The file name is usually a static field of the subclass. The file name may contain a relative or even an absolute path relative to this class.

Specified by:

getXsdFileName in class AbstractXmlBasedUdt

Returns:

The file name (including the path) of the XSD of this UDT.

loadFromStream

public java.lang.String loadFromStream(java.io.InputStream in)
                                throws java.io.IOException,
                                       XMLFormatException

Description copied from class: AbstractXmlBasedUdt

Loads and data from the designated InputStream by parsing the corresponding XML.

Specified by:

loadFromStream in class AbstractXmlBasedUdt

Parameters:

in - The value of this UDT as stream (containing the XML representation).

Returns:

The name of the user-defined type if this is stored in the designated stream. If this is not null, the type name will be changed.

Throws:

java.io.IOException - If an error occurs while reading from the stream, an IOException will be thrown. If a class is to be loaded from the stream that cannot be found, a ClassNotFoundException will be wrapped within an IOException.

XMLFormatException - If the document is not well-formed or does not conform to its schema (if provided), an XMLFormatException will be thrown.

getLocalisationDirect

public java.io.Serializable getLocalisationDirect(java.util.Locale locale)

Gets the localisation value for the designated locale directly. That is only the value for the designated locale will be returned, but no localisation value for a weaker locale.

Parameters:

locale - The locale for which to retrieve the localisation value.

Returns:

The localisation value for the designated locale or null in case no value is present for it.

getClosestLocalisation

public java.io.Serializable getClosestLocalisation(java.util.Locale locale)

Gets the localisation value that is closest to the designated locale. This is either the value directly stored for the designated locale or the value for the closest locale if there is no direct value for the designated locale.

Parameters:

locale - The locale for which to retrieve the closest localisation value.

Returns:

The closest localisation value for the designated locale. null will be returned if no value is present for any close locale including the default locale ("").

setLocalisation

public void setLocalisation(java.util.Locale locale,
                            java.io.Serializable localisation)

Sets the designated localisation value for the designated value. Use "" for the default locale.

Parameters:

locale - The locale for which to add a localisation value. Use "" for the default locale.

localisation - The localisation value for the designated locale.

marshal

protected void marshal(org.w3c.dom.Element parent)

Description copied from class: AbstractXmlBasedUdt

Marshals the data of this UDT as XML by adding it to the designated top-level element.

Specified by:

marshal in class AbstractXmlBasedUdt

Parameters:

parent - The top-level element to which to add the XML-representation of this UDT.

marshalLocalisation

protected void marshalLocalisation(java.util.Locale locale,
                                   java.io.Serializable localised,
                                   org.w3c.dom.Element parent)

Marshals a localisation element (one entry) to the designated parent element using the designated locale and localised value.

Parameters:

locale - The locale of the localisation element to marshal.

localised - The localised value of the localisation element to marshal.

parent - The parent element to which to add the localisation element.

unmarshalLocalisation

protected void unmarshalLocalisation(org.w3c.dom.Node locElem)
                              throws java.io.IOException

Unmarshals a localisation element (one entry) from the designated node and adds it to the localisation map.

Parameters:

locElem - The node from which to unmarshal a localisation element (one entry) from its text content.

Throws:

java.io.IOException - If decoding a byte array value of a user-defined type with Base64 fails, an IOException will be thrown.