com.serotonin.mango.rt.event.type

Class EventType

java.lang.Object

com.serotonin.mango.rt.event.type.EventType

All Implemented Interfaces:

com.serotonin.json.JsonSerializable

Direct Known Subclasses:

AuditEventType, CompoundDetectorEventType, DataPointEventType, DataSourceEventType, MaintenanceEventType, PublisherEventType, ScheduledEventType, SystemEventType

public abstract class EventType
extends java.lang.Object
implements com.serotonin.json.JsonSerializable

An event class specifies the type of event that was raised.

Author:

Matthew Lohbihler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventType.DuplicateHandling This interface defines all of the possible actions that can occur if an event is raised for which type there already exists an active event.
static interface	EventType.EventSources

Field Summary

Fields

Modifier and Type	Field and Description
static ExportCodes	SOURCE_CODES

Constructor Summary

Constructors

Constructor and Description
EventType()

Method Summary

Modifier and Type	Method and Description
boolean	excludeUser(User user) Determines if the notification of this event to the given user should be suppressed.
int	getCompoundEventDetectorId() Convenience method that keeps us from having to cast.
protected int	getCompoundEventDetectorId(com.serotonin.json.JsonObject json, java.lang.String name)
int	getDataPointId() Convenience method that keeps us from having to cast.
protected int	getDataPointId(com.serotonin.json.JsonObject json, java.lang.String name)
protected DataSourceVO<?>	getDataSource(com.serotonin.json.JsonObject json, java.lang.String name)
int	getDataSourceId() Convenience method that keeps us from having to cast.
abstract int	getDuplicateHandling() Determines whether an event type that, once raised, will always first be deactivated or whether overriding events can be raised.
abstract int	getEventSourceId()
protected int	getInt(com.serotonin.json.JsonObject json, java.lang.String name, ExportCodes codes)
protected int	getMaintenanceEventId(com.serotonin.json.JsonObject json, java.lang.String name)
protected int	getPointEventDetectorId(com.serotonin.json.JsonObject json, int dpId, java.lang.String pedName)
protected int	getPointEventDetectorId(com.serotonin.json.JsonObject json, java.lang.String dpName, java.lang.String pedName)
protected PublisherVO<?>	getPublisher(com.serotonin.json.JsonObject json, java.lang.String name)
int	getPublisherId() Convenience method that keeps us from having to cast.
abstract int	getReferenceId1()
abstract int	getReferenceId2()
protected int	getScheduledEventId(com.serotonin.json.JsonObject json, java.lang.String name)
int	getScheduleId() Convenience method that keeps us from having to cast.
boolean	isSystemMessage() Convenience method that keeps us from having to cast.
void	jsonDeserialize(com.serotonin.json.JsonReader reader, com.serotonin.json.JsonObject json)
void	jsonSerialize(java.util.Map<java.lang.String,java.lang.Object> map)

Methods inherited from class java.lang.Object

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

Field Detail

SOURCE_CODES

public static final ExportCodes SOURCE_CODES

Constructor Detail

EventType

public EventType()

Method Detail

getEventSourceId

public abstract int getEventSourceId()

isSystemMessage

public boolean isSystemMessage()

Convenience method that keeps us from having to cast.

Returns:

false here, but the system message implementation will return true.

getDataSourceId

public int getDataSourceId()

Convenience method that keeps us from having to cast.

Returns:

-1 here, but the data source implementation will return the data source id.

getDataPointId

public int getDataPointId()

Convenience method that keeps us from having to cast.

Returns:

-1 here, but the data point implementation will return the data point id.

getScheduleId

public int getScheduleId()

Convenience method that keeps us from having to cast.

Returns:

-1 here, but the schedule implementation will return the schedule id.

getCompoundEventDetectorId

public int getCompoundEventDetectorId()

Convenience method that keeps us from having to cast.

Returns:

-1 here, but the compound detector event type will return the compound detector id.

getPublisherId

public int getPublisherId()

Convenience method that keeps us from having to cast.

Returns:

-1 here, but the publisher implementation will return the publisher id.

getDuplicateHandling

public abstract int getDuplicateHandling()

Determines whether an event type that, once raised, will always first be deactivated or whether overriding events can be raised. Overrides can occur in data sources and point locators where a retry of a failed action causes the same event type to be raised without the previous having returned to normal.

Returns:

whether this event type can be overridden with newer event instances.

getReferenceId1

public abstract int getReferenceId1()

getReferenceId2

public abstract int getReferenceId2()

excludeUser

public boolean excludeUser(User user)

Determines if the notification of this event to the given user should be suppressed. Useful if the action of the user resulted in the event being raised.

Returns:

jsonSerialize

public void jsonSerialize(java.util.Map<java.lang.String,java.lang.Object> map)

Specified by:

jsonSerialize in interface com.serotonin.json.JsonSerializable

jsonDeserialize

public void jsonDeserialize(com.serotonin.json.JsonReader reader,
                            com.serotonin.json.JsonObject json)
                     throws com.serotonin.json.JsonException

Specified by:

jsonDeserialize in interface com.serotonin.json.JsonSerializable

Throws:

com.serotonin.json.JsonException

getInt

protected int getInt(com.serotonin.json.JsonObject json,
                     java.lang.String name,
                     ExportCodes codes)
              throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException

getCompoundEventDetectorId

protected int getCompoundEventDetectorId(com.serotonin.json.JsonObject json,
                                         java.lang.String name)
                                  throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException

getScheduledEventId

protected int getScheduledEventId(com.serotonin.json.JsonObject json,
                                  java.lang.String name)
                           throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException

getDataPointId

protected int getDataPointId(com.serotonin.json.JsonObject json,
                             java.lang.String name)
                      throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException

getPointEventDetectorId

protected int getPointEventDetectorId(com.serotonin.json.JsonObject json,
                                      java.lang.String dpName,
                                      java.lang.String pedName)
                               throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException

getPointEventDetectorId

protected int getPointEventDetectorId(com.serotonin.json.JsonObject json,
                                      int dpId,
                                      java.lang.String pedName)
                               throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException

getDataSource

protected DataSourceVO<?> getDataSource(com.serotonin.json.JsonObject json,
                                        java.lang.String name)
                                 throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException

getPublisher

protected PublisherVO<?> getPublisher(com.serotonin.json.JsonObject json,
                                      java.lang.String name)
                               throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException

getMaintenanceEventId

protected int getMaintenanceEventId(com.serotonin.json.JsonObject json,
                                    java.lang.String name)
                             throws com.serotonin.json.JsonException

Throws:

com.serotonin.json.JsonException