Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

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

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ZoomManager ()
 ZoomManager (String folder, LogTypeHelper min, LogTypeHelper max) throws ZoomException
boolean isAvailable ()
void setFilesRepository (String folder) throws ZoomException
void setLevels (LogTypeHelper min, LogTypeHelper max)
String getRepository ()
LogTypeHelper getMinLevel ()
LogTypeHelper getMaxLevel ()
void zoom (String startDate, String endDate, ACSRemoteLogListener logListener, ZoomProgressListener zoomListener, ACSRemoteErrorListener errorListener) throws FileNotFoundException, ZoomException
boolean isLoadingLogs ()
void stopZoom ()

Static Public Attributes

final String MIN_LEVEL_PROPERTY_NAME = "jlog.archive.zoom.MinLevel"
final String MAX_LEVEL_PROPERTY_NAME = "jlog.archive.zoom.MaxLevel"
final String FILES_LOCATION_PROPERTY_NAME = "jlog.archive.zoom.filesFolder"

Private Attributes

FilesManager filesManager = null
LogTypeHelper minLevel = LogTypeHelper.values()[0]
LogTypeHelper maxLevel = LogTypeHelper.DEBUG
volatile boolean loadingLogs = false

Detailed Description

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


Constructor & Destructor Documentation

alma::acs::logging::archive::zoom::ZoomManager::ZoomManager  )  [inline]
 

Constructor.

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

See also:
FilesManager

alma::acs::logging::archive::zoom::ZoomManager::ZoomManager String  folder,
LogTypeHelper  min,
LogTypeHelper  max
throws ZoomException [inline]
 

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
Exceptions:
ZoomException If the folder or the levels are invalid


Member Function Documentation

LogTypeHelper alma::acs::logging::archive::zoom::ZoomManager::getMaxLevel  )  [inline]
 

Returns:
The max level for zoomin

LogTypeHelper alma::acs::logging::archive::zoom::ZoomManager::getMinLevel  )  [inline]
 

Returns:
The min level for zoomin

String alma::acs::logging::archive::zoom::ZoomManager::getRepository  )  [inline]
 

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

boolean alma::acs::logging::archive::zoom::ZoomManager::isAvailable  )  [inline]
 

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.

boolean alma::acs::logging::archive::zoom::ZoomManager::isLoadingLogs  )  [inline]
 

Return true if a loading is in progress.

Returns:
true if a loading is in progress

void alma::acs::logging::archive::zoom::ZoomManager::setFilesRepository String  folder  )  throws ZoomException [inline]
 

Set the folder to read XML files of logs from.

Parameters:
folder The folder of XML files of logs
Exceptions:
ZoomException If the folder is invalid.

void alma::acs::logging::archive::zoom::ZoomManager::setLevels LogTypeHelper  min,
LogTypeHelper  max
[inline]
 

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)

void alma::acs::logging::archive::zoom::ZoomManager::stopZoom  )  [inline]
 

Interrupt the zoom.

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

void alma::acs::logging::archive::zoom::ZoomManager::zoom String  startDate,
String  endDate,
ACSRemoteLogListener  logListener,
ZoomProgressListener  zoomListener,
ACSRemoteErrorListener  errorListener
throws FileNotFoundException, ZoomException [inline]
 

Load the logs.

See also:
FilesManager


Member Data Documentation

final String alma::acs::logging::archive::zoom::ZoomManager::FILES_LOCATION_PROPERTY_NAME = "jlog.archive.zoom.filesFolder" [static]
 

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.

FilesManager alma::acs::logging::archive::zoom::ZoomManager::filesManager = null [private]
 

The files manager to get logs from a set of XML files

volatile boolean alma::acs::logging::archive::zoom::ZoomManager::loadingLogs = false [private]
 

Signal if a loading is in progress

final String alma::acs::logging::archive::zoom::ZoomManager::MAX_LEVEL_PROPERTY_NAME = "jlog.archive.zoom.MaxLevel" [static]
 

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

LogTypeHelper alma::acs::logging::archive::zoom::ZoomManager::maxLevel = LogTypeHelper.DEBUG [private]
 

The maximum level of logs to read from files

final String alma::acs::logging::archive::zoom::ZoomManager::MIN_LEVEL_PROPERTY_NAME = "jlog.archive.zoom.MinLevel" [static]
 

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

LogTypeHelper alma::acs::logging::archive::zoom::ZoomManager::minLevel = LogTypeHelper.values()[0] [private]
 

The minimum level of logs to read from files


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 02:53:46 2009 for ACS Java API by doxygen 1.3.8