org.faktorips.runtime.internal

Enum ValueToXmlHelper

java.lang.Object

java.lang.Enum<ValueToXmlHelper>

org.faktorips.runtime.internal.ValueToXmlHelper

All Implemented Interfaces:

Serializable, Comparable<ValueToXmlHelper>

public enum ValueToXmlHelper
extends Enum<ValueToXmlHelper>

Helper class to write values to XML and retrieve them from XML.

Author:

Jan Ortmann

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIGURED_DEFAULT_PREFIX
static String	CONFIGURED_VALUE_SET_PREFIX
static String	LEGACY_XML_TAG_CONFIG_ELEMENT Since 3.19 the ConfigElement was separated in ConfiguredDefault and ConfiguredValueSet.
static String	XML_ATTRIBUTE_ATTRIBUTE
static String	XML_ATTRIBUTE_CONTAINS_NULL
static String	XML_ATTRIBUTE_IS_NULL
static String	XML_ATTRIBUTE_STRUCTURE_USAGE
static String	XML_TAG_ALL_VALUES
static String	XML_TAG_ATTRIBUTE_VALUE
static String	XML_TAG_CONFIGURED_DEFAULT
static String	XML_TAG_CONFIGURED_VALUE_SET
static String	XML_TAG_DATA
static String	XML_TAG_ENUM
static String	XML_TAG_LOWER_BOUND
static String	XML_TAG_RANGE
static String	XML_TAG_STEP
static String	XML_TAG_TABLE_CONTENT_NAME
static String	XML_TAG_TABLE_CONTENT_USAGE
static String	XML_TAG_UPPER_BOUND
static String	XML_TAG_VALUE Used for both the value of a config element and the values of an enum value set.
static String	XML_TAG_VALUE_SET

Method Summary

Modifier and Type	Method and Description
static void	addCDataValueToElement(String value, Element el, String tagName) Adds the value to the given xml element.
static void	addInternationalStringToElement(org.faktorips.values.DefaultInternationalString value, Element el, String tagName) Adds the DefaultInternationalString to the given xml element.
static void	addTableUsageToElement(Element el, String structureUsage, String tableContentName) Adds a table usage to the XML element.
static Element	addValueAndReturnElement(String value, Element el, String tagName) Adds the value to the given xml element as does addValueToElement(String, Element, String).
static void	addValueToElement(String value, Element el, String tagName) Adds the value to the given xml element.
static Element	createValueElement(String value, String tagName, Document ownerDocument, boolean useCDataSection)
static EnumValues	getEnumValueSetFromElement(Element el, String tagName)
static org.faktorips.values.DefaultInternationalString	getInternationalStringFromElement(Element el) Returns the DefaultInternationalString stored in the given element.
static org.faktorips.values.DefaultInternationalString	getInternationalStringFromElement(Element el, String tagName) Returns the DefaultInternationalString stored in the child element of the given element with the indicated name.
static Range	getRangeFromElement(Element el, String tagName)
static <T> org.faktorips.valueset.UnrestrictedValueSet<T>	getUnrestrictedValueSet(Element el, String tagName)
static String	getValueFromElement(Element valueEl) Returns the string representation of the value stored in given value element.
static String	getValueFromElement(Element el, String tagName) Returns the string representation of the value stored in the child element of the given element with the indicated name.
static void	setValue(String value, Element valueEl)
static ValueToXmlHelper	valueOf(String name) Returns the enum constant of this type with the specified name.
static ValueToXmlHelper[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

XML_TAG_VALUE

public static final String XML_TAG_VALUE

Used for both the value of a config element and the values of an enum value set.

See Also:

Constant Field Values

XML_TAG_VALUE_SET

public static final String XML_TAG_VALUE_SET

See Also:

Constant Field Values

XML_TAG_DATA

public static final String XML_TAG_DATA

See Also:

Constant Field Values

LEGACY_XML_TAG_CONFIG_ELEMENT

public static final String LEGACY_XML_TAG_CONFIG_ELEMENT

Since 3.19 the ConfigElement was separated in ConfiguredDefault and ConfiguredValueSet. We need this for reading legacy XML.

See Also:

Constant Field Values

CONFIGURED_DEFAULT_PREFIX

public static final String CONFIGURED_DEFAULT_PREFIX

See Also:

Constant Field Values

CONFIGURED_VALUE_SET_PREFIX

public static final String CONFIGURED_VALUE_SET_PREFIX

See Also:

Constant Field Values

XML_TAG_CONFIGURED_DEFAULT

public static final String XML_TAG_CONFIGURED_DEFAULT

See Also:

Constant Field Values

XML_TAG_CONFIGURED_VALUE_SET

public static final String XML_TAG_CONFIGURED_VALUE_SET

See Also:

Constant Field Values

XML_TAG_ATTRIBUTE_VALUE

public static final String XML_TAG_ATTRIBUTE_VALUE

See Also:

Constant Field Values

XML_ATTRIBUTE_ATTRIBUTE

public static final String XML_ATTRIBUTE_ATTRIBUTE

See Also:

Constant Field Values

XML_TAG_ALL_VALUES

public static final String XML_TAG_ALL_VALUES

See Also:

Constant Field Values

XML_TAG_ENUM

public static final String XML_TAG_ENUM

See Also:

Constant Field Values

XML_TAG_RANGE

public static final String XML_TAG_RANGE

See Also:

Constant Field Values

XML_TAG_STEP

public static final String XML_TAG_STEP

See Also:

Constant Field Values

XML_TAG_UPPER_BOUND

public static final String XML_TAG_UPPER_BOUND

See Also:

Constant Field Values

XML_TAG_LOWER_BOUND

public static final String XML_TAG_LOWER_BOUND

See Also:

Constant Field Values

XML_TAG_TABLE_CONTENT_NAME

public static final String XML_TAG_TABLE_CONTENT_NAME

See Also:

Constant Field Values

XML_TAG_TABLE_CONTENT_USAGE

public static final String XML_TAG_TABLE_CONTENT_USAGE

See Also:

Constant Field Values

XML_ATTRIBUTE_STRUCTURE_USAGE

public static final String XML_ATTRIBUTE_STRUCTURE_USAGE

See Also:

Constant Field Values

XML_ATTRIBUTE_IS_NULL

public static final String XML_ATTRIBUTE_IS_NULL

See Also:

Constant Field Values

XML_ATTRIBUTE_CONTAINS_NULL

public static final String XML_ATTRIBUTE_CONTAINS_NULL

See Also:

Constant Field Values

Method Detail

values

public static ValueToXmlHelper[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ValueToXmlHelper c : ValueToXmlHelper.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ValueToXmlHelper valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

addValueToElement

public static void addValueToElement(String value,
                                     Element el,
                                     String tagName)

Adds the value to the given xml element. Takes care of proper null handling. By value we mean a value of a datatype, e.g. 42EUR is a value of the datatype money.

Parameters:

value - the string representation of the value

el - the xml element.

tagName - the tag name for the element that stored the value

addInternationalStringToElement

public static void addInternationalStringToElement(org.faktorips.values.DefaultInternationalString value,
                                                   Element el,
                                                   String tagName)

Adds the DefaultInternationalString to the given xml element. Takes care of proper null handling.

Parameters:

value - the DefaultInternationalString to be added.

el - the xml element.

tagName - the tag name for the element that stored the value.

addCDataValueToElement

public static void addCDataValueToElement(String value,
                                          Element el,
                                          String tagName)

Adds the value to the given xml element. The value is inserted inside a CDATA section.

Parameters:

value - the string representation of the value

el - the xml element.

tagName - the tag name for the element that stored the value

createValueElement

public static Element createValueElement(String value,
                                         String tagName,
                                         Document ownerDocument,
                                         boolean useCDataSection)

setValue

public static void setValue(String value,
                            Element valueEl)

addValueAndReturnElement

public static Element addValueAndReturnElement(String value,
                                               Element el,
                                               String tagName)

Adds the value to the given xml element as does addValueToElement(String, Element, String). The created element then is returned.

Parameters:

value - the string representation of the value

el - the XML element to add the value to.

tagName - the tag name for the element that stored the value

Returns:

the created element with the given tag name, that contains the given value.

addTableUsageToElement

public static void addTableUsageToElement(Element el,
                                          String structureUsage,
                                          String tableContentName)

Adds a table usage to the XML element.

Parameters:

el - the XML element to add the value to.

structureUsage - the value for the structureUsage XML attribute

tableContentName - the name of the used table content

getValueFromElement

public static String getValueFromElement(Element el,
                                         String tagName)

Returns the string representation of the value stored in the child element of the given element with the indicated name. Returns null if the value is null or no such child element exists.

     <Parent>
         <Property isNull="false">42</Property>
     </Parent>
 

Parameters:

el - The xml element that is the parent of the element storing the value.

tagName - The name of the child

getInternationalStringFromElement

public static org.faktorips.values.DefaultInternationalString getInternationalStringFromElement(Element el,
                                                                                                String tagName)

Returns the DefaultInternationalString stored in the child element of the given element with the indicated name. Returns an empty DefaultInternationalString if the value is null or no such child element exists.

Parameters:

el - The xml element that is the parent of the element storing the international string.

tagName - The name of the child

getValueFromElement

public static String getValueFromElement(Element valueEl)

Returns the string representation of the value stored in given value element. Returns null if the value is null, the attribute isNull is true or no such child element exists.

         <Property isNull="false">42</Property>
 

Parameters:

valueEl - The xml value element containing the value.

getInternationalStringFromElement

public static org.faktorips.values.DefaultInternationalString getInternationalStringFromElement(Element el)

Returns the DefaultInternationalString stored in the given element. Returns an empty DefaultInternationalString if the value is null.

Parameters:

el - The xml element storing the international string.

getRangeFromElement

public static Range getRangeFromElement(Element el,
                                        String tagName)

getEnumValueSetFromElement

public static EnumValues getEnumValueSetFromElement(Element el,
                                                    String tagName)

getUnrestrictedValueSet

public static <T> org.faktorips.valueset.UnrestrictedValueSet<T> getUnrestrictedValueSet(Element el,
                                                                                         String tagName)