alma.acs.util.stringqueue

Class DefaultXmlQueueFileHandlerImpl

java.lang.Object

alma.acs.util.stringqueue.TimestampedStringQueueFileHandler

alma.acs.util.stringqueue.DefaultQueueFileHandlerImpl

alma.acs.util.stringqueue.DefaultXmlQueueFileHandlerImpl

public class DefaultXmlQueueFileHandlerImpl
extends DefaultQueueFileHandlerImpl

A specialized class of DefaultQueueFileHandlerImpl to be used to store XML strings in the file of the queue by appending the XML header and footer at the beginning and at the end of each file of the cache. The constructor allow the set the TAG of the items contained in the files.
Objects of this class delegate to DefaultQueueFileHandlerImpl but for the getNewFile() and fileProcessed(java.io.File, String, String). The former writes the XML header at the beginning of the file before returning the fiole to the caller. The latter append the XML footer at the end of the file.

Since:

2014.6

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	standardXmlHdr Standard XML header
static java.lang.String	xmlHeader The header for XML

Fields inherited from class alma.acs.util.stringqueue.TimestampedStringQueueFileHandler

DEFAULT_PREFIX, DEFAULT_SIZE, maxFilesSize, MAXSIZE_PROPERTY_NAME, prefix

Constructor Summary

Constructors

Constructor and Description
DefaultXmlQueueFileHandlerImpl(long maxFileSize, java.lang.String xmlTag)
DefaultXmlQueueFileHandlerImpl(long maxFileSize, java.lang.String prefix, java.lang.String xmlTag)
DefaultXmlQueueFileHandlerImpl(java.lang.String xmlTag) The XML tag for the items contained in the XML.
DefaultXmlQueueFileHandlerImpl(java.lang.String prefix, java.lang.String xmlTag)

Method Summary

Modifier and Type	Method and Description
void	fileProcessed(java.io.File filePointer, java.lang.String minTime, java.lang.String maxTime) Append the XML footer to the passed file before calling DefaultQueueFileHandlerImpl.fileProcessed(File, String, String)
java.io.File	getNewFile() Get the file from DefaultQueueFileHandlerImpl.getNewFile() and write the XML header at the beginning of the file before returning to the caller.

Methods inherited from class alma.acs.util.stringqueue.TimestampedStringQueueFileHandler

getMaxFileSize, getPrefix

Methods inherited from class java.lang.Object

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

Field Detail

standardXmlHdr

public static final java.lang.String standardXmlHdr

Standard XML header

See Also:

Constant Field Values

xmlHeader

public static final java.lang.String xmlHeader

The header for XML

See Also:

Constant Field Values

Constructor Detail

DefaultXmlQueueFileHandlerImpl

public DefaultXmlQueueFileHandlerImpl(java.lang.String xmlTag)

The XML tag for the items contained in the XML. THis tag encloses the items written by the queue i.e. there is one opening TAG and one closing tag in each file of the queue.

Parameters:

xmlTag - The tag of the items in each XML file of the queue

See Also:

DefaultQueueFileHandlerImpl

DefaultXmlQueueFileHandlerImpl

public DefaultXmlQueueFileHandlerImpl(long maxFileSize,
                                      java.lang.String prefix,
                                      java.lang.String xmlTag)

Parameters:

maxFileSize - The max size of the files of the cache.

prefix - The prefix of the name of the cache files

xmlTag - The tag of the items in each XML file of the queue

See Also:

DefaultQueueFileHandlerImpl

DefaultXmlQueueFileHandlerImpl

public DefaultXmlQueueFileHandlerImpl(long maxFileSize,
                                      java.lang.String xmlTag)

Parameters:

maxFileSize - The max size of the files of the cache.

xmlTag - The tag of the items in each XML file of the queue

See Also:

DefaultQueueFileHandlerImpl

DefaultXmlQueueFileHandlerImpl

public DefaultXmlQueueFileHandlerImpl(java.lang.String prefix,
                                      java.lang.String xmlTag)

Parameters:

prefix - The prefix of the name of the cache files

xmlTag - The tag of the items in each XML file of the queue

See Also:

DefaultQueueFileHandlerImpl

Method Detail

fileProcessed

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

Append the XML footer to the passed file before calling DefaultQueueFileHandlerImpl.fileProcessed(File, String, String)

Overrides:

fileProcessed in class DefaultQueueFileHandlerImpl

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)

See Also:

alma.acs.util.stringqueue.IStringQueueFileHandler#fileProcessed(java.io.File, java.lang.String, java.lang.String)

getNewFile

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

Get the file from DefaultQueueFileHandlerImpl.getNewFile() and write the XML header at the beginning of the file before returning to the caller.

Overrides:

getNewFile in class DefaultQueueFileHandlerImpl

Returns:

the newly created file

Throws:

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

See Also:

DefaultQueueFileHandlerImpl#getNewFile()}