org.egothor.duplicity.file

Class SimilarUnitPairsFile

java.lang.Object

org.egothor.duplicity.file.DuplicityCheckingFile

org.egothor.duplicity.file.CommonSimilarUnitPairsFile

org.egothor.duplicity.file.MergeableSimilarUnitPairsFile

org.egothor.duplicity.file.SimilarUnitPairsFile

public class SimilarUnitPairsFile
extends MergeableSimilarUnitPairsFile

Represents the "similar unit pairs" file used in duplicity checking algorithm. The file contains instances of UnitPair class. That means it contains pairs {first, second}, where first, second are identificators of units on which we check duplicity (can be document, paragraph or sentence). The file is sorted - the main criteria is first field, in case of tie second field.

The file should be used as follows.

1. First it should be created using SimilarUnitPairsFileProducer or read from the filesystem.
2. It can be merged with another file corresponding to the same permutation by a call to merge(org.egothor.duplicity.file.SimilarUnitPairsFile, org.egothor.duplicity.file.SimilarUnitPairsTempFile) method.

Author:

Kateřina Dufková

Constructor Summary

Constructors

Constructor and Description
SimilarUnitPairsFile(long permID, String location) Initialializes the file already written to filesystem.

Method Summary

Modifier and Type	Method and Description
String	getFilename() Returns the filename corresponding to this file.
void	merge(CommonSimilarUnitPairsFile supf) Merges two files externally, on filesystem.
void	merge(SimilarUnitPairsFile supfr, SimilarUnitPairsTempFile supft) Merges three files externally, on filesystem.

Methods inherited from class org.egothor.duplicity.file.CommonSimilarUnitPairsFile

dump, getPermID, hasTheSameContent, remove, toString

Methods inherited from class org.egothor.duplicity.file.DuplicityCheckingFile

delete, getLocation, getOut, hasTheSameContent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimilarUnitPairsFile

public SimilarUnitPairsFile(long permID,
                            String location)
                     throws FileNotFoundException

Initialializes the file already written to filesystem. Sets permID and location field and tries to open a file on filesystem. The filename is in form returned by getFilename() and will be searched in the location directory.

Parameters:

permID - identification of the permutation to be assigned to this file

location - path and name of the directory in which the file will be searched, must end with "/" sign

Throws:

FileNotFoundException - if the file does not exist

Method Detail

merge

public void merge(SimilarUnitPairsFile supfr,
                  SimilarUnitPairsTempFile supft)
           throws IOException,
                  MergeException

Merges three files externally, on filesystem. The files must correnspond to the same permutation.

Parameters:

supfr - regular file to be merged into this (SimilarUnitPairsFile)

supft - temporary file to be merged into this (SimilarUnitPairsTempFile)

Throws:

MergeException - on attempt to merge files corresponding to different permutations or if temporary file could not be created

IOException

merge

public void merge(CommonSimilarUnitPairsFile supf)
           throws IOException,
                  MergeException

Merges two files externally, on filesystem. The files must correnspond to the same permutation.

Parameters:

supf - file to be merged into this. Can be regular (SimilarUnitPairsFile) or temporary (SimilarUnitPairsTempFile).

Throws:

MergeException - on attempt to merge files corresponding to different permutations or if temporary file could not be created

IOException

getFilename

public String getFilename()

Returns the filename corresponding to this file. The location and permID fields MUST be already set. The filename is created in directory given in location field and is in form Constants.SIMILAR_UNIT_PAIRS_FILE_PREFIX<permID>.

Specified by:

getFilename in class DuplicityCheckingFile