com.bigdata.search

Interface ITermDocKey<V extends Comparable<V>>

All Known Subinterfaces:

ITermDocRecord<V>

All Known Implementing Classes:

ReadOnlyTermDocKey, ReadOnlyTermDocRecord

public interface ITermDocKey<V extends Comparable<V>>

Interface for the key associated with an entry in the full text index.

Version:

$Id$

Author:

Bryan Thompson

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.

Method Detail

getToken

String getToken()
                throws UnsupportedOperationException

The token text.

Throws:

UnsupportedOperationException - The sort key for the token text is not decodable. Therefore, this operation is not supported when reading on the full text index.

getLocalTermWeight

double getLocalTermWeight()

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

getDocId

V getDocId()

The document identifier.

getFieldId

int getFieldId()
               throws UnsupportedOperationException

The field identifier.

Returns:

The field identifier.

Throws:

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