com.phloc.commons.tree.utils.xml

Class TreeXMLConverter

java.lang.Object

com.phloc.commons.tree.utils.xml.TreeXMLConverter

@Immutable
public final class TreeXMLConverter
extends Object

Convert a tree to XML

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_ID
static String	ELEMENT_DATA
static String	ELEMENT_ITEM
static String	ELEMENT_ROOT

Method Summary

Methods

Modifier and Type	Method and Description
static <DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>> IMicroElement	getTreeAsXML(IBasicTree<DATATYPE,ITEMTYPE> aTree, Comparator<? super ITEMTYPE> aItemComparator, IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter)
static <KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>> IMicroElement	getTreeWithIDAsXML(IBasicTree<DATATYPE,ITEMTYPE> aTree, Comparator<? super ITEMTYPE> aItemComparator, IUnidirectionalConverter<KEYTYPE,String> aIDConverter, IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter)
static <DATATYPE,ITEMTYPE extends ITreeItemWithID<String,DATATYPE,ITEMTYPE>> IMicroElement	getTreeWithStringIDAsXML(IBasicTree<DATATYPE,ITEMTYPE> aTree, IConverterTreeItemToMicroNode<? super DATATYPE> aConverter) Specialized conversion method for converting a tree with ID to a standardized XML tree.
static <KEYTYPE,DATATYPE> DefaultTreeWithID<KEYTYPE,DATATYPE>	getXMLAsTreeWithID(IMicroDocument aDoc, IUnidirectionalConverter<String,KEYTYPE> aIDConverter, IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)
static <KEYTYPE,DATATYPE> DefaultTreeWithID<KEYTYPE,DATATYPE>	getXMLAsTreeWithID(IMicroElement aElement, IUnidirectionalConverter<String,KEYTYPE> aIDConverter, IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)
static <KEYTYPE,DATATYPE> DefaultTreeWithGlobalUniqueID<KEYTYPE,DATATYPE>	getXMLAsTreeWithUniqueID(IMicroDocument aDoc, IUnidirectionalConverter<String,KEYTYPE> aIDConverter, IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)
static <KEYTYPE,DATATYPE> DefaultTreeWithGlobalUniqueID<KEYTYPE,DATATYPE>	getXMLAsTreeWithUniqueID(IMicroElement aElement, IUnidirectionalConverter<String,KEYTYPE> aIDConverter, IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)
static <DATATYPE> DefaultTreeWithGlobalUniqueID<String,DATATYPE>	getXMLAsTreeWithUniqueStringID(IMicroDocument aDoc, IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)
static <DATATYPE> DefaultTreeWithGlobalUniqueID<String,DATATYPE>	getXMLAsTreeWithUniqueStringID(IMicroElement aElement, IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_ROOT

public static final String ELEMENT_ROOT

See Also:

Constant Field Values

ELEMENT_ITEM

public static final String ELEMENT_ITEM

See Also:

Constant Field Values

ATTR_ID

public static final String ATTR_ID

See Also:

Constant Field Values

ELEMENT_DATA

public static final String ELEMENT_DATA

See Also:

Constant Field Values

Method Detail

getTreeWithStringIDAsXML

@Nonnull
public static <DATATYPE,ITEMTYPE extends ITreeItemWithID<String,DATATYPE,ITEMTYPE>> IMicroElement getTreeWithStringIDAsXML(@Nonnull
                                                                                                                   IBasicTree<DATATYPE,ITEMTYPE> aTree,
                                                                                                                   @Nonnull
                                                                                                                   IConverterTreeItemToMicroNode<? super DATATYPE> aConverter)

Specialized conversion method for converting a tree with ID to a standardized XML tree.

Type Parameters:

DATATYPE - tree item value type

ITEMTYPE - tree item type

Parameters:

aTree - The tree to be converted

aConverter - The main data converter that converts the tree item values into XML

Returns:

The created document.

getTreeWithIDAsXML

@Nonnull
public static <KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>> IMicroElement getTreeWithIDAsXML(@Nonnull
                                                                                                                      IBasicTree<DATATYPE,ITEMTYPE> aTree,
                                                                                                                      @Nonnull
                                                                                                                      Comparator<? super ITEMTYPE> aItemComparator,
                                                                                                                      @Nonnull
                                                                                                                      IUnidirectionalConverter<KEYTYPE,String> aIDConverter,
                                                                                                                      @Nonnull
                                                                                                                      IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter)

getTreeAsXML

@Nonnull
public static <DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>> IMicroElement getTreeAsXML(@Nonnull
                                                                                          IBasicTree<DATATYPE,ITEMTYPE> aTree,
                                                                                          @Nonnull
                                                                                          Comparator<? super ITEMTYPE> aItemComparator,
                                                                                          @Nonnull
                                                                                          IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter)

getXMLAsTreeWithUniqueStringID

@Nonnull
public static <DATATYPE> DefaultTreeWithGlobalUniqueID<String,DATATYPE> getXMLAsTreeWithUniqueStringID(@Nonnull
                                                                                               IMicroDocument aDoc,
                                                                                               @Nonnull
                                                                                               IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)

getXMLAsTreeWithUniqueStringID

@Nonnull
public static <DATATYPE> DefaultTreeWithGlobalUniqueID<String,DATATYPE> getXMLAsTreeWithUniqueStringID(@Nonnull
                                                                                               IMicroElement aElement,
                                                                                               @Nonnull
                                                                                               IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)

getXMLAsTreeWithUniqueID

@Nonnull
public static <KEYTYPE,DATATYPE> DefaultTreeWithGlobalUniqueID<KEYTYPE,DATATYPE> getXMLAsTreeWithUniqueID(@Nonnull
                                                                                                  IMicroDocument aDoc,
                                                                                                  @Nonnull
                                                                                                  IUnidirectionalConverter<String,KEYTYPE> aIDConverter,
                                                                                                  @Nonnull
                                                                                                  IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)

getXMLAsTreeWithUniqueID

@Nonnull
public static <KEYTYPE,DATATYPE> DefaultTreeWithGlobalUniqueID<KEYTYPE,DATATYPE> getXMLAsTreeWithUniqueID(@Nonnull
                                                                                                  IMicroElement aElement,
                                                                                                  @Nonnull
                                                                                                  IUnidirectionalConverter<String,KEYTYPE> aIDConverter,
                                                                                                  @Nonnull
                                                                                                  IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)

getXMLAsTreeWithID

@Nonnull
public static <KEYTYPE,DATATYPE> DefaultTreeWithID<KEYTYPE,DATATYPE> getXMLAsTreeWithID(@Nonnull
                                                                                IMicroDocument aDoc,
                                                                                @Nonnull
                                                                                IUnidirectionalConverter<String,KEYTYPE> aIDConverter,
                                                                                @Nonnull
                                                                                IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)

getXMLAsTreeWithID

@Nonnull
public static <KEYTYPE,DATATYPE> DefaultTreeWithID<KEYTYPE,DATATYPE> getXMLAsTreeWithID(@Nonnull
                                                                                IMicroElement aElement,
                                                                                @Nonnull
                                                                                IUnidirectionalConverter<String,KEYTYPE> aIDConverter,
                                                                                @Nonnull
                                                                                IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)