alma.acs.util.stringqueue

Class TimestampedStringQueueFileHandler

java.lang.Object

alma.acs.util.stringqueue.TimestampedStringQueueFileHandler

Direct Known Subclasses:

DefaultQueueFileHandlerImpl, QueueFileHandler

public abstract class TimestampedStringQueueFileHandler
extends java.lang.Object

The file handler invoked by the queue

Since:

2014.6

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PREFIX The default prefix for each file of the cache
static long	DEFAULT_SIZE The default max size for each file of the cache.
long	maxFilesSize The max length of each file of the cache
static java.lang.String	MAXSIZE_PROPERTY_NAME The name of the property with the size of the file
java.lang.String	prefix The prefix to prepend to the name of each file of the cache

Constructor Summary

Constructors

Constructor and Description
TimestampedStringQueueFileHandler() Constructor with the default max length and prefix of the files.
TimestampedStringQueueFileHandler(long maxLength) Constructor with the prefix of the files.
TimestampedStringQueueFileHandler(long maxLength, java.lang.String prefix) Constructor.
TimestampedStringQueueFileHandler(java.lang.String prefix) Constructor with the default max length of the files.

Method Summary

Modifier and Type	Method and Description
abstract void	fileProcessed(java.io.File filePointer, java.lang.String minTime, java.lang.String maxTime) This method is invoked when all the strings in the passed file have been processed by the queue i.e.
long	getMaxFileSize() Return the maximum size of each file of the cache.
abstract java.io.File	getNewFile() Create and return a new file for reading and writing.
java.lang.String	getPrefix() Return the prefix of each file of the cache.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIZE

public static final long DEFAULT_SIZE

The default max size for each file of the cache. The default value is used when the java property is not found and the size is not given explicitly. NFS could be limited to 2GB depending on the installed version

See Also:

Constant Field Values

MAXSIZE_PROPERTY_NAME

public static final java.lang.String MAXSIZE_PROPERTY_NAME

The name of the property with the size of the file

See Also:

Constant Field Values

DEFAULT_PREFIX

public static final java.lang.String DEFAULT_PREFIX

The default prefix for each file of the cache

See Also:

Constant Field Values

maxFilesSize

public final long maxFilesSize

The max length of each file of the cache

prefix

public final java.lang.String prefix

The prefix to prepend to the name of each file of the cache

Constructor Detail

TimestampedStringQueueFileHandler

public TimestampedStringQueueFileHandler()

Constructor with the default max length and prefix of the files.
If a property with name MAXSIZE_PROPERTY_NAME exists then the max length is taken from the passed value other wise it is DEFAULT_SIZE

See Also:

StringQueueFileHandler

TimestampedStringQueueFileHandler

public TimestampedStringQueueFileHandler(java.lang.String prefix)

Constructor with the default max length of the files.
If a property with name MAXSIZE_PROPERTY_NAME exists then the max length is taken from the passed value other wise it is DEFAULT_SIZE

Parameters:

prefix - The prefix of the name of the cache files

See Also:

StringQueueFileHandler

TimestampedStringQueueFileHandler

public TimestampedStringQueueFileHandler(long maxLength)

Constructor with the prefix of the files.

Parameters:

maxLength - The max length of each file of the cache

See Also:

StringQueueFileHandler

TimestampedStringQueueFileHandler

public TimestampedStringQueueFileHandler(long maxLength,
                                         java.lang.String prefix)

Constructor.

Parameters:

maxLength - The max length of each file of the cache

prefix - The prefix of the name of the cache files

See Also:

StringQueueFileHandler

Method Detail

getNewFile

public abstract java.io.File getNewFile()
                                 throws java.io.IOException

Create and return a new file for reading and writing.

The created file will be used to store strings and accessed randomly by the engine. Note: implementors of this method should ensure tha the file is deleted for example setting deleteOnExit().

Returns:

the newly created file

Throws:

java.io.IOException - In case of error creating the file

fileProcessed

public abstract void fileProcessed(java.io.File filePointer,
                                   java.lang.String minTime,
                                   java.lang.String maxTime)

This method is invoked when all the strings in the passed file have been processed by the queue i.e. queue is empty and the file can be deleted.

Note: implementors of this method shall ensure that the file is deleted.

The dates are represented as strings in ISO format.

Parameters:

filePointer - The file to be released

minTime - The min timestamp of the strings in cache (null if the file is empty)

maxTime - The max timestamp of the strings in cache (null if the file is empty)

getMaxFileSize

public final long getMaxFileSize()

Return the maximum size of each file of the cache.

Returns:

The maximum size of each file of the cache

getPrefix

public final java.lang.String getPrefix()

Return the prefix of each file of the cache.

Returns:

The prefix of each file of the cache