com.exalead.mot.components

Class RelatedTermsDictionaryLookup

java.lang.Object

com.exalead.gni.GNIObject

com.exalead.mot.components.RelatedTermsDictionaryLookup

All Implemented Interfaces:

java.lang.Iterable<RelatedTermsEntry>

public class RelatedTermsDictionaryLookup
extends com.exalead.gni.GNIObject
implements java.lang.Iterable<RelatedTermsEntry>

Lookup in a RelatedTermsDict

Constructor Summary

Constructors

Constructor and Description
RelatedTermsDictionaryLookup(RelatedTermsDictResource resource) Initialize a new RelatedTermsDictionaryLookup
RelatedTermsDictionaryLookup(RelatedTermsDictResource resource, boolean hideCounter)

Method Summary

Modifier and Type	Method and Description
void	dump() Dump the resource
protected void	finalize()
int	getBestId(MOTPipeInterface pipe, java.lang.String displayForm, int gid)
java.lang.String	getDisplayForm(int kid) Get the associated display form
long	getDocumentCount()
long	getFreq(int kid) Get the associated frequency
java.lang.String	getKeywordDisplayForm(java.lang.String keyword)
long	getKeywordFrequency(java.lang.String keyword)
boolean	isEmpty()
java.util.Iterator<RelatedTermsEntry>	iterator() Get an iterator

Methods inherited from class com.exalead.gni.GNIObject

printInternalCppPointer

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RelatedTermsDictionaryLookup

public RelatedTermsDictionaryLookup(RelatedTermsDictResource resource)

Initialize a new RelatedTermsDictionaryLookup

Parameters:

resource - The resource to use

RelatedTermsDictionaryLookup

public RelatedTermsDictionaryLookup(RelatedTermsDictResource resource,
                                    boolean hideCounter)

Method Detail

iterator

public java.util.Iterator<RelatedTermsEntry> iterator()

Get an iterator

Specified by:

iterator in interface java.lang.Iterable<RelatedTermsEntry>

getDisplayForm

public java.lang.String getDisplayForm(int kid)

Get the associated display form

Parameters:

kid - The keyword ID

Returns:

The display form

getKeywordDisplayForm

public java.lang.String getKeywordDisplayForm(java.lang.String keyword)

getFreq

public long getFreq(int kid)

Get the associated frequency

Parameters:

kid - The kwyword ID

Returns:

The frequency

getKeywordFrequency

public long getKeywordFrequency(java.lang.String keyword)

getDocumentCount

public long getDocumentCount()

getBestId

public int getBestId(MOTPipeInterface pipe,
                     java.lang.String displayForm,
                     int gid)

isEmpty

public boolean isEmpty()

Returns:

true if the Related Terms dictionary is empty

dump

public void dump()

Dump the resource

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object