org.apache.polygene.library.alarm

Class AlarmPoint.AlarmPointMixin

java.lang.Object

org.apache.polygene.library.alarm.AlarmPoint.AlarmPointMixin

All Implemented Interfaces:

HasIdentity, AlarmPoint

Enclosing interface:

AlarmPoint

public abstract static class AlarmPoint.AlarmPointMixin
extends Object
implements AlarmPoint

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.polygene.library.alarm.AlarmPoint

AlarmPoint.AlarmPointMixin, AlarmPoint.AlarmState

Nested classes/interfaces inherited from interface org.apache.polygene.api.identity.HasIdentity

HasIdentity.HasIdentityMixin

Field Summary

Fields inherited from interface org.apache.polygene.library.alarm.AlarmPoint

EVENT_ACKNOWLEDGEMENT, EVENT_ACTIVATION, EVENT_BLOCKING, EVENT_DEACTIVATION, EVENT_DISABLING, EVENT_ENABLING, EVENT_UNBLOCKING, STATUS_ACKNOWLEDGED, STATUS_ACTIVATED, STATUS_BLOCKED, STATUS_DEACTIVATED, STATUS_DISABLED, STATUS_NORMAL, STATUS_REACTIVATED, TRIGGER_ACKNOWLEDGE, TRIGGER_ACTIVATE, TRIGGER_BLOCK, TRIGGER_DEACTIVATE, TRIGGER_DISABLE, TRIGGER_ENABLE, TRIGGER_UNBLOCK

Fields inherited from interface org.apache.polygene.api.identity.HasIdentity

IDENTITY_METHOD, IDENTITY_STATE_NAME

Constructor Summary

Constructors

Constructor and Description
AlarmPointMixin()

Method Summary

Modifier and Type	Method and Description
void	acknowledge() Acknowledges an AlarmPoint.
void	activate() Activates an AlarmPoint.
String	attribute(String name) Return the attribute of the given name.
List<String>	attributeNames() Return all attribute names
boolean	currentCondition() Get AlarmPoint condition.
AlarmStatus	currentStatus() Returns the current state of the standard.
void	deactivate() Deactivates an AlarmPoint.
String	description(Locale locale) Returns a Description of the AlarmPoint.
String	descriptionInDefaultLocale() Returns a Description of the AlarmPoint.
AlarmHistory	history() Returns the AlarmHistory of the standard.
String	name() Returns the Name of the AlarmPoint.
void	setAttribute(String name, String value) Sets the attribute of the given name.
String	toString()
void	trigger(String trigger) Trigger a state change.
void	updateCondition(boolean condition) Set AlarmPoint condition.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.polygene.library.alarm.AlarmPoint

alarmClass, category

Methods inherited from interface org.apache.polygene.api.identity.HasIdentity

identity

Constructor Detail

AlarmPointMixin

public AlarmPointMixin()

Method Detail

setAttribute

public void setAttribute(String name,
                         String value)

Description copied from interface: AlarmPoint

Sets the attribute of the given name.

Specified by:

setAttribute in interface AlarmPoint

Parameters:

name - The name of the attribute to set.

value - The value to set the named attribute to.

attribute

public String attribute(String name)

Description copied from interface: AlarmPoint

Return the attribute of the given name.

Specified by:

attribute in interface AlarmPoint

Parameters:

name - The name of the attribute to return.

Returns:

the named attribute of this AlarmPoint.

attributeNames

public List<String> attributeNames()

Description copied from interface: AlarmPoint

Return all attribute names

Specified by:

attributeNames in interface AlarmPoint

Returns:

the names of the attributes of this AlarmPoint.

toString

public String toString()

Overrides:

toString in class Object

trigger

public void trigger(String trigger)

Description copied from interface: AlarmPoint

Trigger a state change.

When the AlarmPoint object receives a trigger, it must consult the AlarmModel and figure out if there is an actual state change occurring and if any AlarmEvents should be fired.

Specified by:

trigger in interface AlarmPoint

Parameters:

trigger - The trigger to execute if existing in the AlarmModel.

activate

public void activate()

Description copied from interface: AlarmPoint

Activates an AlarmPoint.

Convenience method for:

       trigger( "activate" );
 
 

Specified by:

activate in interface AlarmPoint

deactivate

public void deactivate()

Description copied from interface: AlarmPoint

Deactivates an AlarmPoint. Convinience method for:

     trigger( "deactivate" );
 

Specified by:

deactivate in interface AlarmPoint

acknowledge

public void acknowledge()

Description copied from interface: AlarmPoint

Acknowledges an AlarmPoint. Convinience method for:

     trigger( source, "acknowledge" );
 

Specified by:

acknowledge in interface AlarmPoint

history

public AlarmHistory history()

Description copied from interface: AlarmPoint

Returns the AlarmHistory of the standard.

Specified by:

history in interface AlarmPoint

Returns:

The AlarmHistory object, or null if AlarmHistory is not supported.

currentStatus

public AlarmStatus currentStatus()

Description copied from interface: AlarmPoint

Returns the current state of the standard.

Specified by:

currentStatus in interface AlarmPoint

Returns:

The AlarmStatus (interface) object

name

public String name()

Returns the Name of the AlarmPoint. This normally returns the human readable technical name of the AlarmPoint.

Specified by:

name in interface AlarmPoint

Returns:

the name of the AlarmPoint.

descriptionInDefaultLocale

public String descriptionInDefaultLocale()

Returns a Description of the AlarmPoint. This normally returns a full Description of the AlarmPoint in the default Locale.

Specified by:

descriptionInDefaultLocale in interface AlarmPoint

Returns:

a human-readable description of the AlarmPoint in the default locale.

description

public String description(Locale locale)

Returns a Description of the AlarmPoint. This normally returns a full Description of the AlarmPoint in the Locale. If Locale is null, then the default Locale is used.

Specified by:

description in interface AlarmPoint

Parameters:

locale - The locale to return the description in, or null to use default locale.

Returns:

a human-readable description of the AlarmPoint in the given locale.

updateCondition

public void updateCondition(boolean condition)

Description copied from interface: AlarmPoint

Set AlarmPoint condition. To reduce AlarmPoint condition calculations for Implementors, each AlarmPoint should be able to work with a "true/false" trigger. Only changes to this trigger will cause an event. Causes an Activation or Deactivation if state of condition changes.

Specified by:

updateCondition in interface AlarmPoint

Parameters:

condition - Sets the AlarmPoint condition.

currentCondition

public boolean currentCondition()

Description copied from interface: AlarmPoint

Get AlarmPoint condition. To reduce AlarmPoint condition calculations for Implementors, each AlarmPoint should be able to work with a "true/false" trigger. Only changes to this trigger will cause an event.

Specified by:

currentCondition in interface AlarmPoint

Returns:

The condition of the AlarmPoint, which is used to simplify trigging of activate and deactivate.