cl::utfsm::acs::acg::core::AlarmManager Class Reference

Inheritance diagram for cl::utfsm::acs::acg::core::AlarmManager:

Collaboration diagram for cl::utfsm::acs::acg::core::AlarmManager:

Public Member Functions
void	loadFromCDB ()
List< FaultFamily >	getAllAlarms ()
List< Alarm >	getAlarms ()
Alarm	getAlarm (String id)
FaultFamily	getFaultFamily (String name)
FaultCode	getFaultCode (String ffName, int value)
FaultMember	getFaultMember (String ffName, String fmName)
boolean	deleteFaultMember (FaultFamily ff, FaultMember fm) throws NullPointerException, IllegalOperationException
boolean	deleteFaultCode (FaultFamily ff, FaultCode fc) throws NullPointerException, IllegalOperationException
boolean	deleteFaultFamily (FaultFamily ff) throws NullPointerException, IllegalOperationException
void	addFaultFamily (FaultFamily ff) throws NullPointerException, IllegalOperationException
void	addFaultMember (FaultFamily ff, FaultMember fm) throws NullPointerException, IllegalOperationException
void	addFaultCode (FaultFamily ff, FaultCode fc) throws NullPointerException, IllegalOperationException
void	updateFaultFamily (FaultFamily ff, FaultFamily ffi) throws NullPointerException, IllegalOperationException
void	updateFaultMember (FaultFamily ff, FaultMember fm, FaultMember fmi) throws NullPointerException, IllegalOperationException
void	updateFaultCode (FaultFamily ff, FaultCode fc, FaultCode fci) throws NullPointerException, IllegalOperationException
void	saveToCDB ()
Static Public Member Functions
static AlarmManager	getInstance (AlarmDAO alarmDAO)
static void	destroy ()
Private Member Functions
	AlarmManager (AlarmDAO alarmDAO)
Private Attributes
AlarmDAO	_alarmDAO
List< FaultFamily >	_ffList
HashMap< String, ObjectState >	_objState
ReductionManager	_reductionManager
CategoryManager	_categoryManager
Static Private Attributes
static AlarmManager	_instance

Detailed Description

The AlarmManager class is responsible of handling the references to the Alarm definitions that the ACG does. It also should validate if the set of alarms defined in the ACG are consistent with the other parts of the system (e.g., the Categories and the Sources)

Author:: rtobar

Constructor & Destructor Documentation

cl::utfsm::acs::acg::core::AlarmManager::AlarmManager ( AlarmDAO alarmDAO ) [inline, private]

References _alarmDAO, _categoryManager, _ffList, _objState, _reductionManager, cl::utfsm::acs::acg::core::CategoryManager::getInstance(), and cl::utfsm::acs::acg::core::ReductionManager::getInstance().

Referenced by getInstance().

Member Function Documentation

void cl::utfsm::acs::acg::core::AlarmManager::addFaultCode	(	FaultFamily	ff,
		FaultCode	fc
	)			throws NullPointerException, IllegalOperationException `[inline]`

Adds a new Fault Code to a given Fault Family.

Parameters:

	ff	The Fault Family to which the Fault Code will be added
	fm	The Fault Code to be added

Exceptions:

	NullPointerException	If the given Fault Family (or its name), the given Fault Code or both are null
	IllegalOperationException	If the Fault Code already exists or the Fault Family doesn't exist

References _ffList, _objState, and cl::utfsm::acs::acg::core::ObjectState::update().

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createViewWidgets(), cl::utfsm::acs::acg::core::AlarmManagerTest::testAddFaultCode(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testUpdateFaultCode().

void cl::utfsm::acs::acg::core::AlarmManager::addFaultFamily ( FaultFamily ff ) throws NullPointerException, IllegalOperationException [inline]

Adds a new Fault Family.

Parameters:

ff

The Fault Family to be added

Exceptions:

	NullPointerException	If the given Fault Family (or its name) is null
	IllegalOperationException	If the Fault Family already exists

References _ffList, _objState, cl::utfsm::acs::acg::core::ObjectState::create(), and cl::utfsm::acs::acg::core::ObjectState::update().

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createViewWidgets(), cl::utfsm::acs::acg::core::AlarmManagerTest::testAddFaultFamily(), cl::utfsm::acs::acg::core::AlarmManagerTest::testSaveToCDB(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testUpdateFaultFamily().

void cl::utfsm::acs::acg::core::AlarmManager::addFaultMember	(	FaultFamily	ff,
		FaultMember	fm
	)			throws NullPointerException, IllegalOperationException `[inline]`

Adds a new Fault Member to a given Fault Family.

Parameters:

	ff	The Fault Family to which the Fault Member will be added
	fm	The Fault Member to be added

Exceptions:

	NullPointerException	If the given Fault Family (or its name), the given Fault Member (or its name) or both are null
	IllegalOperationException	If the Fault Member already exists or the Fault Family doesn't exist

References _ffList, _objState, and cl::utfsm::acs::acg::core::ObjectState::update().

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createViewWidgets(), cl::utfsm::acs::acg::core::AlarmManagerTest::testAddFaultMember(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testUpdateFaultMember().

boolean cl::utfsm::acs::acg::core::AlarmManager::deleteFaultCode	(	FaultFamily	ff,
		FaultCode	fc
	)			throws NullPointerException, IllegalOperationException `[inline]`

Deletes a Fault Code of a given Fault Family. The Fault Code to be deleted is checked against the existing Reduction Rules in order to preserve the consistency of the application (i.e., a Fault Code cannot be deleted if it is currently present in a Reduction Rule).

Parameters:

	ff	The Fault Family of the Fault Code to be deleted
	fc	The Fault Code to be deleted

Returns:: True if it deletes the given Fault Code, false otherwise

Exceptions:

	NullPointerException	If the given Fault Family or Fault Code is null
	IllegalOperationException	If the Fault Code is part of an existing Reduction Rule

References _ffList, _objState, _reductionManager, cl::utfsm::acs::acg::core::ReductionManager::getNodeReductionRules(), and cl::utfsm::acs::acg::core::ObjectState::update().

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createViewWidgets(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testDeleteFaultCode().

boolean cl::utfsm::acs::acg::core::AlarmManager::deleteFaultFamily ( FaultFamily ff ) throws NullPointerException, IllegalOperationException [inline]

Deletes a Fault Family. The Fault Family to be deleted is checked against the existing Reduction Rules in order to preserve the consistency of the application (i.e., a Fault Code cannot be deleted if it is currently present in a Reduction Rule).

Parameters:

ff

The Fault Family to be deleted

Returns:: True if it deletes the given Fault Family, false otherwise

Exceptions:

	NullPointerException	If the given Fault Family (or its name) is null
	IllegalOperationException	If the Fault Family is part of an existing Reduction Rule

References _categoryManager, _ffList, _objState, _reductionManager, cl::utfsm::acs::acg::core::ObjectState::delete(), cl::utfsm::acs::acg::core::CategoryManager::getAllCategories(), cl::utfsm::acs::acg::core::ReductionManager::getNodeReductionRules(), and cl::utfsm::acs::acg::core::CategoryManager::updateCategory().

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createViewWidgets(), cl::utfsm::acs::acg::core::AlarmManagerTest::testDeleteFaultFamily(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testSaveToCDB().

boolean cl::utfsm::acs::acg::core::AlarmManager::deleteFaultMember	(	FaultFamily	ff,
		FaultMember	fm
	)			throws NullPointerException, IllegalOperationException `[inline]`

Deletes a Fault Member of a given Fault Family. The Fault Member to be deleted is checked against the existing Reduction Rules in order to preserve the consistency of the application (i.e., a Fault Member cannot be deleted if it is currently present in a Reduction Rule).

Parameters:

	ff	The Fault Family of the Fault Member to be deleted
	fm	The Fault Member to be deleted

Returns:: True if it deletes the given Fault Member, false otherwise

Exceptions:

	NullPointerException	If the given Fault Family or Fault Member is null
	IllegalOperationException	If the Fault Member is part of an existing Reduction Rule

References _ffList, _objState, _reductionManager, cl::utfsm::acs::acg::core::ReductionManager::getNodeReductionRules(), and cl::utfsm::acs::acg::core::ObjectState::update().

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createViewWidgets(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testDeleteFaultMember().

static void cl::utfsm::acs::acg::core::AlarmManager::destroy ( ) [inline, static]

Destroys the singleton instance of this class. This is needed to renew the internal reference to the AlarmDAO if a new connection to the DAL and the ACS Manager has been performed

References _instance.

Alarm cl::utfsm::acs::acg::core::AlarmManager::getAlarm ( String id ) [inline]

References _alarmDAO.

Referenced by cl::utfsm::acs::acg::gui::ReductionsView::createMRParentWidgets(), cl::utfsm::acs::acg::gui::ReductionsView::createNRParentWidgets(), cl::utfsm::acs::acg::gui::ReductionsView::createViewWidgets(), cl::utfsm::acs::acg::gui::ReductionsView::fillMRParentChAlarmList(), cl::utfsm::acs::acg::gui::ReductionsView::fillNRParentChAlarmList(), and getAlarms().

List<Alarm> cl::utfsm::acs::acg::core::AlarmManager::getAlarms ( ) [inline]

References _alarmDAO, and getAlarm().

Referenced by cl::utfsm::acs::acg::gui::ReductionsView::fillMRParentChAlarmList(), and cl::utfsm::acs::acg::gui::ReductionsView::fillNRParentChAlarmList().

List<FaultFamily> cl::utfsm::acs::acg::core::AlarmManager::getAllAlarms ( ) [inline]

Returns a list of all the fault families that this manager currently handles

Returns:: The list of all the fault families that this manager currently handles

References _ffList.

FaultCode cl::utfsm::acs::acg::core::AlarmManager::getFaultCode	(	String	ffName,
		int	value
	)			`[inline]`

Searches and returns a fault code, based on the fault family name and the fault code value

Parameters:

	ffName	The Fault Family name
	value	The Fault Code value

Returns:: The referenced fault code

References _ffList.

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createFCWidgets(), cl::utfsm::acs::acg::gui::AlarmsView::createViewWidgets(), cl::utfsm::acs::acg::gui::AlarmsView::fillFCWidgets(), cl::utfsm::acs::acg::core::AlarmManagerTest::testGetFaultCode(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testUpdateFaultCode().

FaultFamily cl::utfsm::acs::acg::core::AlarmManager::getFaultFamily ( String name ) [inline]

Retrieves a fault family description searching by the fault family name.

Parameters:

name

The name of the fault family to retrieve

Returns:: The fault family description (null if not found)

References _ffList.

FaultMember cl::utfsm::acs::acg::core::AlarmManager::getFaultMember	(	String	ffName,
		String	fmName
	)			`[inline]`

Searches and returns a fault member, based on the fault family name and the fault code name

Parameters:

	ffName	The Fault Family name
	fmName	The Fault Member name

Returns:: The associated Fault Member

References _ffList.

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createFMWidgets(), cl::utfsm::acs::acg::gui::AlarmsView::createViewWidgets(), cl::utfsm::acs::acg::gui::AlarmsView::fillFMWidgets(), cl::utfsm::acs::acg::core::AlarmManagerTest::testGetFaultMember(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testUpdateFaultMember().

static AlarmManager cl::utfsm::acs::acg::core::AlarmManager::getInstance ( AlarmDAO alarmDAO ) [inline, static]

Method to retrieve the singleton instance of the AlarmManager

Returns:: The singleton instance of the AlarmManager

References _instance, and AlarmManager().

void cl::utfsm::acs::acg::core::AlarmManager::loadFromCDB ( ) [inline]

Performs a full reload of the contents of the Manager. All the current internal contents of the EntityManager are cleared, and replaced by the ones that are currently available on the CDB. Therefore, this call should be done with great care.

Implements cl::utfsm::acs::acg::core::EntityManager.

References _alarmDAO, _ffList, and _objState.

void cl::utfsm::acs::acg::core::AlarmManager::saveToCDB ( ) [inline]

Performs a full save of the contents of the Manager to the CDB. All the modified contents of the CDB are updated, and replaced by the ones that are currently available on the EntityManager. Therefore, this call should be done with great care.

Implements cl::utfsm::acs::acg::core::EntityManager.

References _alarmDAO, _ffList, _objState, cl::utfsm::acs::acg::core::ObjectState::getAction(), and getFaultFamily().

Referenced by cl::utfsm::acs::acg::core::AlarmSystemManager::saveToCDB(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testSaveToCDB().

void cl::utfsm::acs::acg::core::AlarmManager::updateFaultCode	(	FaultFamily	ff,
		FaultCode	fc,
		FaultCode	fci
	)			throws NullPointerException, IllegalOperationException `[inline]`

Modifies a Fault Code of a given Fault Family.

Parameters:

	ff	The Fault Family to which belongs the Fault Code to be changed
	fc	The Fault Code to be changed
	fci	The Fault Code with the new values

Exceptions:

	NullPointerException	If any (or both) of the given Fault Codes or the Fault Family (or its name) or both are null
	IllegalOperationException	If the Fault Family doesn't exists

References _ffList, _objState, and cl::utfsm::acs::acg::core::ObjectState::update().

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createFCWidgets(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testUpdateFaultCode().

void cl::utfsm::acs::acg::core::AlarmManager::updateFaultFamily	(	FaultFamily	ff,
		FaultFamily	ffi
	)			throws NullPointerException, IllegalOperationException `[inline]`

Modifies a Fault Family.

Parameters:

	ff	The Fault Family to be changed
	ffi	The Fault Family with the new values

Exceptions:

	NullPointerException	If any (or both) of the given Fault Families (or their names) are null
	IllegalOperationException	If the Fault Family doesn't exists

References _categoryManager, _ffList, _objState, cl::utfsm::acs::acg::core::ObjectState::create(), cl::utfsm::acs::acg::core::ObjectState::delete(), cl::utfsm::acs::acg::core::CategoryManager::getAllCategories(), cl::utfsm::acs::acg::core::ObjectState::update(), and cl::utfsm::acs::acg::core::CategoryManager::updateCategory().

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createFFWidgets(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testUpdateFaultFamily().

void cl::utfsm::acs::acg::core::AlarmManager::updateFaultMember	(	FaultFamily	ff,
		FaultMember	fm,
		FaultMember	fmi
	)			throws NullPointerException, IllegalOperationException `[inline]`

Modifies a Fault Member of a given Fault Family.

Parameters:

	ff	The Fault Family to which belongs the Fault Member to be changed
	fm	The Fault Member to be changed
	fmi	The Fault Member with the new values

Exceptions:

	NullPointerException	If any (or both) of the given Fault Members (or their names) or the Fault Family (or its name) or both are null
	IllegalOperationException	If the Fault Family doesn't exists

References _ffList, _objState, and cl::utfsm::acs::acg::core::ObjectState::update().

Referenced by cl::utfsm::acs::acg::gui::AlarmsView::createFMWidgets(), and cl::utfsm::acs::acg::core::AlarmManagerTest::testUpdateFaultMember().