Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**
* Copyright (C) 2006-2015 phloc systems
* http://www.phloc.com
* office[at]phloc[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.phloc.commons.tree.utils.xml;
import java.util.Comparator;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import com.phloc.commons.annotations.PresentForCodeCoverage;
import com.phloc.commons.collections.NonBlockingStack;
import com.phloc.commons.convert.IUnidirectionalConverter;
import com.phloc.commons.convert.UnidirectionalConverterIdentity;
import com.phloc.commons.hierarchy.DefaultHierarchyWalkerCallback;
import com.phloc.commons.id.ComparatorHasIDString;
import com.phloc.commons.microdom.IMicroDocument;
import com.phloc.commons.microdom.IMicroElement;
import com.phloc.commons.microdom.impl.MicroElement;
import com.phloc.commons.microdom.utils.ChildrenProviderElementWithName;
import com.phloc.commons.microdom.utils.MicroWalker;
import com.phloc.commons.parent.impl.ChildrenProviderHasChildrenSorting;
import com.phloc.commons.tree.IBasicTree;
import com.phloc.commons.tree.simple.ITreeItem;
import com.phloc.commons.tree.utils.walk.TreeWalker;
import com.phloc.commons.tree.withid.BasicTreeWithID;
import com.phloc.commons.tree.withid.DefaultTreeWithID;
import com.phloc.commons.tree.withid.ITreeItemWithID;
import com.phloc.commons.tree.withid.unique.DefaultTreeWithGlobalUniqueID;
/**
* 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
@SuppressWarnings ("unused")
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,
new ComparatorHasIDString (),
UnidirectionalConverterIdentity. create (),
aConverter);
}
@Nonnull
public static > IMicroElement getTreeWithIDAsXML (@Nonnull final IBasicTree aTree,
@Nonnull final Comparator aItemComparator,
@Nonnull final IUnidirectionalConverter aIDConverter,
@Nonnull final IConverterTreeItemToMicroNode aDataConverter)
{
final IMicroElement eRoot = new MicroElement (ELEMENT_ROOT);
final NonBlockingStack aParents = new NonBlockingStack ();
aParents.push (eRoot);
TreeWalker.walkTree (aTree,
new ChildrenProviderHasChildrenSorting (aItemComparator),
new DefaultHierarchyWalkerCallback ()
{
@Override
public void onItemBeforeChildren (@Nullable final ITEMTYPE aItem)
{
if (aItem != null)
{
// create item element
final IMicroElement eItem = aParents.peek ().appendElement (ELEMENT_ITEM);
eItem.setAttribute (ATTR_ID, aIDConverter.convert (aItem.getID ()));
// append data
final IMicroElement eData = eItem.appendElement (ELEMENT_DATA);
aDataConverter.appendDataValue (eData, aItem.getData ());
aParents.push (eItem);
}
}
@Override
public void onItemAfterChildren (@Nullable final ITEMTYPE aItem)
{
if (aItem != null)
aParents.pop ();
}
});
return eRoot;
}
@Nonnull
public static > IMicroElement getTreeAsXML (@Nonnull final IBasicTree aTree,
@Nonnull final Comparator aItemComparator,
@Nonnull final IConverterTreeItemToMicroNode aDataConverter)
{
final IMicroElement eRoot = new MicroElement (ELEMENT_ROOT);
final NonBlockingStack aParents = new NonBlockingStack ();
aParents.push (eRoot);
TreeWalker.walkTree (aTree,
new ChildrenProviderHasChildrenSorting (aItemComparator),
new DefaultHierarchyWalkerCallback ()
{
@Override
public void onItemBeforeChildren (@Nullable final ITEMTYPE aItem)
{
if (aItem != null)
{
// create item element
final IMicroElement eItem = aParents.peek ().appendElement (ELEMENT_ITEM);
// append data
final IMicroElement eData = eItem.appendElement (ELEMENT_DATA);
aDataConverter.appendDataValue (eData, aItem.getData ());
aParents.push (eItem);
}
}
@Override
public void onItemAfterChildren (@Nullable final ITEMTYPE aItem)
{
if (aItem != null)
aParents.pop ();
}
});
return eRoot;
}
private static > void _getXMLAsTreeWithID (@Nonnull final IMicroElement aElement,
@Nonnull final IUnidirectionalConverter aIDConverter,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter,
@Nonnull final BasicTreeWithID aTree)
{
final NonBlockingStack aParents = new NonBlockingStack ();
aParents.push (aTree.getRootItem ());
MicroWalker.walkNode (aElement,
new ChildrenProviderElementWithName (ELEMENT_ITEM),
new DefaultHierarchyWalkerCallback ()
{
@Override
public void onItemBeforeChildren (@Nullable final IMicroElement eItem)
{
if (eItem != null)
{
final KEYTYPE aTreeItemID = aIDConverter.convert (eItem.getAttribute (ATTR_ID));
final IMicroElement eData = eItem.getFirstChildElement (ELEMENT_DATA);
final DATATYPE aTreeItemValue = aDataConverter.getAsDataValue (eData);
final ITEMTYPE aTreeItem = aParents.peek ().createChildItem (aTreeItemID,
aTreeItemValue);
aParents.push (aTreeItem);
}
}
@Override
public void onItemAfterChildren (@Nullable final IMicroElement aItem)
{
if (aItem != null)
aParents.pop ();
}
});
}
@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,
UnidirectionalConverterIdentity. create (),
aDataConverter);
}
@Nonnull
public static DefaultTreeWithGlobalUniqueID getXMLAsTreeWithUniqueID (@Nonnull final IMicroDocument aDoc,
@Nonnull final IUnidirectionalConverter aIDConverter,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter)
{
return getXMLAsTreeWithUniqueID (aDoc.getDocumentElement (), aIDConverter, aDataConverter);
}
@Nonnull
public static DefaultTreeWithGlobalUniqueID getXMLAsTreeWithUniqueID (@Nonnull final IMicroElement aElement,
@Nonnull final IUnidirectionalConverter 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 IUnidirectionalConverter aIDConverter,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter)
{
return getXMLAsTreeWithID (aDoc.getDocumentElement (), aIDConverter, aDataConverter);
}
@Nonnull
public static DefaultTreeWithID getXMLAsTreeWithID (@Nonnull final IMicroElement aElement,
@Nonnull final IUnidirectionalConverter aIDConverter,
@Nonnull final IConverterMicroNodeToTreeItem aDataConverter)
{
final DefaultTreeWithID aTree = new DefaultTreeWithID ();
_getXMLAsTreeWithID (aElement, aIDConverter, aDataConverter, aTree);
return aTree;
}
}
