com.lf.digester.docking

Class DigestFileSet

java.lang.Object

com.lf.digester.docking.DigestFileSet

public class DigestFileSet
extends java.lang.Object

Methods to manage sets of digest files like GNU/BSD or Digester XML for a given set of targets.

Since:

1.6

Version:

$Revision: 1.29 $, $Date: 2015/01/08 09:03:42 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected com.lf.commons.task.BackgroundTask	bgTask The background task (optional).
protected com.lf.commons.lang.OrderedHashtable<java.io.File,java.util.Vector<DigestResult>>	cacheAllDigests Remembers all imported digest files (key: digest file, value: digests inside).
protected com.lf.commons.lang.OrderedHashtable<java.io.File,java.util.Vector<DigestResult>>	cacheBestDigests Remembers the best digests per target (key: target file, value: digests, one per algorithm).
protected com.lf.commons.lang.OrderedHashtable<java.io.File,FileResult>	cacheFileResults Remembers the statistics per digest file (key: digest file, value: digest file data).
protected int[]	filetypes The digest files to look for FileResult.TYPE_GNU_SINGLE, ...
protected boolean	verbose Verbose messages?

Constructor Summary

Constructors

Constructor and Description
DigestFileSet() Constructor method for i18n purposes only.
DigestFileSet(java.util.Vector<java.io.File> directories, boolean subdirs, int[] filetypes, boolean verbose, com.lf.commons.config.Configuration checkoptions, java.util.Vector<com.lf.commons.io.SuffixFilter> filters, com.lf.commons.task.BackgroundTask bgtask, java.lang.String comment) Constructor method.

Method Summary

Methods

Modifier and Type	Method and Description
protected static boolean	checkXMLEntrySize(DigestResult result) Target file size matches XML entry file size?
protected static boolean	checkXMLEntryTimestamp(DigestResult result) Target file timestamp matches XML entry timestamp?
void	debugPrint() Prints the caches currently managed by this object.
protected void	finalize() Clean-up method to help the gc.
java.util.Vector<java.io.File>	findBestDigests(java.util.Vector<java.io.File> targets, java.util.Vector<java.lang.String> algos, boolean gnubsdtimestamp, boolean pgptimestamp, boolean xmltimestamp, boolean xmlentrysize, boolean xmlentrytimestamp, boolean expectintermediates, boolean ignoremissing, boolean pgpsigs) Determines the best matching digests for the target files from the caches.
java.util.Vector<DigestResult>	getAllDigests(java.io.File digestfile) Provides the digests from a certain digest file.
int	getBestDigestCount() Provides the number of best-matching digests in cache.
java.util.Vector<DigestResult>	getBestDigests() Provides the best-matching digests in cache.
java.util.Vector<DigestResult>	getBestDigests(java.io.File file) Provides the best-matching digests in cache.
java.util.Vector<java.io.File>	getBestDigestTargets() Provides the target files for the best-matching digests in cache.
int	getDigestCount(java.util.Vector<java.io.File> digestfiles) Provides the number of digests in cache (without intermediates).
java.util.Vector<java.io.File>	getDigestFiles(java.io.File target) Collects the relevant digest files for the given target.
java.util.Vector<java.io.File>	getDigestFiles(int filetype) Collects the digest files of the given type in the internal cache.
long	getXMLEntrySize(java.io.File file) Provides the file size from the XML document.
long	getXMLEntryTimestamp(java.io.File file) Provides the file timestamp from the XML document.
java.util.Vector<java.io.File>	removeArtifacts() Removes the digest files where all digests have no target.
java.util.Vector<java.io.File>	removeOtherFormats(int[] filetypes) Removes the digest files in other formats.
void	removeTarget(java.io.File target) Removes the results for the given ignored target.

Methods inherited from class java.lang.Object

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

Field Detail

filetypes

protected int[] filetypes

The digest files to look for FileResult.TYPE_GNU_SINGLE, ...

verbose

protected boolean verbose

Verbose messages?

bgTask

protected com.lf.commons.task.BackgroundTask bgTask

The background task (optional).

cacheAllDigests

protected com.lf.commons.lang.OrderedHashtable<java.io.File,java.util.Vector<DigestResult>> cacheAllDigests

Remembers all imported digest files (key: digest file, value: digests inside).

cacheFileResults

protected com.lf.commons.lang.OrderedHashtable<java.io.File,FileResult> cacheFileResults

Remembers the statistics per digest file (key: digest file, value: digest file data).

cacheBestDigests

protected com.lf.commons.lang.OrderedHashtable<java.io.File,java.util.Vector<DigestResult>> cacheBestDigests

Remembers the best digests per target (key: target file, value: digests, one per algorithm).

Constructor Detail

DigestFileSet

public DigestFileSet()
              throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

DigestFileSet

public DigestFileSet(java.util.Vector<java.io.File> directories,
             boolean subdirs,
             int[] filetypes,
             boolean verbose,
             com.lf.commons.config.Configuration checkoptions,
             java.util.Vector<com.lf.commons.io.SuffixFilter> filters,
             com.lf.commons.task.BackgroundTask bgtask,
             java.lang.String comment)
              throws java.lang.InterruptedException

Constructor method.

Parameters:

directories - The directories to be scanned for digest files

subdirs - Include sub-directories?

filetypes - The digest files to look for FileResult.TYPE_GNU_SINGLE, ...

verbose - Verbose messages?

checkoptions - The values from CheckOptionsWindow

filters - The suffix filters

bgtask - The background task (optional)

comment - The default comment

Throws:

java.lang.InterruptedException - If task has been cancelled

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - Error indication

Since:

1.6

findBestDigests

public java.util.Vector<java.io.File> findBestDigests(java.util.Vector<java.io.File> targets,
                                             java.util.Vector<java.lang.String> algos,
                                             boolean gnubsdtimestamp,
                                             boolean pgptimestamp,
                                             boolean xmltimestamp,
                                             boolean xmlentrysize,
                                             boolean xmlentrytimestamp,
                                             boolean expectintermediates,
                                             boolean ignoremissing,
                                             boolean pgpsigs)

Determines the best matching digests for the target files from the caches.

Parameters:

targets - The base set of target files

algos - The algorithms to search for

gnubsdtimestamp - Match condition

pgptimestamp - Match condition

xmltimestamp - Match condition

xmlentrysize - Match condition

xmlentrytimestamp - Match condition

expectintermediates - Intermediates expected?

ignoremissing - Ignore missing intermediates?

pgpsigs - PGP signatures?

Returns:

Container with target files with existing (valid) digests

Since:

1.6

checkXMLEntrySize

protected static boolean checkXMLEntrySize(DigestResult result)

Target file size matches XML entry file size?

Parameters:

result - The result to check

Returns:

Does it match?

Since:

1.6

checkXMLEntryTimestamp

protected static boolean checkXMLEntryTimestamp(DigestResult result)

Target file timestamp matches XML entry timestamp?

Parameters:

result - The result to check

Returns:

Does it match?

Since:

1.6

getXMLEntrySize

public long getXMLEntrySize(java.io.File file)

Provides the file size from the XML document.

Parameters:

file - The target file to check

Returns:

XML entry size, -1 if not available (e.g. GNU/BSD), -2 = different values

Since:

1.6

getXMLEntryTimestamp

public long getXMLEntryTimestamp(java.io.File file)

Provides the file timestamp from the XML document.

Parameters:

file - The target file to check

Returns:

XML entry timestamp, -1 if not available (e.g. GNU/BSD), -2 = different values

Since:

1.6

getBestDigestCount

public int getBestDigestCount()

Provides the number of best-matching digests in cache.

Returns:

Digest count

Since:

1.6

getDigestCount

public int getDigestCount(java.util.Vector<java.io.File> digestfiles)

Provides the number of digests in cache (without intermediates).

Parameters:

digestfiles - The cache

Returns:

Digest count

Since:

1.6

getBestDigests

public java.util.Vector<DigestResult> getBestDigests()

Provides the best-matching digests in cache.

Returns:

Best digests, may be empty

Since:

1.6

getBestDigests

public java.util.Vector<DigestResult> getBestDigests(java.io.File file)

Provides the best-matching digests in cache.

Parameters:

file - The desired file

Returns:

Best digests, may be empty

Since:

1.6

getBestDigestTargets

public java.util.Vector<java.io.File> getBestDigestTargets()

Provides the target files for the best-matching digests in cache.

Returns:

Best digest targets, may be empty

Since:

1.6

removeOtherFormats

public java.util.Vector<java.io.File> removeOtherFormats(int[] filetypes)

Removes the digest files in other formats.

Parameters:

filetypes - The desired types FileResult.TYPE_GNU_SINGLE, ...

Returns:

Removed digest files, may be empty

Since:

1.6

removeArtifacts

public java.util.Vector<java.io.File> removeArtifacts()

Removes the digest files where all digests have no target.

Returns:

Removed digest files, may be empty

Since:

1.6

debugPrint

public void debugPrint()

Prints the caches currently managed by this object.

Since:

1.6

getDigestFiles

public java.util.Vector<java.io.File> getDigestFiles(int filetype)

Collects the digest files of the given type in the internal cache.

Parameters:

filetype - The desired type FileResult.TYPE_GNU_SINGLE, ...

Returns:

The digest files, may be empty

Since:

1.6

getDigestFiles

public java.util.Vector<java.io.File> getDigestFiles(java.io.File target)

Collects the relevant digest files for the given target.

Parameters:

target - The target file

Returns:

The digest files, may be empty

Since:

1.6

getAllDigests

public java.util.Vector<DigestResult> getAllDigests(java.io.File digestfile)

Provides the digests from a certain digest file.

Parameters:

digestfile - The digest file

Returns:

The digests inside, null otherwise

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

removeTarget

public void removeTarget(java.io.File target)

Removes the results for the given ignored target.

Parameters:

target - The ignored target

Since:

1.6