org.peace_tools.workspace
Class WorkspaceEvent

java.lang.Object
  java.util.EventObject
      org.peace_tools.workspace.WorkspaceEvent

All Implemented Interfaces:

java.io.Serializable

public class WorkspaceEvent
extends java.util.EventObject

See Also:

Serialized Form

Nested Class Summary

static class	WorkspaceEvent.EntryType Enumeration for the different types of Workpace entries that can be reported via a WorkspaceEvent object.
static class	WorkspaceEvent.Operation Enumeration for the different types of operations on a Workspace entity that can be reported via a WorkspaceEvent object.

Field Summary

private WorkspaceEvent.EntryType	entryType This instance variable is used to contain the type of the entry regarding which a status change is being reported.
private WorkspaceEvent.Operation	operation This instance variable is used to contain the type of status change being reported via this event.
private static long	serialVersionUID A generated serialization UID (required as the base class is defined to be serializable).

Fields inherited from class java.util.EventObject

source

Constructor Summary

WorkspaceEvent(ClassifierList list)
Constructor to create an event that can be used to report change to the list of DB classifiers.

WorkspaceEvent(DataSet ds, WorkspaceEvent.Operation operation)
Constructor to create an event that can be used to report change in the status of a complete data set.

WorkspaceEvent(Job job, WorkspaceEvent.Operation operation)
Constructor to create an event that can be used to report change in the status of a job entry.

WorkspaceEvent(MSTClusterData clusters, WorkspaceEvent.Operation operation)
Constructor to create an event that can be used to report change in the status of a MST cluster data file.

WorkspaceEvent(MSTData mst, WorkspaceEvent.Operation operation)
Constructor to create an event that can be used to report change in the status of a MST data file.

WorkspaceEvent(Server server, WorkspaceEvent.Operation operation)
Constructor to create an event that can be used to report change in the status of a server entry.

Method Summary

WorkspaceEvent.EntryType	getEntryType() Determine the type of entry regarding which a status change is being reported.
WorkspaceEvent.Operation	getOperation() Determine the type of operation reported by this event.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

entryType

private final WorkspaceEvent.EntryType entryType

This instance variable is used to contain the type of the entry regarding which a status change is being reported.

operation

private final WorkspaceEvent.Operation operation

This instance variable is used to contain the type of status change being reported via this event.

serialVersionUID

private static final long serialVersionUID

A generated serialization UID (required as the base class is defined to be serializable).

See Also:

Constant Field Values

Constructor Detail

WorkspaceEvent

public WorkspaceEvent(DataSet ds,
                      WorkspaceEvent.Operation operation)

Constructor to create an event that can be used to report change in the status of a complete data set.

Parameters:

ds - The data set that has been inserted, deleted, or updated.

operation - The type of operation (insert, delete, or update) that has already occured to the data set.

WorkspaceEvent

public WorkspaceEvent(MSTData mst,
                      WorkspaceEvent.Operation operation)

Constructor to create an event that can be used to report change in the status of a MST data file.

Parameters:

mst - The MST data file that has been inserted, deleted, or updated.

operation - The type of operation (insert, delete, or update) that has already occurred to the MST data.

WorkspaceEvent

public WorkspaceEvent(MSTClusterData clusters,
                      WorkspaceEvent.Operation operation)

Constructor to create an event that can be used to report change in the status of a MST cluster data file.

Parameters:

clusters - The MST cluster data file that has been inserted, deleted, or updated.

operation - The type of operation (insert, delete, or update) that has already occurred to the MST cluster data.

WorkspaceEvent

public WorkspaceEvent(Job job,
                      WorkspaceEvent.Operation operation)

Constructor to create an event that can be used to report change in the status of a job entry.

Parameters:

job - The job entry that has been inserted, deleted, or updated.

operation - The type of operation (insert, delete, or update) that has already occurred to the job.

WorkspaceEvent

public WorkspaceEvent(Server server,
                      WorkspaceEvent.Operation operation)

Constructor to create an event that can be used to report change in the status of a server entry.

Parameters:

server - The server entry that has been inserted, deleted, or updated.

operation - The type of operation (insert, delete, or update) that has already occurred to the server entry.

WorkspaceEvent

public WorkspaceEvent(ClassifierList list)

Constructor to create an event that can be used to report change to the list of DB classifiers. This method always sets the operation to an UPDATE as DB classifiers are changed in one swoop and individual entries are not updated (due to the nature of the classifiers).

Parameters:

list - The classifier list that has been changed.

Method Detail

getEntryType

public WorkspaceEvent.EntryType getEntryType()

Determine the type of entry regarding which a status change is being reported.

Note: The entry type determines the data type of the source object included in the event as indicated in the enumeration definition(s).

Returns:

One of the predefined enumerations identifying the type of entity that this event pertains to.

getOperation

public WorkspaceEvent.Operation getOperation()

Determine the type of operation reported by this event.

Returns:

The resulting type of operation that is being reported by this event.