com.helger.tree.xml

Class TreeXMLConverter

java.lang.Object

com.helger.tree.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

Modifier and Type	Method and Description
static <DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>> void	fillTreeAsXML(IBasicTree<DATATYPE,ITEMTYPE> aTree, Comparator<? super ITEMTYPE> aItemComparator, IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter, com.helger.xml.microdom.IMicroElement aElement)
static <KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>> void	fillTreeWithIDAsXML(IBasicTree<DATATYPE,ITEMTYPE> aTree, Comparator<? super ITEMTYPE> aItemComparator, Function<? super KEYTYPE,? extends String> aIDConverter, IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter, com.helger.xml.microdom.IMicroElement aElement)
static <KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>> void	fillXMLAsTreeWithID(com.helger.xml.microdom.IMicroElement aElement, Function<? super String,? extends KEYTYPE> aIDConverter, IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter, BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE> aTree)
static <DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>> com.helger.xml.microdom.IMicroElement	getTreeAsXML(IBasicTree<DATATYPE,ITEMTYPE> aTree, Comparator<? super ITEMTYPE> aItemComparator, IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter)
static <KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>> com.helger.xml.microdom.IMicroElement	getTreeWithIDAsXML(IBasicTree<DATATYPE,ITEMTYPE> aTree, Comparator<? super ITEMTYPE> aItemComparator, Function<? super KEYTYPE,? extends String> aIDConverter, IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter)
static <DATATYPE,ITEMTYPE extends ITreeItemWithID<String,DATATYPE,ITEMTYPE>> com.helger.xml.microdom.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(com.helger.xml.microdom.IMicroElement aElement, Function<? super String,? extends KEYTYPE> aIDConverter, IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)
static <KEYTYPE,DATATYPE> DefaultTreeWithGlobalUniqueID<KEYTYPE,DATATYPE>	getXMLAsTreeWithUniqueID(com.helger.xml.microdom.IMicroElement aElement, Function<? super String,? extends KEYTYPE> aIDConverter, IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)
static <DATATYPE> DefaultTreeWithGlobalUniqueID<String,DATATYPE>	getXMLAsTreeWithUniqueStringID(com.helger.xml.microdom.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>> com.helger.xml.microdom.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.

fillTreeWithIDAsXML

public static <KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>> void fillTreeWithIDAsXML(@Nonnull
                                                                                                                      IBasicTree<DATATYPE,ITEMTYPE> aTree,
                                                                                                                      @Nonnull
                                                                                                                      Comparator<? super ITEMTYPE> aItemComparator,
                                                                                                                      @Nonnull
                                                                                                                      Function<? super KEYTYPE,? extends String> aIDConverter,
                                                                                                                      @Nonnull
                                                                                                                      IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter,
                                                                                                                      @Nonnull
                                                                                                                      com.helger.xml.microdom.IMicroElement aElement)

getTreeWithIDAsXML

@Nonnull
public static <KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>> com.helger.xml.microdom.IMicroElement getTreeWithIDAsXML(@Nonnull
                                                                                                                                                                IBasicTree<DATATYPE,ITEMTYPE> aTree,
                                                                                                                                                                @Nonnull
                                                                                                                                                                Comparator<? super ITEMTYPE> aItemComparator,
                                                                                                                                                                @Nonnull
                                                                                                                                                                Function<? super KEYTYPE,? extends String> aIDConverter,
                                                                                                                                                                @Nonnull
                                                                                                                                                                IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter)

fillTreeAsXML

public static <DATATYPE,ITEMTYPE extends ITreeItem<DATATYPE,ITEMTYPE>> void fillTreeAsXML(@Nonnull
                                                                                          IBasicTree<DATATYPE,ITEMTYPE> aTree,
                                                                                          @Nonnull
                                                                                          Comparator<? super ITEMTYPE> aItemComparator,
                                                                                          @Nonnull
                                                                                          IConverterTreeItemToMicroNode<? super DATATYPE> aDataConverter,
                                                                                          @Nonnull
                                                                                          com.helger.xml.microdom.IMicroElement aElement)

getTreeAsXML

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

fillXMLAsTreeWithID

public static <KEYTYPE,DATATYPE,ITEMTYPE extends ITreeItemWithID<KEYTYPE,DATATYPE,ITEMTYPE>> void fillXMLAsTreeWithID(@Nonnull
                                                                                                                      com.helger.xml.microdom.IMicroElement aElement,
                                                                                                                      @Nonnull
                                                                                                                      Function<? super String,? extends KEYTYPE> aIDConverter,
                                                                                                                      @Nonnull
                                                                                                                      IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter,
                                                                                                                      @Nonnull
                                                                                                                      BasicTreeWithID<KEYTYPE,DATATYPE,ITEMTYPE> aTree)

getXMLAsTreeWithUniqueStringID

@Nonnull
public static <DATATYPE> DefaultTreeWithGlobalUniqueID<String,DATATYPE> getXMLAsTreeWithUniqueStringID(@Nonnull
                                                                                                                 com.helger.xml.microdom.IMicroElement aElement,
                                                                                                                 @Nonnull
                                                                                                                 IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)

getXMLAsTreeWithUniqueID

@Nonnull
public static <KEYTYPE,DATATYPE> DefaultTreeWithGlobalUniqueID<KEYTYPE,DATATYPE> getXMLAsTreeWithUniqueID(@Nonnull
                                                                                                                    com.helger.xml.microdom.IMicroElement aElement,
                                                                                                                    @Nonnull
                                                                                                                    Function<? super String,? extends KEYTYPE> aIDConverter,
                                                                                                                    @Nonnull
                                                                                                                    IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)

getXMLAsTreeWithID

@Nonnull
public static <KEYTYPE,DATATYPE> DefaultTreeWithID<KEYTYPE,DATATYPE> getXMLAsTreeWithID(@Nonnull
                                                                                                  com.helger.xml.microdom.IMicroElement aElement,
                                                                                                  @Nonnull
                                                                                                  Function<? super String,? extends KEYTYPE> aIDConverter,
                                                                                                  @Nonnull
                                                                                                  IConverterMicroNodeToTreeItem<? extends DATATYPE> aDataConverter)