org.sindice.siren.util

Class NodeUtils

java.lang.Object

org.sindice.siren.util.NodeUtils

public class NodeUtils
extends Object

Reusable methods to manage and compare node paths.

Constructor Summary

Constructors

Constructor and Description
NodeUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static int	compare(org.apache.lucene.util.IntsRef n1, org.apache.lucene.util.IntsRef n2) Compares the first node with the second node for order.
static int	compareAncestor(int[] n1, int n1Len, int[] n2, int n2Len)
static int	compareAncestor(org.apache.lucene.util.IntsRef n1, org.apache.lucene.util.IntsRef n2) Compares the first node with the second node for order.
static int[]	growAndCopy(int[] array, int minSize) Increase the size of the array and copy the content of the original array into the new one.
static boolean	isConstraintSatisfied(org.apache.lucene.util.IntsRef node, int level) Check if a node path is satisfying the level constraint.
static boolean	isConstraintSatisfied(org.apache.lucene.util.IntsRef node, int level, int[] constraint) Check if a node path is satisfying the interval constraints.
static boolean	isConstraintSatisfied(org.apache.lucene.util.IntsRef node, int level, int[] levelIndex, int[][] constraints) Check if a node path is satisfying the interval constraints.

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeUtils

public NodeUtils()

Method Detail

compare

public static final int compare(org.apache.lucene.util.IntsRef n1,
          org.apache.lucene.util.IntsRef n2)

Compares the first node with the second node for order. Returns a negative integer, zero, or a positive integer if the first node is less than, equal to, or greater than the second node.

compareAncestor

public static final int compareAncestor(org.apache.lucene.util.IntsRef n1,
                  org.apache.lucene.util.IntsRef n2)

Compares the first node with the second node for order. Returns:

• a negative integer if the first node is a predecessor of the second node,
• zero if the first node is an ancestor of the second node,
• a positive integer if the first node is equal to or greater than the second node.

compareAncestor

public static final int compareAncestor(int[] n1,
                  int n1Len,
                  int[] n2,
                  int n2Len)

growAndCopy

public static final int[] growAndCopy(int[] array,
                int minSize)

Increase the size of the array and copy the content of the original array into the new one.

isConstraintSatisfied

public static final boolean isConstraintSatisfied(org.apache.lucene.util.IntsRef node,
                            int level,
                            int[] levelIndex,
                            int[][] constraints)

Check if a node path is satisfying the interval constraints.

The level parameter allows to force the node to be on a certain level.

The levelIndex array contains the level associated with the interval constraints in constraints.

Example:
Given the lower bound constraint [1], upper bound constraint [10] at level 1, then the node paths [1,4], [5,10,9] or [10,5] satisfy the constraints. However, the node path [0,3] or [11,0,9] does not satisfy the constraints.

isConstraintSatisfied

public static final boolean isConstraintSatisfied(org.apache.lucene.util.IntsRef node,
                            int level,
                            int[] constraint)

Check if a node path is satisfying the interval constraints.

The levelIndex array contains the level associated with the interval constraints in constraints.

Example:
Given the lower bound constraint [1], upper bound constraint [10] at level 1, then the node paths [1,4], [5,10,9] or [10,5] satisfy the constraints. However, the node path [0,3] or [11,0,9] does not satisfy the constraints.

isConstraintSatisfied

public static final boolean isConstraintSatisfied(org.apache.lucene.util.IntsRef node,
                            int level)

Check if a node path is satisfying the level constraint.

The level parameter allows to force the node to be on a certain level.
Given that the root of the tree (level 0) is the document id, the node level constraint ranges from 1 to Integer.MAX_VALUE. A node level constraint of 0 will always return false.
The sentinel value to ignore the node level constraint is -1.

Example:
Given the level constraint 2, the node paths [0,1], [3,10] or [2,5] satisfy the constraints. However, the node path [2,3,4] does not satisfy the constraints.