cat.lump.ir.comparison.toCheck

Class SimilarityPair

java.lang.Object

cat.lump.ir.comparison.toCheck.SimilarityPair

All Implemented Interfaces:

java.lang.Comparable<SimilarityPair>

public class SimilarityPair
extends java.lang.Object
implements java.lang.Comparable<SimilarityPair>

A similarity pair contains the pairs which define the input data for the similarity calculators.
Each pair is composed by the ID as left element and the file with the article as right element. They are implemented with the ImmutablePair class from Apache Commons.

Author:

jboldoba

See Also:

org.apache.commons.lang3.tuple.ImmutablePair

Constructor Summary

Constructors

Constructor and Description
SimilarityPair(int srcID, java.io.File src, int trgID, java.io.File trg)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(SimilarityPair sp)
	getSource()
	getTarget()
void	setSource( source)
void	setTarget( target)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimilarityPair

public SimilarityPair(int srcID,
              java.io.File src,
              int trgID,
              java.io.File trg)

Method Detail

getSource

public  getSource()

Returns:

the pair which defines the sourcearticle

getTarget

public  getTarget()

Returns:

the pair which defines the target article

setSource

public void setSource( source)

Parameters:

source - the new pair which defines the source article

setTarget

public void setTarget( target)

Parameters:

target - the new pair which defines the target article

compareTo

public int compareTo(SimilarityPair sp)

Specified by:

compareTo in interface java.lang.Comparable<SimilarityPair>