alma::acs::logging::archive::zoom::FileHelper Class Reference

Inheritance diagram for alma::acs::logging::archive::zoom::FileHelper:

Collaboration diagram for alma::acs::logging::archive::zoom::FileHelper:

Public Member Functions
	FileHelper (File inFile, long start, long end, LogTypeHelper lowLvl, LogTypeHelper hiLvl) throws ZoomException
boolean	loadLogs (ACSRemoteLogListener logListener, IOPorgressListener ioListener, ACSRemoteErrorListener errorListener) throws ZoomException, FileNotFoundException
void	errorReceived (String xml)
void	stopLoading ()
Public Attributes
final LogTypeHelper	minLogLevel
final LogTypeHelper	maxLogLevel
final long	startTime
final long	endTime
Private Member Functions
FiltersVector	setupFilters () throws ZoomException
Private Attributes
final File	inputFile
IOHelper	ioHelper
boolean	errorParsingLogs = false
ACSRemoteErrorListener	externalErrorListener = null

Detailed Description

An helper glass to get logs from a file..

The class read a file with the help of IOHelper and adds a filter for the start and end dates and another one for the levels.

Author:: acaproni

Constructor & Destructor Documentation

alma::acs::logging::archive::zoom::FileHelper::FileHelper	(	File	inFile,
		long	start,
		long	end,
		LogTypeHelper	lowLvl,
		LogTypeHelper	hiLvl
	)			throws ZoomException `[inline]`

Constructor

Parameters:

	inFile	The file to read logs from
	start	The start time (>=0)
	end	The ending time
	lowlvl	The lowest log level to read (inclusive)
	hiLvl	The highest level to read (inclusive)

Exceptions:

IOException

If the file is unreadable

References endTime, inputFile, maxLogLevel, minLogLevel, and startTime.

Member Function Documentation

void alma::acs::logging::archive::zoom::FileHelper::errorReceived ( String xml ) [inline]

See also:: com.cosylab.logging.engine.ACS.ACSRemoteErrorListener::errorReceived(java.lang.String)

Implements com::cosylab::logging::engine::ACS::ACSRemoteErrorListener.

References errorParsingLogs, com::cosylab::logging::engine::ACS::ACSRemoteErrorListener::errorReceived(), and externalErrorListener.

boolean alma::acs::logging::archive::zoom::FileHelper::loadLogs	(	ACSRemoteLogListener	logListener,
		IOPorgressListener	ioListener,
		ACSRemoteErrorListener	errorListener
	)			throws ZoomException, FileNotFoundException `[inline]`

Load the logs for the file.

This method return errors in two ways:

with an exception when the error arise while setting up the file and the filters for loading while reading the file
returning false in case of errors parsing logs read from file

The error listener passed as parameter can be null. In fact the error listener gets the strings of the logs that returned an error while parsing. If the caller is not interested in those strings but only to know if there were parsing errors then it will be enough for the caller to check the value of the returned boolean.

Parameters:

	logListener	The listener of the logs read from the file
	ioListener	The listener for the progress of loading
	errorListener	The listener of errors parsing logs (can'be `null`)