summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/funcdata/bst/TreePart.java
blob: b451463e17be64a9bd6bcc0adb1c04736404bf42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
package bjc.funcdata.bst;

import java.util.Comparator;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Predicate;

/**
 * A interface for the fundamental things that want to be part of a tree.
 *
 * @author ben
 *
 * @param <T>
 *            The data contained in this part of the tree.
 */
public interface TreePart<T> {
	/**
	 * Add a element below this tree part somewhere.
	 *
	 * @param element
	 *                   The element to add below this tree part
	 *
	 * @param comparator
	 *                   The thing to use for comparing values to find where to
	 *                   insert the tree part.
	 */
	public void add(T element, Comparator<T> comparator);

	/**
	 * Collapses this tree part into a single value.
	 *
	 * Does not change the underlying tree.
	 *
	 * @param <E>
	 *                        The type of the final collapsed value
	 *
	 * @param nodeCollapser
	 *                        The function to use to transform data into mapped
	 *                        form.
	 *
	 * @param branchCollapser
	 *                        The function to use to collapse data in mapped form
	 *                        into a single value.
	 *
	 * @return A single value from collapsing the tree.
	 */
	public <E> E collapse(Function<T, E> nodeCollapser,
			BiFunction<E, E, E> branchCollapser);

	/**
	 * Check if this tre part or below it contains the specified data item.
	 *
	 * @param element
	 *                   The data item to look for.
	 *
	 * @param comparator
	 *                   The comparator to use to search for the data item.
	 *
	 * @return Whether or not the given item is contained in this tree part or its
	 *         children.
	 */
	public boolean contains(T element, Comparator<T> comparator);

	/**
	 * Get the data associated with this tree part.
	 *
	 * @return The data associated with this tree part.
	 */
	public T data();

	/**
	 * Remove the given node from this tree part and any of its children.
	 *
	 * @param element
	 *                   The data item to remove.
	 *
	 * @param comparator
	 *                   The comparator to use to search for the data item.
	 */
	public void delete(T element, Comparator<T> comparator);

	/**
	 * Execute a directed walk through the tree.
	 *
	 * @param walker
	 *               The function to use to direct the walk through the tree.
	 *
	 * @return Whether the directed walk finished successfully.
	 */
	public boolean directedWalk(DirectedWalkFunction<T> walker);

	/**
	 * Execute a provided function for each element of tree it succesfully completes
	 * for.
	 *
	 * @param linearizationMethod
	 *                            The way to linearize the tree for executing.
	 *
	 * @param predicate
	 *                            The predicate to apply to each element, where it
	 *                            returning false terminates traversal early.
	 *
	 * @return Whether the traversal finished succesfully.
	 */
	public boolean forEach(TreeLinearizationMethod linearizationMethod,
			Predicate<T> predicate);
}