com.helger.tree.xml.TreeXMLConverter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-tree Show documentation
Show all versions of ph-tree Show documentation
Java 1.8+ Library with tree structures
/**
* Copyright (C) 2014-2018 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.tree.xml;
import java.util.Comparator;
import java.util.function.Function;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import com.helger.commons.annotation.PresentForCodeCoverage;
import com.helger.commons.collection.NonBlockingStack;
import com.helger.commons.hierarchy.ChildrenProviderHasChildrenSorting;
import com.helger.commons.hierarchy.visit.DefaultHierarchyVisitorCallback;
import com.helger.commons.hierarchy.visit.EHierarchyVisitorReturn;
import com.helger.commons.id.IHasID;
import com.helger.tree.IBasicTree;
import com.helger.tree.ITreeItem;
import com.helger.tree.util.TreeVisitor;
import com.helger.tree.withid.BasicTreeWithID;
import com.helger.tree.withid.DefaultTreeWithID;
import com.helger.tree.withid.ITreeItemWithID;
import com.helger.tree.withid.unique.DefaultTreeWithGlobalUniqueID;
import com.helger.xml.microdom.IMicroDocument;
import com.helger.xml.microdom.IMicroElement;
import com.helger.xml.microdom.MicroElement;
import com.helger.xml.microdom.util.ChildrenProviderElementWithName;
import com.helger.xml.microdom.util.MicroVisitor;
/**
* Convert a tree to XML
*
* @author Philip Helger
*/
@Immutable
public final class TreeXMLConverter
{
public static final String ELEMENT_ROOT = "root";
public static final String ELEMENT_ITEM = "item";
public static final String ATTR_ID = "id";
public static final String ELEMENT_DATA = "data";
@PresentForCodeCoverage
private static final TreeXMLConverter s_aInstance = new TreeXMLConverter ();
private TreeXMLConverter ()
{}
/**
* Specialized conversion method for converting a tree with ID to a
* standardized XML tree.
*
* @param
* tree item value type
* @param
* tree item type
* @param aTree
* The tree to be converted
* @param aConverter
* The main data converter that converts the tree item values into XML
* @return The created document.
*/
@Nonnull
public static > IMicroElement getTreeWithStringIDAsXML (@Nonnull final IBasicTree aTree,
@Nonnull final IConverterTreeItemToMicroNode aConverter)
{
return getTreeWithIDAsXML (aTree, IHasID.getComparatorID (), Function.identity (), aConverter);
}
@Nonnull
public static > IMicroElement getTreeWithIDAsXML (@Nonnull final IBasicTree aTree,
@Nonnull final Comparator aItemComparator,
@Nonnull final Function aIDConverter,
@Nonnull final IConverterTreeItemToMicroNode aDataConverter)
{
final IMicroElement eRoot = new MicroElement (ELEMENT_ROOT);
final NonBlockingStack aParents = new NonBlockingStack <> ();
aParents.push (eRoot);
TreeVisitor.visitTree (aTree,
new ChildrenProviderHasChildrenSorting (aItemComparator),
new DefaultHierarchyVisitorCallback ()
{
@Override
@Nonnull
public EHierarchyVisitorReturn onItemBeforeChildren (@Nullable final ITEMTYPE aItem)
{
if (aItem != null)
{
// create item element
final IMicroElement eItem = aParents.peek ().appendElement (ELEMENT_ITEM);
eItem.setAttribute (ATTR_ID, aIDConverter.apply (aItem.getID ()));
// append data
final IMicroElement eData = eItem.appendElement (ELEMENT_DATA);
aDataConverter.appendDataValue (eData, aItem.getData ());
aParents.push (eItem);
}
return EHierarchyVisitorReturn.CONTINUE;
}
@Override
@Nonnull
public EHierarchyVisitorReturn onItemAfterChildren (@Nullable final ITEMTYPE aItem)
{
if (aItem != null)
aParents.pop ();
return EHierarchyVisitorReturn.CONTINUE;
}
});
return eRoot;
}
@Nonnull
public static > IMicroElement getTreeAsXML (@Nonnull final IBasicTree aTree,
@Nonnull final Comparator aItemComparator,
@Nonnull final IConverterTreeItemToMicroNode aDataConverter)
{
final String sNamespaceURI = aDataConverter.getNamespaceURI ();
final IMicroElement eRoot = new MicroElement (sNamespaceURI, ELEMENT_ROOT);
final NonBlockingStack aParents = new NonBlockingStack <> ();
aParents.push (eRoot);
TreeVisitor.visitTree (aTree,
new ChildrenProviderHasChildrenSorting (aItemComparator),
new DefaultHierarchyVisitorCallback ()
{
@Override
@Nonnull
public EHierarchyVisitorReturn onItemBeforeChildren (@Nullable final ITEMTYPE aItem)
{
if (aItem != null)
{
// create item element
final IMicroElement eItem = aParents.peek ().appendElement (sNamespaceURI,
ELEMENT_ITEM);
// append data
final IMicroElement eData = eItem.appendElement (sNamespaceURI, ELEMENT_DATA);
aDataConverter.appendDataValue (eData, aItem.getData ());
aParents.push (eItem);
}
return EHierarchyVisitorReturn.CONTINUE;
}
@Override
@Nonnull
public EHierarchyVisitorReturn onItemAfterChildren (@Nullable final ITEMTYPE aItem)
{
if (aItem != null)
aParents.pop ();
return EHierarchyVisitorReturn.CONTINUE;
}
});
return eRoot;
}
private static > void _getXMLAsTreeWithID (@Nonnull final IMicroElement aElement,
@Nonnull final Function aIDConverter,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter,
@Nonnull final BasicTreeWithID aTree)
{
final String sNamespaceURI = aDataConverter.getNamespaceURI ();
final NonBlockingStack aParents = new NonBlockingStack <> ();
aParents.push (aTree.getRootItem ());
MicroVisitor.visit (aElement,
new ChildrenProviderElementWithName (sNamespaceURI, ELEMENT_ITEM),
new DefaultHierarchyVisitorCallback ()
{
@Override
@Nonnull
public EHierarchyVisitorReturn onItemBeforeChildren (@Nullable final IMicroElement eItem)
{
if (eItem != null)
{
final KEYTYPE aTreeItemID = aIDConverter.apply (eItem.getAttributeValue (ATTR_ID));
final IMicroElement eData = eItem.getFirstChildElement (sNamespaceURI, ELEMENT_DATA);
final DATATYPE aTreeItemValue = aDataConverter.getAsDataValue (eData);
final ITEMTYPE aTreeItem = aParents.peek ().createChildItem (aTreeItemID, aTreeItemValue);
aParents.push (aTreeItem);
}
return EHierarchyVisitorReturn.CONTINUE;
}
@Override
@Nonnull
public EHierarchyVisitorReturn onItemAfterChildren (@Nullable final IMicroElement aItem)
{
if (aItem != null)
aParents.pop ();
return EHierarchyVisitorReturn.CONTINUE;
}
});
}
@Nonnull
public static DefaultTreeWithGlobalUniqueID getXMLAsTreeWithUniqueStringID (@Nonnull final IMicroDocument aDoc,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter)
{
return getXMLAsTreeWithUniqueStringID (aDoc.getDocumentElement (), aDataConverter);
}
@Nonnull
public static DefaultTreeWithGlobalUniqueID getXMLAsTreeWithUniqueStringID (@Nonnull final IMicroElement aElement,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter)
{
return TreeXMLConverter. getXMLAsTreeWithUniqueID (aElement,
Function.identity (),
aDataConverter);
}
@Nonnull
public static DefaultTreeWithGlobalUniqueID getXMLAsTreeWithUniqueID (@Nonnull final IMicroDocument aDoc,
@Nonnull final Function aIDConverter,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter)
{
return getXMLAsTreeWithUniqueID (aDoc.getDocumentElement (), aIDConverter, aDataConverter);
}
@Nonnull
public static DefaultTreeWithGlobalUniqueID getXMLAsTreeWithUniqueID (@Nonnull final IMicroElement aElement,
@Nonnull final Function aIDConverter,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter)
{
final DefaultTreeWithGlobalUniqueID aTree = new DefaultTreeWithGlobalUniqueID <> ();
_getXMLAsTreeWithID (aElement, aIDConverter, aDataConverter, aTree);
return aTree;
}
@Nonnull
public static DefaultTreeWithID getXMLAsTreeWithID (@Nonnull final IMicroDocument aDoc,
@Nonnull final Function aIDConverter,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter)
{
return getXMLAsTreeWithID (aDoc.getDocumentElement (), aIDConverter, aDataConverter);
}
@Nonnull
public static DefaultTreeWithID getXMLAsTreeWithID (@Nonnull final IMicroElement aElement,
@Nonnull final Function aIDConverter,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter)
{
final DefaultTreeWithID aTree = new DefaultTreeWithID <> ();
_getXMLAsTreeWithID (aElement, aIDConverter, aDataConverter, aTree);
return aTree;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy