com.fatdog.xmlEngine
Class DocItems

java.lang.Object
  extended bycom.fatdog.xmlEngine.words.WordBreaker
      extended bycom.fatdog.xmlEngine.DocItems
All Implemented Interfaces:
IWordHandler

public class DocItems
extends WordBreaker
implements IWordHandler

A collection of items corresponding to one document's contribution to a ResultList. The items are "proper" nodes from the index if if m_id >= 0; constructed nodes and atomics if m_id = QUERY_DOCUMENT.

Version:
0.66
Author:
Howard Katz, howardk@fatdog.com

Field Summary
static int ATTR
           
static int ATTR_TEXT
           
static int BOOLEAN
           
static int BOOLEAN_FALSE
           
static int BOOLEAN_TRUE
           
static int DOC_NODE
           
static int ELEM
           
static int FALSE
           
static int INT
           
static int NULL_ORDERSPEC
           
static int QUERY_DOCUMENT
           
static int STRING
           
static int TEXT
           
static int TEXT_AS_STRING
           
static int TRUE
           
static int VOIDED_NODE
           
 
Constructor Summary
DocItems(IndexManager indexer)
           
DocItems(IndexManager indexer, int initialAllocs)
           
DocItems(IndexManager indexer, int[] valueType)
           
DocItems(IndexManager indexer, int[] valueType, int docId)
           
DocItems(IndexManager indexer, IntList list)
           
DocItems(NodeTree itsTree)
           
DocItems(NodeTree itsTree, int initialAllocs)
           
DocItems(NodeTree itsTree, IntList itsList)
           
 
Method Summary
 void addRef_2(int arg1, int arg2)
           
 void addToNodeTree(QueryDocumentTree dest)
           
 int amalgamateAdjacentAtomics(TreeWalker treeWalker)
           
 int ancestor(IntList ancList)
           
 void append(DocItems doc)
           
 java.lang.StringBuffer asString(boolean appendSpace)
           
 java.lang.StringBuffer asString(int[] item)
           
 java.lang.StringBuffer asString(int[] item, boolean addInterTextSpace)
           
 DocItems cloneDoc()
           
 int complexBlockPositional(java.lang.String compareOp, int subscript)
           
 int complexPositional(java.lang.String compareOp, int subscript)
           
 int contains_word(java.util.Vector words, java.util.Vector flags, TreeWalker treeWalker)
           
 boolean containsAtomics()
           
 boolean containsNonAtomics()
           
 java.lang.String doString(boolean detailOnly)
           
 void emitXml(java.io.PrintWriter w, boolean prettyPrint)
           
 int evaluateAsInteger(int itemIx)
           
 int evaluateAsString(int itemIx)
           
 boolean generalCompare(java.lang.String compareOp, DocItems doc_2)
           
 boolean generalCompareOnLhs(java.lang.String compareOp, DocItems doc_2)
           
 int[] getFirstValidItem()
           
 int getId()
           
 IntList getIntList()
           
 DocItems getNextDocument()
           
 int[] getNotatedNodeList()
           
 int getNumTotalItems()
           
 int getNumValidItems()
           
 DocItems getPriorDocument()
           
 int[] getSingleValue()
           
 NodeTree getTree()
           
 DocItems groupPositional(int n)
           
 boolean isAtomic(int[] item)
           
 boolean isAttributeNode(int[] item)
           
 boolean isBoolean(int[] item)
           
 boolean isElementNode(int[] item)
           
 boolean isInteger(int[] item)
           
 boolean isNode(int[] item)
           
 boolean isSorted()
           
 boolean isString(int[] item)
           
 boolean isTextNode(int[] item)
           
 int namedParentOfEvaledChild(int[] parentKey)
           
 void newWord(char[] cbuf, int wordStart, int wordEnd, int parent, IntList matches)
          This method will be called whenever WordBreaker.characters(char[], int, int, int, IntList) encounters a new word.
 int nodesAtRoot()
           
 void parentOf()
           
 DocItems removeAttributes()
           
 void setId(int id)
           
 void setList(IntList list)
           
 void setList(IntList list, int numInvalid)
           
 void setNextDocument(DocItems document)
           
 void setNumTotalItems(int numTotalNodes)
           
 void setNumValidItems(int numValidNodes)
           
 void setPriorDocument(DocItems document)
           
 void sort()
           
 void sort(IntList orderSpecList, IntList returnCounts)
           
 void string_value(TreeWalker itsWalker)
           
 void string_value(TreeWalker itsWalker, boolean addInterTextSpaces)
           
 int[] subscript(int n)
           
 java.lang.String toString()
           
 void trim()
           
 void updateValidItemCount(int update)
           
 
Methods inherited from class com.fatdog.xmlEngine.words.WordBreaker
characters, getIgnoreCase, getSearchWord, registerWordHandler, registerWordHandler, setIgnoreCase, setSearchWord, toLowerCase, toLowerCase
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

QUERY_DOCUMENT

public static final int QUERY_DOCUMENT
See Also:
Constant Field Values

ELEM

public static final int ELEM
See Also:
Constant Field Values

ATTR

public static final int ATTR
See Also:
Constant Field Values

TEXT

public static final int TEXT
See Also:
Constant Field Values

DOC_NODE

public static final int DOC_NODE
See Also:
Constant Field Values

INT

public static final int INT
See Also:
Constant Field Values

STRING

public static final int STRING
See Also:
Constant Field Values

BOOLEAN

public static final int BOOLEAN
See Also:
Constant Field Values

ATTR_TEXT

public static final int ATTR_TEXT
See Also:
Constant Field Values

TEXT_AS_STRING

public static final int TEXT_AS_STRING
See Also:
Constant Field Values

NULL_ORDERSPEC

public static final int NULL_ORDERSPEC
See Also:
Constant Field Values

TRUE

public static final int TRUE
See Also:
Constant Field Values

FALSE

public static final int FALSE
See Also:
Constant Field Values

VOIDED_NODE

public static final int VOIDED_NODE
See Also:
Constant Field Values

BOOLEAN_FALSE

public static final int BOOLEAN_FALSE
See Also:
Constant Field Values

BOOLEAN_TRUE

public static final int BOOLEAN_TRUE
See Also:
Constant Field Values
Constructor Detail

DocItems

public DocItems(NodeTree itsTree)

DocItems

public DocItems(NodeTree itsTree,
                int initialAllocs)

DocItems

public DocItems(NodeTree itsTree,
                IntList itsList)

DocItems

public DocItems(IndexManager indexer)

DocItems

public DocItems(IndexManager indexer,
                int[] valueType,
                int docId)

DocItems

public DocItems(IndexManager indexer,
                int[] valueType)

DocItems

public DocItems(IndexManager indexer,
                int initialAllocs)

DocItems

public DocItems(IndexManager indexer,
                IntList list)
Method Detail

setList

public void setList(IntList list)

setList

public void setList(IntList list,
                    int numInvalid)

evaluateAsInteger

public int evaluateAsInteger(int itemIx)

evaluateAsString

public int evaluateAsString(int itemIx)

setId

public void setId(int id)

getId

public int getId()

getTree

public NodeTree getTree()

getIntList

public IntList getIntList()

addRef_2

public void addRef_2(int arg1,
                     int arg2)

getNotatedNodeList

public int[] getNotatedNodeList()

getNumValidItems

public int getNumValidItems()

getNumTotalItems

public int getNumTotalItems()

setNumValidItems

public void setNumValidItems(int numValidNodes)

setNumTotalItems

public void setNumTotalItems(int numTotalNodes)

updateValidItemCount

public void updateValidItemCount(int update)

setNextDocument

public void setNextDocument(DocItems document)

setPriorDocument

public void setPriorDocument(DocItems document)

getNextDocument

public DocItems getNextDocument()

getPriorDocument

public DocItems getPriorDocument()

trim

public void trim()

groupPositional

public DocItems groupPositional(int n)

complexPositional

public int complexPositional(java.lang.String compareOp,
                             int subscript)

complexBlockPositional

public int complexBlockPositional(java.lang.String compareOp,
                                  int subscript)

isSorted

public boolean isSorted()

sort

public void sort()

namedParentOfEvaledChild

public int namedParentOfEvaledChild(int[] parentKey)

nodesAtRoot

public int nodesAtRoot()

parentOf

public void parentOf()

ancestor

public int ancestor(IntList ancList)

contains_word

public int contains_word(java.util.Vector words,
                         java.util.Vector flags,
                         TreeWalker treeWalker)

newWord

public void newWord(char[] cbuf,
                    int wordStart,
                    int wordEnd,
                    int parent,
                    IntList matches)
Description copied from interface: IWordHandler
This method will be called whenever WordBreaker.characters(char[], int, int, int, IntList) encounters a new word.

Specified by:
newWord in interface IWordHandler
Parameters:
cbuf - A char[] array holding the word, possibly larger than the word itself
wordStart - Starting offset of the word in the array
wordEnd - Offset of the first character past the end of the word
parent - Document id index of the node in which the word is found
matches - An optional IntList you can pass indirectly to the routine via WordBreaker.characters()
See Also:
FandO.contains_word(SimpleNode,SimpleNode), IndexManager

emitXml

public void emitXml(java.io.PrintWriter w,
                    boolean prettyPrint)

asString

public java.lang.StringBuffer asString(int[] item)

asString

public java.lang.StringBuffer asString(int[] item,
                                       boolean addInterTextSpace)

asString

public java.lang.StringBuffer asString(boolean appendSpace)

toString

public java.lang.String toString()

doString

public java.lang.String doString(boolean detailOnly)

subscript

public int[] subscript(int n)

string_value

public void string_value(TreeWalker itsWalker)

string_value

public void string_value(TreeWalker itsWalker,
                         boolean addInterTextSpaces)

append

public void append(DocItems doc)

getFirstValidItem

public int[] getFirstValidItem()

cloneDoc

public DocItems cloneDoc()

removeAttributes

public DocItems removeAttributes()

addToNodeTree

public void addToNodeTree(QueryDocumentTree dest)

containsAtomics

public boolean containsAtomics()

containsNonAtomics

public boolean containsNonAtomics()

sort

public void sort(IntList orderSpecList,
                 IntList returnCounts)

generalCompareOnLhs

public boolean generalCompareOnLhs(java.lang.String compareOp,
                                   DocItems doc_2)
                            throws InvalidQueryException
Throws:
InvalidQueryException

generalCompare

public boolean generalCompare(java.lang.String compareOp,
                              DocItems doc_2)
                       throws InvalidQueryException
Throws:
InvalidQueryException

amalgamateAdjacentAtomics

public int amalgamateAdjacentAtomics(TreeWalker treeWalker)

isAtomic

public boolean isAtomic(int[] item)

isNode

public boolean isNode(int[] item)

isInteger

public boolean isInteger(int[] item)

isString

public boolean isString(int[] item)

isBoolean

public boolean isBoolean(int[] item)

isElementNode

public boolean isElementNode(int[] item)

isAttributeNode

public boolean isAttributeNode(int[] item)

isTextNode

public boolean isTextNode(int[] item)

getSingleValue

public int[] getSingleValue()