com.northconcepts.datapipeline.foundations.pipeline.tree

Class Tree

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.pipeline.tree.Tree

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, Serializable

public class Tree
extends Bean

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

SERIALIZED_CLASS_NAME, TYPE

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
Tree()
Tree(boolean optimizeTreeStructure)
Tree(TreeDetectionStrategy detectionStrategy)

Method Summary

Modifier and Type	Method and Description
static String	createFieldName(TreeNode node, Set<String> fieldNames) Builds a normalized field name for the supplied node that is unique within fieldNames (which this method adds it to): wildcard nodes use their name pattern hint or id, collisions gain the parent-name prefix and then a numeric suffix.
Tree	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
Tree	fromXmlElement(Element element)
List<TreeNode>	getAllFields()
List<TreeNode>	getAllNodes()
List<TreeNode>	getAllRecordBreaks()
TreeDetectionStrategy	getDetectionStrategy()
TreeNode	getRootNode()
static Tree	loadJson(File file)
static Tree	loadJson(File file, boolean optimizeTreeStructure)
static Tree	loadJson(File file, TreeDetectionStrategy detectionStrategy)
static Tree	loadJson(Reader reader)
static Tree	loadJson(Reader reader, boolean optimizeTreeStructure)
static Tree	loadJson(Reader reader, TreeDetectionStrategy detectionStrategy)
static Tree	loadXml(File file)
static Tree	loadXml(File file, boolean optimizeTreeStructure)
static Tree	loadXml(File file, TreeDetectionStrategy detectionStrategy)
static Tree	loadXml(Reader reader)
static Tree	loadXml(Reader reader, boolean optimizeTreeStructure)
static Tree	loadXml(Reader reader, TreeDetectionStrategy detectionStrategy)
static String	normalizeFieldName(String name)
Tree	setDetectionStrategy(TreeDetectionStrategy detectionStrategy)
Record	toRecord()
Element	toXmlElement(Document document)
void	visit(boolean headFirst, Consumer<TreeNode> consumer)

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

addExceptionProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties, exception, exception, exception

Constructor Detail

Tree

public Tree(boolean optimizeTreeStructure)

Tree

public Tree()

Tree

public Tree(TreeDetectionStrategy detectionStrategy)

Method Detail

loadXml

public static Tree loadXml(File file)

loadXml

public static Tree loadXml(Reader reader)

loadJson

public static Tree loadJson(File file)

loadJson

public static Tree loadJson(Reader reader)

loadXml

public static Tree loadXml(File file,
                           boolean optimizeTreeStructure)

loadXml

public static Tree loadXml(Reader reader,
                           boolean optimizeTreeStructure)

loadJson

public static Tree loadJson(File file,
                            boolean optimizeTreeStructure)

loadJson

public static Tree loadJson(Reader reader,
                            boolean optimizeTreeStructure)

loadXml

public static Tree loadXml(File file,
                           TreeDetectionStrategy detectionStrategy)

loadXml

public static Tree loadXml(Reader reader,
                           TreeDetectionStrategy detectionStrategy)

loadJson

public static Tree loadJson(File file,
                            TreeDetectionStrategy detectionStrategy)

loadJson

public static Tree loadJson(Reader reader,
                            TreeDetectionStrategy detectionStrategy)

getDetectionStrategy

public TreeDetectionStrategy getDetectionStrategy()

setDetectionStrategy

public Tree setDetectionStrategy(TreeDetectionStrategy detectionStrategy)

getRootNode

public TreeNode getRootNode()

createFieldName

public static String createFieldName(TreeNode node,
                                     Set<String> fieldNames)

Builds a normalized field name for the supplied node that is unique within fieldNames (which this method adds it to): wildcard nodes use their name pattern hint or id, collisions gain the parent-name prefix and then a numeric suffix. Used by the field-naming detection passes.

normalizeFieldName

public static String normalizeFieldName(String name)

getAllFields

public List<TreeNode> getAllFields()

getAllRecordBreaks

public List<TreeNode> getAllRecordBreaks()

getAllNodes

public List<TreeNode> getAllNodes()

visit

public void visit(boolean headFirst,
                  Consumer<TreeNode> consumer)

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord

public Tree fromRecord(Record source)

Description copied from interface: RecordSerializable

Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

Specified by:

fromRecord in interface RecordSerializable

Overrides:

fromRecord in class Bean

Returns:

this instance.

toXmlElement

public Element toXmlElement(Document document)

fromXmlElement

public Tree fromXmlElement(Element element)