de.ipcon.db.fulltext.compass

Class TermInfo

java.lang.Object

de.ipcon.db.fulltext.compass.TermInfo

All Implemented Interfaces:

TermInfoI, SecureExternalizable, java.io.Serializable

public class TermInfo
extends java.lang.Object
implements java.io.Serializable, TermInfoI, SecureExternalizable

A holder for data from a CompassTermFreq object, which implements TermInfoI and is serializable (which the CTF neither does nor is).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TermInfo()
TermInfo(float _freq, java.lang.String _propertyName, java.lang.String _term)

Method Summary

Modifier and Type	Method and Description
float	getFreq() Returns the frequency of the term within the index.
java.lang.String	getPropertyName() Returns the name of the property the term is associated with.
java.lang.String	getTerm() Returns the term value.
void	readInstance(SecureObjectInputI s) Reads an instance of this class from the given SecureObjectInputI without using readObject.
void	setFreq(float $1)
void	setPropertyName(java.lang.String $2)
void	setTerm(java.lang.String $3)
void	writeInstance(SecureObjectOutputI s) Writes an instance of this class to the given SecureObjectOutputI without using writeObject.

Methods inherited from class java.lang.Object

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

Constructor Detail

TermInfo

public TermInfo(float _freq,
                java.lang.String _propertyName,
                java.lang.String _term)

TermInfo

public TermInfo()

Method Detail

writeInstance

public void writeInstance(SecureObjectOutputI s)
                   throws java.io.IOException

Description copied from interface: SecureExternalizable

Writes an instance of this class to the given SecureObjectOutputI without using writeObject.

Specified by:

writeInstance in interface SecureExternalizable

Throws:

java.io.IOException

readInstance

public void readInstance(SecureObjectInputI s)
                  throws java.io.IOException

Description copied from interface: SecureExternalizable

Reads an instance of this class from the given SecureObjectInputI without using readObject.

Specified by:

readInstance in interface SecureExternalizable

Throws:

java.io.IOException

getFreq

public float getFreq()

Description copied from interface: TermInfoI

Returns the frequency of the term within the index. Higher number means more occurences but the exact range of these numbers is undefined (that is, implementation dependent).

Specified by:

getFreq in interface TermInfoI

setFreq

public void setFreq(float $1)

getPropertyName

public java.lang.String getPropertyName()

Description copied from interface: TermInfoI

Returns the name of the property the term is associated with. FIXME I'm not sure what this is if one queried term frequencies over multiple properties.

Specified by:

getPropertyName in interface TermInfoI

setPropertyName

public void setPropertyName(java.lang.String $2)

getTerm

public java.lang.String getTerm()

Description copied from interface: TermInfoI

Returns the term value.

Specified by:

getTerm in interface TermInfoI

setTerm

public void setTerm(java.lang.String $3)