visad.collab

Class MapMonitorEvent

java.lang.Object

visad.collab.MonitorEvent

visad.collab.MapMonitorEvent

All Implemented Interfaces:

java.io.Serializable

public class MapMonitorEvent
extends MonitorEvent

MapMonitorEvent is the VisAD class for ScalarMap-related events from display monitors. They are sourced by DisplayMonitor objects and received by MonitorCallback objects.

See Also:

Serialized Form

Field Summary

Fields inherited from class visad.collab.MonitorEvent

CONTROL_CHANGED, CONTROL_INIT_REQUESTED, MAP_ADDED, MAP_CHANGED, MAP_REMOVED, MAPS_CLEARED, MESSAGE_SENT, REFERENCE_ADDED, REFERENCE_REMOVED

Constructor Summary

Constructors

Constructor and Description
MapMonitorEvent(int type, int originator, ScalarMap map) Creates a MapMonitorEvent for the specified ScalarMap.
MapMonitorEvent(int type, ScalarMap map) Creates a MapMonitorEvent for the specified ScalarMap.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Returns an exact clone of this object.
boolean	equals(java.lang.Object o) Returns true if the specified object matches this object.
java.lang.String	getKey() Get the key used to uniquely identify this event.
ScalarMap	getMap() Gets the ScalarMap to which this event refers.
java.lang.String	toString() Returns a String representation of this object.

Methods inherited from class visad.collab.MonitorEvent

getOriginator, getSequenceNumber, getType, getTypeName, getTypeName, setOriginator

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MapMonitorEvent

public MapMonitorEvent(int type,
                       ScalarMap map)
                throws VisADException

Creates a MapMonitorEvent for the specified ScalarMap.

Parameters:

type - The event type (either MonitorEvent.MAP_ADDED, MonitorEvent.MAP_REMOVED, or MonitorEvent.MAP_CHANGED, or MonitorEvent.MAPS_CLEARED.)

map - the ScalarMap (or ConstantMap).

Throws:

VisADException - When a bad type is specified.

MapMonitorEvent

public MapMonitorEvent(int type,
                       int originator,
                       ScalarMap map)
                throws VisADException

Creates a MapMonitorEvent for the specified ScalarMap.

Parameters:

type - The event type (either MonitorEvent.MAP_ADDED, MonitorEvent.MAP_REMOVED, or MonitorEvent.MAP_CHANGED, or MonitorEvent.MAPS_CLEARED.)

originator - The ID of the connection from which this event came, relative to the receiver of the event.

map - the ScalarMap (or ConstantMap).

Throws:

VisADException - When a bad type is specified.

Method Detail

getKey

public java.lang.String getKey()

Get the key used to uniquely identify this event.

Specified by:

getKey in class MonitorEvent

Returns:

The unique key.

getMap

public ScalarMap getMap()

Gets the ScalarMap to which this event refers.

equals

public boolean equals(java.lang.Object o)

Returns true if the specified object matches this object.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare.

clone

public java.lang.Object clone()

Returns an exact clone of this object.

Specified by:

clone in class MonitorEvent

toString

public java.lang.String toString()

Returns a String representation of this object.

Overrides:

toString in class MonitorEvent