xxl.indexStructures
Class ORTree

java.lang.Object
  |
  +--xxl.indexStructures.Tree
        |
        +--xxl.indexStructures.ORTree
Direct Known Subclasses:
BTree, RTree

public abstract class ORTree
extends Tree


Inner Class Summary
 class ORTree.IndexEntry
           
 class ORTree.IndexEntryConverter
           
 class ORTree.Node
           
 class ORTree.NodeConverter
           
 
Inner classes inherited from class xxl.indexStructures.Tree
Tree.Descriptor, Tree.IndexEntry, Tree.Node, Tree.Query
 
Fields inherited from class xxl.indexStructures.Tree
determineContainer, getContainer, getDescriptor, getSplitMaxRatio, getSplitMinRatio, height, overflows, rootDescriptor, rootEntry, underflows
 
Constructor Summary
ORTree()
           
 
Method Summary
 void checkDescriptors()
           
 void checkDescriptors(ORTree.IndexEntry indexEntry, int parentLevel)
           
 Tree.IndexEntry createIndexEntry(int level)
           
abstract  Tree.Node createNode(int level)
           
 Tree.Descriptor descriptor(java.lang.Object entry)
           
 Converter indexEntryConverter(Converter idConverter, Converter descriptorConverter)
           
 ORTree initialize(ORTree.IndexEntry rootEntry, int height, Function getDescriptor, Container container, int minCapacity, int maxCapacity)
           
 ORTree initialize(ORTree.IndexEntry rootEntry, int height, Function getDescriptor, Function getContainer, Function determineContainer, Function underflows, Function overflows, Function getSplitMinRatio, Function getSplitMaxRatio)
           
 Converter nodeConverter(Converter objectConverter, Converter idConverter, Converter descriptorConverter)
           
 java.util.Iterator query(Tree.Descriptor queryDescriptor, int targetLevel)
          Returns an iterator for all objects whose descriptors overlap with the given queryDescriptor
 
Methods inherited from class xxl.indexStructures.Tree
chooseLeaf, chooseLeaf, chooseLeaf, down, grow, height, indexEntry, initialize, initialize, initialize, initialize, insert, insert, level, node, query, query, query, rootDescriptor, rootEntry, up, update
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ORTree

public ORTree()
Method Detail

checkDescriptors

public void checkDescriptors()

checkDescriptors

public void checkDescriptors(ORTree.IndexEntry indexEntry,
                             int parentLevel)

initialize

public ORTree initialize(ORTree.IndexEntry rootEntry,
                         int height,
                         Function getDescriptor,
                         Function getContainer,
                         Function determineContainer,
                         Function underflows,
                         Function overflows,
                         Function getSplitMinRatio,
                         Function getSplitMaxRatio)

initialize

public ORTree initialize(ORTree.IndexEntry rootEntry,
                         int height,
                         Function getDescriptor,
                         Container container,
                         int minCapacity,
                         int maxCapacity)

descriptor

public Tree.Descriptor descriptor(java.lang.Object entry)

createIndexEntry

public Tree.IndexEntry createIndexEntry(int level)
Overrides:
createIndexEntry in class Tree

createNode

public abstract Tree.Node createNode(int level)
Overrides:
createNode in class Tree

indexEntryConverter

public Converter indexEntryConverter(Converter idConverter,
                                     Converter descriptorConverter)

nodeConverter

public Converter nodeConverter(Converter objectConverter,
                               Converter idConverter,
                               Converter descriptorConverter)

query

public java.util.Iterator query(Tree.Descriptor queryDescriptor,
                                int targetLevel)
Returns an iterator for all objects whose descriptors overlap with the given queryDescriptor
Parameters:
queryDescriptor - describes the query in terms of a descriptor
level - the tree-level to provide the answer-objects
Overrides:
query in class Tree