org.egothor.duplicity.algorithm

Class DuplicityChecker

java.lang.Object

org.egothor.duplicity.algorithm.DuplicityChecker

All Implemented Interfaces:

Status

public class DuplicityChecker
extends Object
implements Status

Contains top-level implementations of duplicity checking algorithm. Method createDuplicityCheckingFilesForBarrel(org.egothor.core.BarrelReader, java.lang.String) allow computing duplicity checking files for single barrel. The method mergeDuplicityCheckingFiles(java.lang.String, java.lang.String, java.util.Set<org.egothor.duplicity.datastructure.DocumentUnitID>) allows merging duplicity checking files of two barrels. The structure of the duplicity checking algorithm files on filesystem is this.

 dupliticity (directory)
     |--> temp (directory) - contains temporary files for classes
     |                SimilarUnitPairsTempFile and |
 AllSimilarUnitPairsFile |--> fdpiX files - correspond to
 PermutatedMinsFile |--> fhpiX files - correspond to
 SimilarUnitPairsFile - these files are no more computed
 

This class has a state consisting of the seed of PermutatedMinsFiller object and sign empty.

Author:

Kateřina Dufková

Constructor Summary

Constructors

Constructor and Description
DuplicityChecker()

Method Summary

Modifier and Type	Method and Description
Set<DocumentUnitID>	append(BarrelReader br, boolean omitDuplicates, boolean visualizeDuplicities, boolean printDuplicitiesToCsv)
void	close()
void	commit()
void	destroy()
String	getDuplicityCheckingMainDir()
String	getDuplicityCheckingReportDir()
String	getDuplicityCheckingTempDir()
Properties	getState(Properties p) Return the state of this object.
void	initialize(String indexMainDir, TankerImplSecure tanker)
boolean	isEmpty()
void	removeDoc(long uid, int docDBRevision)
void	setState(Properties state) Set this object with the given properties.

Methods inherited from class java.lang.Object

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

Constructor Detail

DuplicityChecker

public DuplicityChecker()

Method Detail

isEmpty

public boolean isEmpty()

Returns:

getDuplicityCheckingMainDir

public String getDuplicityCheckingMainDir()

Returns:

getDuplicityCheckingReportDir

public String getDuplicityCheckingReportDir()

Returns:

getDuplicityCheckingTempDir

public String getDuplicityCheckingTempDir()

Returns:

initialize

public void initialize(String indexMainDir,
                       TankerImplSecure tanker)
                throws IOException

Parameters:

indexMainDir -

tanker -

Throws:

IOException

commit

public void commit()

close

public void close()

getState

public Properties getState(Properties p)

Return the state of this object.

Specified by:

getState in interface Status

Parameters:

p - the properties which will be also returned for your convenience

Returns:

the properties

setState

public void setState(Properties state)

Set this object with the given properties.
WARINIG: This function should not be called from outside unless there are no documents already indexed, because changing the permutatedMinsFiller seed causes change in all minimums and the newly appended documents won't be comparable to the documents already in.

Specified by:

setState in interface Status

Parameters:

state - the properties

append

public Set<DocumentUnitID> append(BarrelReader br,
                                  boolean omitDuplicates,
                                  boolean visualizeDuplicities,
                                  boolean printDuplicitiesToCsv)
                           throws DuplicityCheckingException

Parameters:

br -

omitDuplicates -

visualizeDuplicities -

printDuplicitiesToCsv -

Returns:

null, if omitDuplicates is false

Throws:

DuplicityCheckingException

destroy

public void destroy()

removeDoc

public void removeDoc(long uid,
                      int docDBRevision)

Parameters:

uid -

docDBRevision -