Term (IDBS2)

java.lang.Object
- it.unimi.dico.islab.idbs2.kc.Term

```
public class Term
extends Object
```
Representation of a keyword of a KnowledgeChunk with associated relevance and frequency. This is in fact an association between a keyword and a knowledge chunk from which the keyword has been extracted. The same keyword could appear in more than one Term instance, every time connected with different KnowledgeChunks and, possibly, different frequency and relevance.
The following image shows the relations between the fields of this object and the fields of the wrapped database table (fields with the same color represents a mapping between relational schema and the corresponding object).

Author:

Vegeziel

See Also:
KnowledgeChunk

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Term()` Only Hibernate and KnowledgeChunk are able to instantiate this object.
`protected`	`Term(KnowledgeChunk kc, String value, double relevance, Integer frequency)` Direct use of this constructor is discouraged.

Method Summary

Methods
Modifier and Type	Method and Description
`TermTransformation`	`addTransformation(String transformationName, String transformationValue)` Associate to this `Term` a related word.
`boolean`	`equals(Object obj)` Evaluate if the current `Term` is equal to the given object.
`Integer`	`getFrequency()` Getter for the `frequency` field.
`Integer`	`getId()` Getter for the identifier of this object in the linked database.
`KnowledgeChunk`	`getKc()` Getter for the `kc` field.
`Double`	`getRelevance()` Getter for the `relevance` field.
`Set<TermTransformation>`	`getTransformations()` Get all the term transformations associated with the current `Term`.
`String`	`getValue()` Getter for the keyword value.
`int`	`hashCode()` Hash code is given by the hash code of the string composed by the value of this term + the id of the owner KnowledgeChunk.
`void`	`setFrequency(Integer frequency)` Setter for the `frequency` field.
`protected void`	`setId(Integer id)` Method used by Hibernate to import database objects.
`void`	`setKc(KnowledgeChunk kc)` Setter for the `kc` field.
`void`	`setRelevance(Double relevance)` Setter for the `relevance` field.
`protected void`	`setTransformations(Set<TermTransformation> transformations)` Set the term transformations associated with the current `Term`.
`protected void`	`setValue(String termValue)` Setter for the keyword value.
`String`	`toString()` Return a string representation of this `Term`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Term
```
protected Term()
```
    Only Hibernate and KnowledgeChunk are able to instantiate this object. Direct use is discouraged.
  - Term
```
protected Term(KnowledgeChunk kc,
    String value,
    double relevance,
    Integer frequency)
```
    Direct use of this constructor is discouraged. Use KnowledgeChunk.addTerm instead.
    
    Parameters:
    kc - the belonging KnowledgeChunk
    value - the real term in string representation.
    relevance - the relevance of this keyword(term) for kc
    frequency - the frequency of this keyword(term) for kc
    See Also:
    KnowledgeChunk.addTerm(String, Double, Integer)
- Method Detail
  - hashCode
```
public int hashCode()
```
    Hash code is given by the hash code of the string composed by the value of this term + the id of the owner KnowledgeChunk.
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Evaluate if the current Term is equal to the given object. Equality is positive if and only if the given object is an instance of Term, refers to the same KnowledgeChunk (using KnowledgeChunk equality) of the current Term and contains the same string value (using String equality).
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to be compared.
    
    Returns:
    true if the current object is equal to the given object
    false otherwise
  - addTransformation
```
public TermTransformation addTransformation(String transformationName,
                                   String transformationValue)
```
    Associate to this Term a related word. Examples of possible transformations are stemming and lemmatization.
    
    Parameters:
    transformationName - The name of the transformation applied to the original term to obtain the related word.
    transformationValue - The value of the transformed word
    
    Returns:
    the TermTransformation object already associated with this Term
  - toString
```
public String toString()
```
    Return a string representation of this Term.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a string of type kc_id(term_value).
  - getValue
```
public String getValue()
```
    Getter for the keyword value.
    
    Returns:
    a string representing the keyword wrapped by this Term instance.
  - setValue
```
protected void setValue(String termValue)
```
    Setter for the keyword value.
    
    Parameters:
    termValue - a string representing the keyword wrapped by this Term instance.
  - getId
```
public Integer getId()
```
    Getter for the identifier of this object in the linked database.
    
    Returns:
    the id of the term_eq relation.
  - setId
```
protected void setId(Integer id)
```
    Method used by Hibernate to import database objects. Direct use is discouraged.
    
    Parameters:
    id -
  - getFrequency
```
public Integer getFrequency()
```
    Getter for the frequency field.
    
    Returns:
    the frequency of this term wrapper as the number of its occurrences in kc.
  - setFrequency
```
public void setFrequency(Integer frequency)
```
    Setter for the frequency field.
    
    Parameters:
    frequency - the frequency of this term wrapper as the number of its occurrences in kc.
  - getKc
```
public KnowledgeChunk getKc()
```
    Getter for the kc field.
    
    Returns:
    the kc owner of the value keyword.
  - setKc
```
public void setKc(KnowledgeChunk kc)
```
    Setter for the kc field.
    
    Parameters:
    kc - the kc owner of the value keyword.
  - setRelevance
```
public void setRelevance(Double relevance)
```
    Setter for the relevance field.
    
    Parameters:
    relevance - the relevance of the wrapped term for the kc.
  - getRelevance
```
public Double getRelevance()
```
    Getter for the relevance field.
    
    Returns:
    the relevance of the wrapped term for the kc.
  - getTransformations
```
public Set<TermTransformation> getTransformations()
```
    Get all the term transformations associated with the current Term.
    
    Returns:
    a set of all the term associated with the current Term.
  - setTransformations
```
protected void setTransformations(Set<TermTransformation> transformations)
```
    Set the term transformations associated with the current Term.
    
    Parameters:
    transformations - a set of all the term associated with the current Term.

Class Term

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Term

Term

Method Detail

hashCode

equals

addTransformation

toString

getValue

setValue

getId

setId

getFrequency

setFrequency

getKc

setKc

setRelevance

getRelevance

getTransformations

setTransformations