alma.acs.logging.archive.zoom

Class ZoomManager

java.lang.Object

alma.acs.logging.archive.zoom.ZoomManager

public class ZoomManager
extends java.lang.Object

The manager of the zoom feature.

A ZoomManager objects is the entity that perform the zooming by delegating to other classes of the zoom package.

The min and max levels, if not passed in the constructor, are initialized from java properties and if those properties does not exist from default values.

Note: only one loading operation is possible at the same time.

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILES_LOCATION_PROPERTY_NAME The name of the property containing the folder where ARCHIVES writes files into.
static java.lang.String	MAX_LEVEL_PROPERTY_NAME The name of the property of the min log level of the zoom
static java.lang.String	MIN_LEVEL_PROPERTY_NAME The name of the property of the min log level of the zoom

Constructor Summary

Constructors

Constructor and Description
ZoomManager() Constructor.
ZoomManager(java.lang.String folder, LogTypeHelper min, LogTypeHelper max) Constructor

Method Summary

Modifier and Type	Method and Description
LogTypeHelper	getMaxLevel()
LogTypeHelper	getMinLevel()
java.lang.String	getRepository() Return the path of the folder containing XML log files.
boolean	isAvailable() Check if the zoom feature is available.
boolean	isLoadingLogs() Return true if a loading is in progress.
void	setFilesRepository(java.lang.String folder) Set the folder to read XML files of logs from.
void	setLevels(LogTypeHelper min, LogTypeHelper max) Set the levels of the logs to read while zooming
void	stopZoom() Interrupt the zoom.
void	zoom(java.lang.String startDate, java.lang.String endDate, ACSRemoteLogListener logListener, ZoomProgressListener zoomListener, ACSRemoteErrorListener errorListener) Load the logs.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_LEVEL_PROPERTY_NAME

public static final java.lang.String MIN_LEVEL_PROPERTY_NAME

The name of the property of the min log level of the zoom

See Also:

Constant Field Values

MAX_LEVEL_PROPERTY_NAME

public static final java.lang.String MAX_LEVEL_PROPERTY_NAME

The name of the property of the min log level of the zoom

See Also:

Constant Field Values

FILES_LOCATION_PROPERTY_NAME

public static final java.lang.String FILES_LOCATION_PROPERTY_NAME

The name of the property containing the folder where ARCHIVES writes files into.

Note: this way of getting the folder could change in further releases.

See Also:

Constant Field Values

Constructor Detail

ZoomManager

public ZoomManager()

Constructor.

The folder is retrieved from a java property and the levels are set to defaults.

See Also:

FilesManager}

ZoomManager

public ZoomManager(java.lang.String folder,
                   LogTypeHelper min,
                   LogTypeHelper max)
            throws ZoomException

Constructor

Parameters:

folder - The folder with XML files of logs

min - The min log level of logs to read

max - The max log level of logs to read

Throws:

ZoomException - If the folder or the levels are invalid

Method Detail

isAvailable

public boolean isAvailable()

Check if the zoom feature is available.

The zoom is available if the files manager and the levels are valid. In particular, the files manager must have a valid folder with a valid set of XML files. The folder is valid if there are XML files to read.

Returns:

true if the zoom is available; false otherwise.

setFilesRepository

public void setFilesRepository(java.lang.String folder)
                        throws ZoomException

Set the folder to read XML files of logs from.

Parameters:

folder - The folder of XML files of logs

Throws:

ZoomException - If the folder is invalid.

setLevels

public void setLevels(LogTypeHelper min,
                      LogTypeHelper max)

Set the levels of the logs to read while zooming

Parameters:

min - The minimum log level (can be null)

max - The max log level (must be greater then the min; can't be null)

getRepository

public java.lang.String getRepository()

Return the path of the folder containing XML log files.

If the folder is invalid

Returns:

The repository of XML files of logs; null if no folder (or an invalid one) is in use

getMinLevel

public LogTypeHelper getMinLevel()

Returns:

The min level for zoomin

getMaxLevel

public LogTypeHelper getMaxLevel()

Returns:

The max level for zoomin

zoom

public void zoom(java.lang.String startDate,
                 java.lang.String endDate,
                 ACSRemoteLogListener logListener,
                 ZoomProgressListener zoomListener,
                 ACSRemoteErrorListener errorListener)
          throws java.io.FileNotFoundException,
                 ZoomException

Load the logs.

Throws:

java.io.FileNotFoundException

ZoomException

See Also:

FilesManager}

isLoadingLogs

public boolean isLoadingLogs()

Return true if a loading is in progress.

Returns:

true if a loading is in progress

stopZoom

public void stopZoom()

Interrupt the zoom.

The method does nothing if no zoom is currently in progress.