CoOccurrence

Class CoOccurrence

java.lang.Object

CoOccurrence.CoOccurrence

public class CoOccurrence
extends java.lang.Object

Author:

Nina Tahmasebi This class is used to as a component in CoOccurrenceMatrix.
first and second should be Dictionary items with value -1 or 2, i.e. final terms. first and second will be ordered lexically;
first := min{first,second} and second := max{first,second} where min and max are lexical comparisons of strings.

The value associated with each CoOccurrence is the number of times first and second co-occur in the collection. The hash value associated with each CoOccurrence is the hash value of first + " " + second., Nina Tahmasebi, L3S Research Center

See Also:

Term

Constructor Summary

Constructors

Constructor and Description
CoOccurrence(Term first, Term second, java.lang.Double frequency) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares two CoOccurrence a and b.
Term	getFirst() Returns the first term stored in this CoOccurrence
java.lang.Double	getFrequency() Returns the frequency with which the two terms stored, co-occur.
Term	getSecond() Returns the second term stored in this CoOccurrence
int	hashCode() Returns the hash value of first + " " + second
void	incrementFrequency() Increases the frequency of this CoOccurrence with one.
void	setFirst(java.lang.String new_string)
void	setFrequency(java.lang.Double newFrequency) Changes the frequency of this CoOccurrence to any arbitrary double.
void	setSecond(java.lang.String new_string)
java.lang.String	toString() Returns a string representation of the terms in the object separated with a space, followed by the frequency

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CoOccurrence

public CoOccurrence(Term first,
            Term second,
            java.lang.Double frequency)

Sole constructor. It will create a CoOccurrence where the first term is the lexically smallest of first and second.

Parameters:

first - first term encountered

second - second term encountered

frequency - the frequency with which first and second co-occur within the collection.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares two CoOccurrence a and b. The are considered equal if a.getFirst = b.getFirst and a.getSecond = b.getSecond disregarding the frequencies of a and b.

Overrides:

equals in class java.lang.Object

getFirst

public Term getFirst()

Returns the first term stored in this CoOccurrence

Returns:

The term that is lexically smaller of the inputed terms.

getSecond

public Term getSecond()

Returns the second term stored in this CoOccurrence

Returns:

The term that is lexically larger of the inputed terms.

getFrequency

public java.lang.Double getFrequency()

Returns the frequency with which the two terms stored, co-occur.

Returns:

Frequency of co-occurrence of first and second

hashCode

public int hashCode()

Returns the hash value of first + " " + second

Overrides:

hashCode in class java.lang.Object

incrementFrequency

public void incrementFrequency()

Increases the frequency of this CoOccurrence with one.

setFrequency

public void setFrequency(java.lang.Double newFrequency)

Changes the frequency of this CoOccurrence to any arbitrary double.

Parameters:

newFrequency - the new value to be used

toString

public java.lang.String toString()

Returns a string representation of the terms in the object separated with a space, followed by the frequency

Overrides:

toString in class java.lang.Object

Returns:

The string representation of first + " " + second + " " + frequency

setSecond

public void setSecond(java.lang.String new_string)

setFirst

public void setFirst(java.lang.String new_string)