it.unimi.dico.islab.idbs2.cloud

Class KeywordRelevance

java.lang.Object

it.unimi.dico.islab.idbs2.cloud.KeywordRelevance

All Implemented Interfaces:

Comparable<KeywordRelevance>

public class KeywordRelevance
extends Object
implements Comparable<KeywordRelevance>

Representation of an essential's keyword with associated relevance. See essential concept in it.unimi.dico.islab.db.cloud package for more details.

Author:

Vegeziel

See Also:

CloudNode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeywordRelevance(CloudNode node, Integer keywordId, String value, Double relevance) Direct use of this constructor is discouraged.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(KeywordRelevance o) Implementation of a comparison value between two EsTerm objects considering the relevance of the terms.
boolean	equals(Object obj) Evaluates the equality between the current object and the one passed as argument.
Integer	getId() Get current essential-term identifier (database purposes only)
String	getKeyword() Get current term string representation (real term value)
Integer	getKeywordId() Get current term identifier (an EsTerm is actually an association between a Term and a CloudNode).
protected CloudNode	getNode() Get the owner CloudNode.
Double	getRelevance() Get current term relevance.
Integer	getTermId() Deprecated.
String	getTermValue() Deprecated.
int	hashCode() Returns the hashCode of the contained termValue.
void	setKeyword(String keywordValue) Set current term string representation (real term value).
protected void	setKeywordId(Integer keywordId) Set current term identifier.
protected void	setNode(CloudNode node) Set the identifier of the owner node.
void	setRelevance(Double relevance) Set current term relevance.
protected void	setTermId(Integer termId) Deprecated.
void	setTermValue(String termValue) Deprecated.
String	toString() Creates a simple string visualization for the current EsTerm using the following pattern: termValue(termRelevance)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KeywordRelevance

protected KeywordRelevance(CloudNode node,
                Integer keywordId,
                String value,
                Double relevance)

Direct use of this constructor is discouraged. Use the CloudNode.addEsTerm method instead.

Parameters:

node - the owner cluster of this term.

keywordId - the identifier of the corresponding KC database term(an EsTerm is actually an association between a Term and a CloudNode).

value - the String value of this term.

relevance - the relevance value associated with this term.

See Also:

CloudNode.addEsTerm(Integer, String, Double)

Method Detail

getKeywordId

public Integer getKeywordId()

Get current term identifier (an EsTerm is actually an association between a Term and a CloudNode).

Returns:

the id of the associated Term

See Also:

Term

getTermId

@Deprecated
public Integer getTermId()

Deprecated.

Substituted by method getKeywordId().

setKeywordId

protected void setKeywordId(Integer keywordId)

Set current term identifier. To be set using the constructor (direct use is discouraged).

setTermId

@Deprecated
protected void setTermId(Integer termId)

Deprecated.

Substituted by method setKeywordId(Integer).

getKeyword

public String getKeyword()

Get current term string representation (real term value)

Returns:

the string value of this term

getTermValue

@Deprecated
public String getTermValue()

Deprecated.

Substituted by method getKeyword().

setKeyword

public void setKeyword(String keywordValue)

Set current term string representation (real term value). To be set using the constructor, direct usage is discouraged.

Parameters:

keywordValue -

setTermValue

@Deprecated
public void setTermValue(String termValue)

Deprecated.

Substituted by method setKeyword(String).

getRelevance

public Double getRelevance()

Get current term relevance.

Returns:

current term relevance value.

setRelevance

public void setRelevance(Double relevance)

Set current term relevance.

Parameters:

relevance - current term relevance value.

getId

public Integer getId()

Get current essential-term identifier (database purposes only)

Returns:

current esTerm identifier.

getNode

protected CloudNode getNode()

Get the owner CloudNode.

Returns:

the owner CloudNode.

setNode

protected void setNode(CloudNode node)

Set the identifier of the owner node.

equals

public boolean equals(Object obj)

Evaluates the equality between the current object and the one passed as argument.

Overrides:

equals in class Object

Returns:

• true if the given object is instance of EsTerm class and this termValue is equal to the given object's term value.
• false otherwise

hashCode

public int hashCode()

Returns the hashCode of the contained termValue.

Overrides:

hashCode in class Object

Returns:

a call to the hashCode method of the String termValue.

compareTo

public int compareTo(KeywordRelevance o)

Implementation of a comparison value between two EsTerm objects considering the relevance of the terms.

Specified by:

compareTo in interface Comparable<KeywordRelevance>

Returns:

the difference between the two EsTerm relevances or, if this difference is 0, the comparison between the two termValue.

toString

public String toString()

Creates a simple string visualization for the current EsTerm using the following pattern: termValue(termRelevance)

Overrides:

toString in class Object

Returns:

a string representation for the current EsTerm.