com.tridion.broker.meta.custom

Class DOMToCustomMetaConvertor

java.lang.Object

com.tridion.broker.meta.custom.DOMToCustomMetaConvertor

public class DOMToCustomMetaConvertor
extends Object

This class converts W3C Documents or Elements into CustomMeta instances.

Constructor Summary

Constructors

Constructor and Description
DOMToCustomMetaConvertor()

Method Summary

Modifier and Type	Method and Description
static void	addTypeInfo(Element element, Map<String,String> typeMap) Takes an XML representation of custom meta-data, and adds new attributes that represent the type of each custom meta-data value to the XML data based on the type-map.
static Map<String,com.tridion.meta.NameValuePair>	aggregateNameValuePairs(List<com.tridion.meta.NameValuePair> nameValuePairsList) Aggregates multiple name value pairs by the key name.
static com.tridion.meta.CustomMeta	getCustomMeta(Document document, Map typeMap) Transforms a document and it's children to a tree of CustomMeta objects.
static com.tridion.meta.CustomMeta	getCustomMeta(Element element, Map<String,String> typeMap) Transforms an element and it's children to a tree of CustomMeta objects.
static Document	getStrippedCustomMeta(Node metadataNode, boolean namespaceAware)
static MetadataType	getType(Map<String,String> typeMap, Element childElement) Determines the type of an element.

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMToCustomMetaConvertor

public DOMToCustomMetaConvertor()

Method Detail

getCustomMeta

public static com.tridion.meta.CustomMeta getCustomMeta(Document document,
                                                        Map typeMap)

Transforms a document and it's children to a tree of CustomMeta objects.

Parameters:

document - The element to be converted into a CustomMeta object.

typeMap - The typemap to be used for lookup up the types of elements.

Returns:

A CustomMeta instance for the specified element.

getCustomMeta

public static com.tridion.meta.CustomMeta getCustomMeta(Element element,
                                                        Map<String,String> typeMap)

Transforms an element and it's children to a tree of CustomMeta objects.

Parameters:

element - The element to be converted into a CustomMeta object.

typeMap - The typemap to be used for lookup up the types of elements.

Returns:

A CustomMeta instance for the specified element.

aggregateNameValuePairs

public static Map<String,com.tridion.meta.NameValuePair> aggregateNameValuePairs(List<com.tridion.meta.NameValuePair> nameValuePairsList)

Aggregates multiple name value pairs by the key name. As a result distinct by the key name set of name value pairs is created and all multiple values are stored in a list within specific name value pair object.

Parameters:

nameValuePairsList - List of name value pairs to be aggregated.

Returns:

Map Map containing key name as a key and aggregated name value pairs.

getType

public static MetadataType getType(Map<String,String> typeMap,
                                   Element childElement)

Determines the type of an element. If the type is not specified in the element, the typeMap is used to determine the type of the element.

Parameters:

childElement - The element for which the type should be determined.

typeMap - The typemap to be used for lookup up the type of an element.

Returns:

A constant indicating the NameValuePair type

See Also:

NameValuePair

addTypeInfo

public static void addTypeInfo(Element element,
                               Map<String,String> typeMap)

Takes an XML representation of custom meta-data, and adds new attributes that represent the type of each custom meta-data value to the XML data based on the type-map.

Parameters:

element - An element representing custom-meta type.

typeMap - Mapping of (String) custom-meta-name -> (String) typename

getStrippedCustomMeta

public static Document getStrippedCustomMeta(Node metadataNode,
                                             boolean namespaceAware)