org.egothor.duplicity.algorithm

Class TankerImplDuplicityChecker

java.lang.Object

org.egothor.dir.Group

org.egothor.dir.Tanker

org.egothor.dir.TankerImpl

org.egothor.dir.TankerImplSecure

org.egothor.duplicity.algorithm.TankerImplDuplicityChecker

All Implemented Interfaces:

AutoCloseable, Resolver<CachedQuery,CachedResult>, Barrel, BarrelWriter

public class TankerImplDuplicityChecker
extends TankerImplSecure

This object encapsulates standard TankerImplSecure and adds duplicity checking ability.

Author:

Kateřina Dufková

Constructor Summary

Constructors

Constructor and Description
TankerImplDuplicityChecker()

Method Summary

Modifier and Type	Method and Description
void	append(BarrelReader barrelReader) Appends a reader to this tanker.
Set<DocumentUnitID>	append(BarrelReader barrelReader, boolean omitDuplicates, boolean visualizeDuplicities, boolean printDuplicitiesToCsv) Appends a reader to this tanker's duplicity checker.
void	appendOnlyToDC(BarrelReader barrelReader)
void	close() Closes this tanker.
void	commit() Commits all the changes.
HashMap<Long,Boolean>	commitWithResults() Performes a commit and returns information about the whole process.
void	destroy() Description of the Method
TankerImplSecure	getDuplicatesIndex()
String	getDuplicatesIndexDir()
String	getDuplicityCheckingMainDir()
String	getDuplicityCheckingReportDir()
String	getDuplicityCheckingTempDir()
boolean	hasDuplicityCheckingAbility()
void	initializeTankerSecure(String indexDir, DataRepository repo, boolean useBerkeleyGP, boolean MTE, int capacity, int mergeFactor, String lockServerConfigFilename, int indexConstPeriodOfTime) Initializations of the tanker.
void	initializeTankerSecure(String indexDir, DataRepository repo, boolean useBerkeleyGP, boolean MTE, int capacity, int mergeFactor, String lockServerConfigFilename, int indexConstPeriodOfTime, long seedDC) Initializations of the tanker.
boolean	isDirty() Test whether this Tanker has been modified.
boolean	removeDoc(long id) Deprecated.
void	removeDoc(long id, int revision)

Methods inherited from class org.egothor.dir.TankerImplSecure

deleted, elements, elementsSecure, expand, expandDocMetadata, expandDocMetadataSecure, forEach, getBitmap, getCWI, getIListMeta, getMeta, getRootVersionID, initializeTankerSecure, iterate, loadState, open, openIList, openIListSecure, openSecure, optimize, query, query, querySecure, querySecure, reloadIndex, setBitmap, size

Methods inherited from class org.egothor.dir.TankerImpl

initializeTanker, initializeTanker

Methods inherited from class org.egothor.dir.Group

getCache, initializeCache, initializeCache, initializeCache, initializeCache, query, resolve

Methods inherited from class java.lang.Object

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

Constructor Detail

TankerImplDuplicityChecker

public TankerImplDuplicityChecker()

Method Detail

initializeTankerSecure

public void initializeTankerSecure(String indexDir,
                                   DataRepository repo,
                                   boolean useBerkeleyGP,
                                   boolean MTE,
                                   int capacity,
                                   int mergeFactor,
                                   String lockServerConfigFilename,
                                   int indexConstPeriodOfTime)
                            throws IOException

Description copied from class: TankerImplSecure

Initializations of the tanker. Parameter lockServerConfigFilename specifies pathname to a config file for lock server. If it is null, then file locking is used. It must be in java.util.Properties format.

Overrides:

initializeTankerSecure in class TankerImplSecure

Throws:

IOException

initializeTankerSecure

public void initializeTankerSecure(String indexDir,
                                   DataRepository repo,
                                   boolean useBerkeleyGP,
                                   boolean MTE,
                                   int capacity,
                                   int mergeFactor,
                                   String lockServerConfigFilename,
                                   int indexConstPeriodOfTime,
                                   long seedDC)
                            throws IOException

Initializations of the tanker. Parameter lockServerConfigFilename specifies pathname to a config file for lock server. If it is null, then file locking is used. It must be in java.util.Properties format.

Parameters:

indexDir -

repo -

useBerkeleyGP -

MTE -

capacity -

mergeFactor -

lockServerConfigFilename -

indexConstPeriodOfTime -

seedDC - seed to be used for the duplicity checker

Throws:

IOException

append

public Set<DocumentUnitID> append(BarrelReader barrelReader,
                                  boolean omitDuplicates,
                                  boolean visualizeDuplicities,
                                  boolean printDuplicitiesToCsv)

Appends a reader to this tanker's duplicity checker.

append

public void append(BarrelReader barrelReader)

Description copied from class: TankerImplSecure

Appends a reader to this tanker.

Specified by:

append in interface BarrelWriter

Overrides:

append in class TankerImplSecure

Parameters:

barrelReader - the Barrel to add

appendOnlyToDC

public void appendOnlyToDC(BarrelReader barrelReader)

Parameters:

barrelReader -

commit

public void commit()

Description copied from class: TankerImplSecure

Commits all the changes.

Specified by:

commit in interface Barrel

Overrides:

commit in class TankerImplSecure

commitWithResults

public HashMap<Long,Boolean> commitWithResults()

Description copied from class: TankerImplSecure

Performes a commit and returns information about the whole process.

Overrides:

commitWithResults in class TankerImplSecure

Returns:

Mapping between document's uid and its commit result.

destroy

public void destroy()

Description copied from class: TankerImpl

Description of the Method

Specified by:

destroy in interface Barrel

Overrides:

destroy in class TankerImplSecure

close

public void close()

Description copied from class: TankerImplSecure

Closes this tanker.

In case of muliple thread sharing one instance of the tanker this method should be used everytime an TankerImplSecure.openSecure() method is called and synchronized by user as follows:

   synchronized (tanker) {
      try {
         tanker.openSecure();
         ...
      } finally {
         tanker.close();
      }
   }
 

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Barrel

Specified by:

close in interface BarrelWriter

Overrides:

close in class TankerImplSecure

isDirty

public boolean isDirty()

Description copied from class: Tanker

Test whether this Tanker has been modified.

Overrides:

isDirty in class TankerImplSecure

Returns:

true if it has, false otherwise

hasDuplicityCheckingAbility

public boolean hasDuplicityCheckingAbility()

Returns:

getDuplicityCheckingMainDir

public String getDuplicityCheckingMainDir()

Returns:

getDuplicityCheckingReportDir

public String getDuplicityCheckingReportDir()

Returns:

getDuplicityCheckingTempDir

public String getDuplicityCheckingTempDir()

Returns:

getDuplicatesIndexDir

public String getDuplicatesIndexDir()

Returns:

getDuplicatesIndex

public TankerImplSecure getDuplicatesIndex()

Returns:

removeDoc

@Deprecated
public boolean removeDoc(long id)

Deprecated.

Description copied from class: Group

Remove the document with the given ID and return whether the operation was successful.

Specified by:

removeDoc in interface Barrel

Overrides:

removeDoc in class TankerImplSecure

Parameters:

id - the document to remove

Returns:

true if the removal was successful, false otherwise

removeDoc

public void removeDoc(long id,
                      int revision)

Overrides:

removeDoc in class TankerImplSecure

Parameters:

id - uid of the document

revision - revision of the document