org.apache.xindice.core.indexer
Class IndexMatch

java.lang.Object
  org.apache.xindice.core.indexer.IndexMatch

All Implemented Interfaces:

Comparable

public final class IndexMatch

extends Object

implements Comparable

IndexMatch is used for representing match information. IndexMatches are the basic unit of information between Indexers and the IndexManager for performing queries and query optimization.

Version:

$Revision: 564424 $, $Date: 2007-08-09 19:40:03 -0400 (Thu, 09 Aug 2007) $

Constructor Summary

IndexMatch()

IndexMatch(Key key, IndexPattern pattern)

IndexMatch(Key key, int pos, int len)

IndexMatch(Key key, int pos, int len, short elem, short attr)

IndexMatch(Key key, short elem, short attr)

Method Summary

int	compareTo(Object obj)
short	getAttribute() getAttribute returns the Attribute symbol ID for the Match.
short	getElement() getElement returns the Element symbol ID for the Match.
Key	getKey() getKey returns the Document Key for the IndexMatch.
int	getLength() getLength returns the Node length for the Match.
int	getPosition() getPosition returns the Document position for the Match.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexMatch

public IndexMatch()

IndexMatch

public IndexMatch(Key key,
                  int pos,
                  int len,
                  short elem,
                  short attr)

IndexMatch

public IndexMatch(Key key,
                  int pos,
                  int len)

IndexMatch

public IndexMatch(Key key,
                  IndexPattern pattern)

IndexMatch

public IndexMatch(Key key,
                  short elem,
                  short attr)

Method Detail

getKey

public final Key getKey()

getKey returns the Document Key for the IndexMatch.

Returns:

The Key

getPosition

public final int getPosition()

getPosition returns the Document position for the Match.

Returns:

The Document position

getLength

public final int getLength()

getLength returns the Node length for the Match.

Returns:

The Node length

getElement

public final short getElement()

getElement returns the Element symbol ID for the Match.

Returns:

The Element Symbol ID

getAttribute

public final short getAttribute()

getAttribute returns the Attribute symbol ID for the Match.

Returns:

The Attribute Symbol ID

compareTo

public int compareTo(Object obj)

Specified by:

compareTo in interface Comparable

toString

public String toString()