Package cdc.util.data.util

Class DataUtil

java.lang.Object

cdc.util.data.util.DataUtil

public final class DataUtil
extends java.lang.Object

Utilities for modification of data trees.

Author:

Damien Carbonne

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Comparator<Node>	ELEMENT_NAME_AND_ATTRIBUTES_COMPARATOR
static java.util.Comparator<Node>	ELEMENT_NAME_COMPARATOR
static cdc.util.function.Evaluator<Node>	RECURSE

Method Summary

Modifier and Type	Method	Description
static boolean	hasAllDescendantsMatching(Node node, java.util.function.Predicate<Node> predicate, boolean strict)
static boolean	hasAncestorMatching(Node node, java.util.function.Predicate<Node> predicate)
static boolean	hasDescendantMatching(Node node, java.util.function.Predicate<Node> predicate, boolean strict)
static void	moveAttributeFirst(Parent parent, java.util.function.Predicate<? super Element> predicate, java.lang.String name, cdc.util.function.Evaluator<? super Parent> evaluator)	Moves the attribute that has a given name to first position, if it exists.
static void	removeComments(Parent parent, cdc.util.function.Evaluator<? super Parent> evaluator)	Removes comments nodes.
static void	removeEmptyAttributes(Parent parent, cdc.util.function.Evaluator<? super Parent> evaluator)	Recursively removes empty attributes.
static void	removeEmptyElements(Parent parent, cdc.util.function.Evaluator<? super Parent> evaluator)	Removes empty elements.
static void	removeIgnorableText(Parent parent, cdc.util.function.Evaluator<? super Parent> evaluator)	Removes text that can be ignored.
static void	removeMatchingAttributes(Parent parent, AttributePredicate predicate, cdc.util.function.Evaluator<? super Parent> evaluator)	Removes matching attributes.
static void	removeMatchingChildren(Parent parent, java.util.function.Predicate<? super Child> predicate, cdc.util.function.Evaluator<? super Parent> evaluator)	Removes matching children.
static void	scrambleContentOfMatchingTexts(Parent parent, TextPredicate predicate, cdc.util.function.Evaluator<? super Parent> evaluator, boolean preserveSpaces)	Scrambles the content of matching texts.
static void	scrambleValuesOfMatchingAttributes(Parent parent, AttributePredicate predicate, cdc.util.function.Evaluator<? super Parent> evaluator, boolean preserveSpaces)	Scrambles values of matching attributes.
static void	setContentOfMatchingTexts(Parent parent, TextPredicate predicate, TextContentConverter converter, cdc.util.function.Evaluator<? super Parent> evaluator)	Sets the content of matching texts.
static void	setContentOfMatchingTexts(Parent parent, TextPredicate predicate, java.util.function.Function<java.lang.String,java.lang.String> contentConverter, cdc.util.function.Evaluator<? super Parent> evaluator)	Sets the content of matching texts.
static void	setNameOfMatchingAttributes(Parent parent, AttributePredicate predicate, AttributeNameConverter converter, cdc.util.function.Evaluator<? super Parent> evaluator)	Sets names of matching attributes.
static void	setNameOfMatchingAttributes(Parent parent, AttributePredicate predicate, java.util.function.Function<java.lang.String,java.lang.String> nameConverter, cdc.util.function.Evaluator<? super Parent> evaluator)	Sets names of matching attributes.
static void	setNameOfMatchingElements(Parent parent, java.util.function.Predicate<? super Element> predicate, ElementNameConverter converter, cdc.util.function.Evaluator<? super Parent> evaluator)	Sets the name of matching elements.
static void	setNameOfMatchingElements(Parent parent, java.util.function.Predicate<? super Element> predicate, java.util.function.Function<java.lang.String,java.lang.String> nameConverter, cdc.util.function.Evaluator<? super Parent> evaluator)	Sets the name of matching elements.
static void	setValueOfMatchingAttributes(Parent parent, AttributePredicate predicate, AttributeValueConverter converter, cdc.util.function.Evaluator<? super Parent> evaluator)	Sets value of matching attributes.
static void	setValueOfMatchingAttributes(Parent parent, AttributePredicate predicate, java.lang.String value, cdc.util.function.Evaluator<? super Parent> evaluator)	Sets values of matching attributes with a constant value.
static void	setValueOfMatchingAttributes(Parent parent, AttributePredicate predicate, java.util.function.Function<java.lang.String,java.lang.String> valueConverter, cdc.util.function.Evaluator<? super Parent> evaluator)	Sets value of matching attributes.
static void	sortAttributes(Parent parent, java.util.Comparator<Attribute> comparator, cdc.util.function.Evaluator<? super Parent> evaluator)	Sorts attributes of elements using a user defined sorter.
static void	sortAttributesByName(Parent parent, cdc.util.function.Evaluator<? super Parent> evaluator)	Sorts attributes in alphabetical order.
static void	sortChildren(Parent parent, java.util.function.Predicate<? super Parent> predicate, java.util.Comparator<? super Child> comparator, cdc.util.function.Evaluator<? super Parent> evaluator)	Sorts children nodes using a user-defined comparator.
static void	sortChildrenElementsByName(Parent parent, java.util.function.Predicate<? super Parent> predicate, cdc.util.function.Evaluator<? super Parent> evaluator)
static void	sortChildrenElementsByNameAndAttributes(Parent parent, java.util.function.Predicate<? super Parent> predicate, cdc.util.function.Evaluator<? super Parent> evaluator)

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_NAME_COMPARATOR

public static final java.util.Comparator<Node> ELEMENT_NAME_COMPARATOR

ELEMENT_NAME_AND_ATTRIBUTES_COMPARATOR

public static final java.util.Comparator<Node> ELEMENT_NAME_AND_ATTRIBUTES_COMPARATOR

RECURSE

public static final cdc.util.function.Evaluator<Node> RECURSE

Method Detail

setNameOfMatchingAttributes

public static void setNameOfMatchingAttributes(Parent parent,
                                               AttributePredicate predicate,
                                               AttributeNameConverter converter,
                                               cdc.util.function.Evaluator<? super Parent> evaluator)

Sets names of matching attributes.

Uses a Depth First traversal for recursion.
Change is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching attributes. MUST NOT be null.

converter - The attribute name converter. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

setNameOfMatchingAttributes

public static void setNameOfMatchingAttributes(Parent parent,
                                               AttributePredicate predicate,
                                               java.util.function.Function<java.lang.String,java.lang.String> nameConverter,
                                               cdc.util.function.Evaluator<? super Parent> evaluator)

Sets names of matching attributes.

Uses a Depth First traversal for recursion.
Change is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching attributes. MUST NOT be null.

nameConverter - The attribute name converter. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

setValueOfMatchingAttributes

public static void setValueOfMatchingAttributes(Parent parent,
                                                AttributePredicate predicate,
                                                AttributeValueConverter converter,
                                                cdc.util.function.Evaluator<? super Parent> evaluator)

Sets value of matching attributes.

Uses a Depth First traversal for recursion.
Change is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching attributes. MUST NOT be null.

converter - The attribute value converter. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

setValueOfMatchingAttributes

public static void setValueOfMatchingAttributes(Parent parent,
                                                AttributePredicate predicate,
                                                java.util.function.Function<java.lang.String,java.lang.String> valueConverter,
                                                cdc.util.function.Evaluator<? super Parent> evaluator)

Sets value of matching attributes.

Uses a Depth First traversal for recursion.
Change is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching attributes. MUST NOT be null.

valueConverter - The attribute value converter. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

setValueOfMatchingAttributes

public static void setValueOfMatchingAttributes(Parent parent,
                                                AttributePredicate predicate,
                                                java.lang.String value,
                                                cdc.util.function.Evaluator<? super Parent> evaluator)

Sets values of matching attributes with a constant value.

Uses a Depth First traversal for recursion.
Change is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching attributes. MUST NOT be null.

value - The new value.

evaluator - The evaluator. MUST NOT be null.

scrambleValuesOfMatchingAttributes

public static void scrambleValuesOfMatchingAttributes(Parent parent,
                                                      AttributePredicate predicate,
                                                      cdc.util.function.Evaluator<? super Parent> evaluator,
                                                      boolean preserveSpaces)

Scrambles values of matching attributes.

Uses a Depth First traversal for recursion.
Change is applied on parent before its children.
Characters are replaced with random letters or digits.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching attributes. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

preserveSpaces - If true, spaces are preserved.

removeMatchingAttributes

public static void removeMatchingAttributes(Parent parent,
                                            AttributePredicate predicate,
                                            cdc.util.function.Evaluator<? super Parent> evaluator)

Removes matching attributes.

Uses a Depth First traversal for recursion.
Removal is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching attributes. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

removeEmptyAttributes

public static void removeEmptyAttributes(Parent parent,
                                         cdc.util.function.Evaluator<? super Parent> evaluator)

Recursively removes empty attributes.

Uses a Depth First traversal for recursion.
Removal is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

sortAttributes

public static void sortAttributes(Parent parent,
                                  java.util.Comparator<Attribute> comparator,
                                  cdc.util.function.Evaluator<? super Parent> evaluator)

Sorts attributes of elements using a user defined sorter.

Uses a Depth First traversal for recursion.
Sort is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

comparator - The attribute name comparator. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

sortAttributesByName

public static void sortAttributesByName(Parent parent,
                                        cdc.util.function.Evaluator<? super Parent> evaluator)

Sorts attributes in alphabetical order.

Uses a Depth First traversal for recursion.
Sort is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

moveAttributeFirst

public static void moveAttributeFirst(Parent parent,
                                      java.util.function.Predicate<? super Element> predicate,
                                      java.lang.String name,
                                      cdc.util.function.Evaluator<? super Parent> evaluator)

Moves the attribute that has a given name to first position, if it exists.

Uses a Depth First traversal for recursion.
Move is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching elements. MUST NOT be null.

name - The attribute name.

evaluator - The evaluator. MUST NOT be null.

setNameOfMatchingElements

public static void setNameOfMatchingElements(Parent parent,
                                             java.util.function.Predicate<? super Element> predicate,
                                             ElementNameConverter converter,
                                             cdc.util.function.Evaluator<? super Parent> evaluator)

Sets the name of matching elements.

Uses a Depth First traversal for recursion.
Change is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching elements. MUST NOT be null.

converter - The name converter. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

setNameOfMatchingElements

public static void setNameOfMatchingElements(Parent parent,
                                             java.util.function.Predicate<? super Element> predicate,
                                             java.util.function.Function<java.lang.String,java.lang.String> nameConverter,
                                             cdc.util.function.Evaluator<? super Parent> evaluator)

Sets the name of matching elements.

Uses a Depth First traversal for recursion.
Change is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching elements. MUST NOT be null.

nameConverter - The name converter.

evaluator - The evaluator. MUST NOT be null.

setContentOfMatchingTexts

public static void setContentOfMatchingTexts(Parent parent,
                                             TextPredicate predicate,
                                             TextContentConverter converter,
                                             cdc.util.function.Evaluator<? super Parent> evaluator)

Sets the content of matching texts.

Uses a Depth First traversal for recursion.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching texts. MUST NOT be null.

converter - The content converter.

evaluator - The evaluator. MUST NOT be null.

setContentOfMatchingTexts

public static void setContentOfMatchingTexts(Parent parent,
                                             TextPredicate predicate,
                                             java.util.function.Function<java.lang.String,java.lang.String> contentConverter,
                                             cdc.util.function.Evaluator<? super Parent> evaluator)

Sets the content of matching texts.

Uses a Depth First traversal for recursion.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching texts. MUST NOT be null.

contentConverter - The content converter.

evaluator - The evaluator. MUST NOT be null.

scrambleContentOfMatchingTexts

public static void scrambleContentOfMatchingTexts(Parent parent,
                                                  TextPredicate predicate,
                                                  cdc.util.function.Evaluator<? super Parent> evaluator,
                                                  boolean preserveSpaces)

Scrambles the content of matching texts.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of matching texts. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

preserveSpaces - If true, spaces are preserved.

removeMatchingChildren

public static void removeMatchingChildren(Parent parent,
                                          java.util.function.Predicate<? super Child> predicate,
                                          cdc.util.function.Evaluator<? super Parent> evaluator)

Removes matching children.

Uses a Depth First traversal for recursion.
Removal is applied on children before parent.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of children nodes to remove. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

removeComments

public static void removeComments(Parent parent,
                                  cdc.util.function.Evaluator<? super Parent> evaluator)

Removes comments nodes.

Uses a Depth First traversal for recursion.
Removal is applied on children before parent.

Parameters:

parent - The initial node. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

removeIgnorableText

public static void removeIgnorableText(Parent parent,
                                       cdc.util.function.Evaluator<? super Parent> evaluator)

Removes text that can be ignored.

Uses a Depth First traversal for recursion.
Removal is applied on children before parent.

Parameters:

parent - The initial node. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

removeEmptyElements

public static void removeEmptyElements(Parent parent,
                                       cdc.util.function.Evaluator<? super Parent> evaluator)

Removes empty elements.

Uses a Depth First traversal for recursion.
Removal is applied on children before parent.

Parameters:

parent - The initial node. MUST NOT be null.

evaluator - The evaluator. MUST NOT be null.

sortChildren

public static void sortChildren(Parent parent,
                                java.util.function.Predicate<? super Parent> predicate,
                                java.util.Comparator<? super Child> comparator,
                                cdc.util.function.Evaluator<? super Parent> evaluator)

Sorts children nodes using a user-defined comparator.

Uses a Depth First traversal for recursion.
Sort is applied on parent before its children.

Parameters:

parent - The initial node. MUST NOT be null.

predicate - The predicate of nodes whose children must be sorted. MUST NOT be null.

comparator - The children comparator.

evaluator - The evaluator. MUST NOT be null.

sortChildrenElementsByName

public static void sortChildrenElementsByName(Parent parent,
                                              java.util.function.Predicate<? super Parent> predicate,
                                              cdc.util.function.Evaluator<? super Parent> evaluator)

sortChildrenElementsByNameAndAttributes

public static void sortChildrenElementsByNameAndAttributes(Parent parent,
                                                           java.util.function.Predicate<? super Parent> predicate,
                                                           cdc.util.function.Evaluator<? super Parent> evaluator)

hasAncestorMatching

public static boolean hasAncestorMatching(Node node,
                                          java.util.function.Predicate<Node> predicate)

hasDescendantMatching

public static boolean hasDescendantMatching(Node node,
                                            java.util.function.Predicate<Node> predicate,
                                            boolean strict)

hasAllDescendantsMatching

public static boolean hasAllDescendantsMatching(Node node,
                                                java.util.function.Predicate<Node> predicate,
                                                boolean strict)