com.bigdata.search
Class TermMetadata

java.lang.Object
  extended by com.bigdata.search.TermMetadata
All Implemented Interfaces:
ITermMetadata

public class TermMetadata
extends Object
implements ITermMetadata

Mutable metadata for the occurrences of a term within a field of some document.

Version:
$Id$
Author:
Bryan Thompson

Constructor Summary
TermMetadata()
           
 
Method Summary
 void add()
          Add an occurrence.
 double getLocalTermWeight()
          The local term weight, which may be computed by a variety of methods.
 void setLocalTermWeight(double d)
          The local term weight, which may be computed by a variety of methods.
 int termFreq()
          The term (aka token) frequency count.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TermMetadata

public TermMetadata()
Method Detail

termFreq

public int termFreq()
Description copied from interface: ITermMetadata
The term (aka token) frequency count.

Specified by:
termFreq in interface ITermMetadata

getLocalTermWeight

public final double getLocalTermWeight()
Description copied from interface: ITermMetadata
The local term weight, which may be computed by a variety of methods.

Specified by:
getLocalTermWeight in interface ITermMetadata

setLocalTermWeight

public final void setLocalTermWeight(double d)
Description copied from interface: ITermMetadata
The local term weight, which may be computed by a variety of methods.

Specified by:
setLocalTermWeight in interface ITermMetadata

add

public void add()
Description copied from interface: ITermMetadata
Add an occurrence.

Specified by:
add in interface ITermMetadata

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2006-2011 SYSTAP, LLC. All Rights Reserved.