cat.lump.ir.retrievalmodels.similarity

Class Article

java.lang.Object

cat.lump.ir.retrievalmodels.similarity.Article

public class Article
extends java.lang.Object

An article object is the abstraction of a document to translate whith its related information.
The related information is:

• Language in which the article is written.
• Type of data representation that must be used.

Moreover, it provides functions to represent its data and calculate the magnitudes to use later by the similarity calculator.

Author:

jboldoba

See Also:

RepresentationType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.Integer,java.lang.Double>	text_magnitudes Map with the article's text magnitudes

Constructor Summary

Constructors

Constructor and Description
Article(java.lang.String language, RepresentationType type) Creates an undefined article together with its language and type of representation.
Article(java.lang.String text, java.lang.String language) Creates an article with text and language.
Article(java.lang.String text, java.lang.String language, RepresentationType type) Creates an article with text, language and type of representation.

Method Summary

Methods

Modifier and Type	Method and Description
void	generateInvIndex() Loads the inverted index from the text as well as the corresponding magnitudes
int	getFragmentSize(int a)
InvIndexContainer	getInvIndex()
java.util.Locale	getLanguage()
java.lang.Double	getMagnitude(int index) The magnitude of the given sentence
Document	getRepresentation()
java.lang.String[]	getText()
java.util.Map<java.lang.String,java.lang.Double>	getTokenValues(java.lang.String token)
java.util.Set<java.lang.String>	getVocabulary()
int	length()
void	representText(int nGrams) Represents the article text according to the type of representation assigned.
void	setInvIndex(InvIndexContainer invIndex)
void	setLanguage(java.util.Locale language)
void	setRepresentation(Document representation)
void	setText(java.lang.String text)

Methods inherited from class java.lang.Object

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

Field Detail

text_magnitudes

protected java.util.Map<java.lang.Integer,java.lang.Double> text_magnitudes

Map with the article's text magnitudes

Constructor Detail

Article

public Article(java.lang.String language,
       RepresentationType type)

Creates an undefined article together with its language and type of representation.

Parameters:

language - Language of the article

type - Type of representation

Article

public Article(java.lang.String text,
       java.lang.String language)

Creates an article with text and language.

Parameters:

text - Text of the article

language - Language of the article

Article

public Article(java.lang.String text,
       java.lang.String language,
       RepresentationType type)

Creates an article with text, language and type of representation.

Parameters:

text - Text of the article

language - Language of the article

type - Type of representation

Method Detail

representText

public void representText(int nGrams)

Represents the article text according to the type of representation assigned.

generateInvIndex

public void generateInvIndex()

Loads the inverted index from the text as well as the corresponding magnitudes

setText

public void setText(java.lang.String text)

Parameters:

text - the text to set

setLanguage

public void setLanguage(java.util.Locale language)

Parameters:

language - the language to set

setRepresentation

public void setRepresentation(Document representation)

Parameters:

representation - the type of data representation to set

setInvIndex

public void setInvIndex(InvIndexContainer invIndex)

Parameters:

invIndex - the inverted index container to set

getText

public java.lang.String[] getText()

Returns:

the text

getLanguage

public java.util.Locale getLanguage()

Returns:

the language

getRepresentation

public Document getRepresentation()

Returns:

the representation

getFragmentSize

public int getFragmentSize(int a)

getInvIndex

public InvIndexContainer getInvIndex()

Returns:

the inverted index container

length

public int length()

Returns:

The number of fragments in the document.

getVocabulary

public java.util.Set<java.lang.String> getVocabulary()

Returns:

the vocabulary in this article

getTokenValues

public java.util.Map<java.lang.String,java.lang.Double> getTokenValues(java.lang.String token)

Parameters:

token -

Returns:

The values related to the given token

getMagnitude

public java.lang.Double getMagnitude(int index)

The magnitude of the given sentence

Parameters:

index -

Returns:

the magnitude of a sentence