com.bigdata.search

Class ReadOnlyTermDocKey<V extends Comparable<V>>

java.lang.Object

com.bigdata.search.ReadOnlyTermDocKey<V>

All Implemented Interfaces:

ITermDocKey<V>

public class ReadOnlyTermDocKey<V extends Comparable<V>>
extends Object
implements ITermDocKey<V>

Read-only ITermDocKey.

Author:

Bryan Thompson

Constructor Summary

Constructors

Constructor and Description
ReadOnlyTermDocKey(V docId, int fieldId, double termWeight)

Method Summary

Methods

Modifier and Type	Method and Description
V	getDocId() The document identifier.
int	getFieldId() The field identifier.
double	getLocalTermWeight() The normalized local term weight for the token and document in the associated entry of the full text search index.
String	getToken() The token text.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadOnlyTermDocKey

public ReadOnlyTermDocKey(V docId,
                  int fieldId,
                  double termWeight)

Method Detail

getToken

public String getToken()

Description copied from interface: ITermDocKey

The token text.

Specified by:

getToken in interface ITermDocKey<V extends Comparable<V>>

getDocId

public V getDocId()

Description copied from interface: ITermDocKey

The document identifier.

Specified by:

getDocId in interface ITermDocKey<V extends Comparable<V>>

getFieldId

public int getFieldId()
               throws UnsupportedOperationException

Description copied from interface: ITermDocKey

The field identifier.

Specified by:

getFieldId in interface ITermDocKey<V extends Comparable<V>>

Returns:

The field identifier.

Throws:

UnsupportedOperationException - if the full text index is not storing field identifiers.

getLocalTermWeight

public double getLocalTermWeight()

Description copied from interface: ITermDocKey

The normalized local term weight for the token and document in the associated entry of the full text search index.

Specified by:

getLocalTermWeight in interface ITermDocKey<V extends Comparable<V>>