Package org.apache.lucene.index
Interface PointValues.PointTree
-
- All Superinterfaces:
Cloneable
- All Known Implementing Classes:
MutablePointTree
- Enclosing class:
- PointValues
public static interface PointValues.PointTree extends Cloneable
Basic operations to read the KD-tree.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PointValues.PointTreeclone()Clone, the current node becomes the root of the new tree.byte[]getMaxPackedValue()Return the maximum packed value of the current node.byte[]getMinPackedValue()Return the minimum packed value of the current node.booleanmoveToChild()Move to the first child node and returntrueupon success.booleanmoveToParent()Move to the parent node and returntrueupon success.booleanmoveToSibling()Move to the next sibling node and returntrueupon success.longsize()Return the number of points below the current node.voidvisitDocIDs(PointValues.IntersectVisitor visitor)Visit all the docs below the current node.voidvisitDocValues(PointValues.IntersectVisitor visitor)Visit all the docs and values below the current node.
-
-
-
Method Detail
-
clone
PointValues.PointTree clone()
Clone, the current node becomes the root of the new tree.
-
moveToChild
boolean moveToChild() throws IOExceptionMove to the first child node and returntrueupon success. Returnsfalsefor leaf nodes andtrueotherwise.- Throws:
IOException
-
moveToSibling
boolean moveToSibling() throws IOExceptionMove to the next sibling node and returntrueupon success. Returnsfalseif the current node has no more siblings.- Throws:
IOException
-
moveToParent
boolean moveToParent() throws IOExceptionMove to the parent node and returntrueupon success. Returnsfalsefor the root node andtrueotherwise.- Throws:
IOException
-
getMinPackedValue
byte[] getMinPackedValue()
Return the minimum packed value of the current node.
-
getMaxPackedValue
byte[] getMaxPackedValue()
Return the maximum packed value of the current node.
-
size
long size()
Return the number of points below the current node.
-
visitDocIDs
void visitDocIDs(PointValues.IntersectVisitor visitor) throws IOException
Visit all the docs below the current node.- Throws:
IOException
-
visitDocValues
void visitDocValues(PointValues.IntersectVisitor visitor) throws IOException
Visit all the docs and values below the current node.- Throws:
IOException
-
-