cat.lump.ir.retrievalmodels.similarity

Class SimilarityCalculator

java.lang.Object

cat.lump.ir.retrievalmodels.similarity.SimilarityCalculator

Direct Known Subclasses:

SimilarityCalculatorLenFact

public class SimilarityCalculator
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Model	model Model of similarity
protected int	nGrams N value for the n-grams
protected Article	source Article in source language
protected Article	target Article in target language
protected RepresentationType	type Type of text representation

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimilarityCalculator(java.lang.String srcLang, java.lang.String trgLang, RepresentationType type, Model simModel) Creates a similarity calculator with the given arguments and n=1 for the n-grams methods.
	SimilarityCalculator(java.lang.String srcLang, java.lang.String trgLang, RepresentationType type, Model simModel, int nGrams) Creates a similarity calculator with the given arguments.

Method Summary

Methods

Modifier and Type	Method and Description
SimilarityMatrix	calculate(java.io.File src, java.io.File trg) Calculates the matrix of similarities for the given files.
protected void	calculateInvIndex() Generate the inverted index of the articles
protected SimilarityMatrix	calculateSimilarityMatrix() Calculates the resulting matrix
protected void	createRepresentations() Creates the representations of the source text and the target text
static SimilarityCalculator	getInstance(java.lang.String src, java.lang.String trg, Similarity method) Returns the suitable calculator according to the given similarity method.
static SimilarityCalculator	getInstance(java.lang.String src, java.lang.String trg, Similarity method, int nGrams) Returns the suitable calculator according to the given similarity method.
Model	getModel()
int	getnGrams()
Article	getSource()
Article	getTarget()
RepresentationType	getType()
void	setModel(Model model)
void	setnGrams(int nGrams)
void	setSource(Article source)
void	setTarget(Article target)
void	setType(RepresentationType type)

Methods inherited from class java.lang.Object

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

Field Detail

source

protected Article source

Article in source language

target

protected Article target

Article in target language

nGrams

protected int nGrams

N value for the n-grams

type

protected RepresentationType type

Type of text representation

model

protected Model model

Model of similarity

Constructor Detail

SimilarityCalculator

protected SimilarityCalculator(java.lang.String srcLang,
                    java.lang.String trgLang,
                    RepresentationType type,
                    Model simModel)

Creates a similarity calculator with the given arguments and n=1 for the n-grams methods.

Parameters:

srcLang - Source language

trgLang - Target language

type - Type of representation needed by the calculator

simModel - Type of similarity model needed by the calculator.

SimilarityCalculator

public SimilarityCalculator(java.lang.String srcLang,
                    java.lang.String trgLang,
                    RepresentationType type,
                    Model simModel,
                    int nGrams)

Creates a similarity calculator with the given arguments.

Parameters:

srcLang - Source language

trgLang - Target language

type - Type of representation needed by the calculator

simModel - Type of similarity model needed by the calculator.

nGrams - The value of N for the representations which uses n-grams

Method Detail

getInstance

public static SimilarityCalculator getInstance(java.lang.String src,
                               java.lang.String trg,
                               Similarity method)

Returns the suitable calculator according to the given similarity method. In case that the desired method uses n-grams, the value of N will be 1.

Parameters:

method - The desired method.

Returns:

The full implemented calculator which is able to calculate the desired method.

getInstance

public static SimilarityCalculator getInstance(java.lang.String src,
                               java.lang.String trg,
                               Similarity method,
                               int nGrams)

Returns the suitable calculator according to the given similarity method. In case that the desired method uses n-grams, the value of N will be the indicated by nGrams.

Parameters:

method - The desired method.

nGrams - The value of n for the n-grams, if it's needed.

Returns:

The full implemented calculator which is able to calculate the desired method. A null object is retourned if the method is unknown.

calculate

public SimilarityMatrix calculate(java.io.File src,
                         java.io.File trg)
                           throws java.io.IOException

Calculates the matrix of similarities for the given files.

Parameters:

src - File which contains the source article

trg - File which contains the target article

Returns:

The matrix of similarities

Throws:

java.io.IOException

createRepresentations

protected void createRepresentations()

Creates the representations of the source text and the target text

Parameters:

src - Source text.

trg - Target text

calculateInvIndex

protected void calculateInvIndex()

Generate the inverted index of the articles

calculateSimilarityMatrix

protected SimilarityMatrix calculateSimilarityMatrix()

Calculates the resulting matrix

Returns:

The matrix with the similarities. A null matrix is retourned if the model is unknown

setSource

public void setSource(Article source)

Parameters:

source - Article of the source language

setTarget

public void setTarget(Article target)

Parameters:

target - Article of the target language

setnGrams

public void setnGrams(int nGrams)

Parameters:

nGrams - The N value when a representation uses n-grams

setType

public void setType(RepresentationType type)

Parameters:

type - The type of representation of the text that can be performed.

setModel

public void setModel(Model model)

Parameters:

model - The new model of similarity which is able to calculate

getSource

public Article getSource()

Returns:

Article of the source language

getTarget

public Article getTarget()

Returns:

Article of the target language

getnGrams

public int getnGrams()

Returns:

The N value when a representation uses n-grams

getType

public RepresentationType getType()

Returns:

The type of representation of the text that can be performed.

getModel

public Model getModel()

Returns:

The model of similarity which is able to calculate