fr.cnes.genius.main

Class GCondensedStatus

java.lang.Object

fr.cnes.genius.main.GCondensedStatus

public class GCondensedStatus
extends Object

Class to condense the status of individual components into a global status. An instance of this class can be used to get the global status of a panel or even the whole program configuration before running it. It provides methods to add components to the list, to get the global status and to obtain the list of components in warning or error status.

Author:

ffsm

Constructor Summary

Constructors

Constructor and Description
GCondensedStatus(GComponent... componentList) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(GComponent component) Add a component to the condensed status object.
List<GComponent>	getErrorComponentList() Getter for the list of components in error status.
GIntervalAbstract.GStatus	getStatus() Getter for the global status having into account all the components.
List<GComponent>	getWarningComponentList() Getter for the list of components in warning status.
void	update(GComponent... componentList) Update the condensed status object with a list of components.

Methods inherited from class java.lang.Object

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

Constructor Detail

GCondensedStatus

public GCondensedStatus(GComponent... componentList)

Constructor.

Parameters:

componentList - list of components (or component containers) whose status is to be had into account.

Method Detail

getStatus

public GIntervalAbstract.GStatus getStatus()

Getter for the global status having into account all the components.

Returns:

global status of the condensed status object.

getWarningComponentList

public List<GComponent> getWarningComponentList()

Getter for the list of components in warning status.

Returns:

the list of components in warning status.

getErrorComponentList

public List<GComponent> getErrorComponentList()

Getter for the list of components in error status.

Returns:

the list of components in error status.

update

public void update(GComponent... componentList)

Update the condensed status object with a list of components. If the component is an instance of GCondensedStatusInterface it will add all its subcomponents and if not, it will be added itself.

Parameters:

componentList - list of components to update the condensed status object with

add

public void add(GComponent component)

Add a component to the condensed status object. This method should only be called from outside GCondensedStatus class, in case that the component is an instance of GCondensedStatusInterface, but it redefines the fr.cnes.genius.main.GComponent#setStatus(GStatus) method and thus it has a "global" status already defined (no need to condense a status from its subcomponents).

Parameters:

component - to be added to the condensed status object