Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> greenstone >> gatherer >> [ msm overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.greenstone.gatherer.msm
Class MSMEvent  

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          org.greenstone.gatherer.msm.MSMEvent

All Implemented Interfaces:

java.io.Serializable

---

public class MSMEvent

extends java.awt.AWTEvent

An event object which contains useful information about the event that generated it, which in this case is probably an element update (this means a MSMAction object should be provided).

---

Field Summary
private  int	action           The action initiated by the user which caused this event, if any
private static int	count           The message counter.
private  ElementWrapper	element           The element associated with this event.
private  java.io.File	file           The file associated with this event.
private  long	id           A unique id given to any file or metadata task so it can be undone in its entirity.
private  Metadata	new_metadata           The new metadata associated with this event.
private  org.greenstone.gatherer.valuetree.GValueModel	new_model           The value tree model after adding a new value.
private  Metadata	old_metadata           The old metadata associated with this event.
private  org.greenstone.gatherer.valuetree.GValueModel	old_model           The value tree model prior to adding a new value.
private  MSMAction	profile           The profile associated with this event.
private  org.greenstone.gatherer.file.FileNode	record           The record associated with this event.
private  java.lang.String	value           The value associated with this event.

 

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

 

Fields inherited from class java.util.EventObject

source

 

Constructor Summary

MSMEvent(java.lang.Object source, ElementWrapper element, java.lang.String value)           Constructor for a metadata element changed event.

MSMEvent(java.lang.Object source, long id, ElementWrapper element, org.greenstone.gatherer.valuetree.GValueModel old_model, org.greenstone.gatherer.valuetree.GValueModel new_model)           Constructor.

MSMEvent(java.lang.Object source, long id, java.io.File file, Metadata old_metadata, Metadata new_metadata)           Constructor for a metadata change event involving a file.

MSMEvent(java.lang.Object source, long id, org.greenstone.gatherer.file.FileNode record, Metadata old_metadata, Metadata new_metadata, int action)           Constructor for a metadata change event involving a filenode.

MSMEvent(java.lang.Object source, long id, MSMAction profile)           Constructor.

 

Method Summary
int	getAction()           Retrieve the code of the user action that fired this event.
ElementWrapper	getElement()           Method to retrieve of the element associated with this event.
java.io.File	getFile()
Metadata	getNewMetadata()           Method to retrieve the new metadata associated with this event.
Metadata	getOldMetadata()           Method to retrieve the old metadata associated with this event.
org.greenstone.gatherer.file.FileNode	getRecord()           Retrieve the record associated with this event.
java.lang.String	getValue()           Retrieve the associated with this event.
long	ID()
java.lang.String	toString()           Create a string that represents this event in the format classname[eventstring] on sourcecomponentname.

 

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, paramString, setSource

 

Methods inherited from class java.util.EventObject

getSource

 

Methods inherited from class java.lang.Object

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

 

Field Detail

element

private ElementWrapper element

The element associated with this event.

---

file

private java.io.File file

The file associated with this event.

---

record

private org.greenstone.gatherer.file.FileNode record

The record associated with this event.

---

new_model

private org.greenstone.gatherer.valuetree.GValueModel new_model

The value tree model after adding a new value.

---

old_model

private org.greenstone.gatherer.valuetree.GValueModel old_model

The value tree model prior to adding a new value.

---

action

private int action

The action initiated by the user which caused this event, if any

---

id

private long id

A unique id given to any file or metadata task so it can be undone in its entirity.

---

new_metadata

private Metadata new_metadata

The new metadata associated with this event.

---

old_metadata

private Metadata old_metadata

The old metadata associated with this event.

---

profile

private MSMAction profile

The profile associated with this event.

---

value

private java.lang.String value

The value associated with this event.

---

count

private static int count

The message counter.

Constructor Detail

MSMEvent

public MSMEvent(java.lang.Object source,
                long id,
                ElementWrapper element,
                org.greenstone.gatherer.valuetree.GValueModel old_model,
                org.greenstone.gatherer.valuetree.GValueModel new_model)

Constructor.

---

MSMEvent

public MSMEvent(java.lang.Object source,
                long id,
                java.io.File file,
                Metadata old_metadata,
                Metadata new_metadata)

Constructor for a metadata change event involving a file.

---

MSMEvent

public MSMEvent(java.lang.Object source,
                long id,
                org.greenstone.gatherer.file.FileNode record,
                Metadata old_metadata,
                Metadata new_metadata,
                int action)

Constructor for a metadata change event involving a filenode.

---

MSMEvent

public MSMEvent(java.lang.Object source,
                long id,
                MSMAction profile)

Constructor.

---

MSMEvent

public MSMEvent(java.lang.Object source,
                ElementWrapper element,
                java.lang.String value)

Constructor for a metadata element changed event.

Method Detail

getAction

public int getAction()

Retrieve the code of the user action that fired this event.

---

getElement

public ElementWrapper getElement()

Method to retrieve of the element associated with this event.

---

getFile

public java.io.File getFile()

---

getNewMetadata

public Metadata getNewMetadata()

Method to retrieve the new metadata associated with this event.

---

getOldMetadata

public Metadata getOldMetadata()

Method to retrieve the old metadata associated with this event.

---

getRecord

public org.greenstone.gatherer.file.FileNode getRecord()

Retrieve the record associated with this event.

---

getValue

public java.lang.String getValue()

Retrieve the associated with this event.

---

ID

public long ID()

---

toString

public java.lang.String toString()

Description copied from class: java.awt.AWTEvent

Create a string that represents this event in the format classname[eventstring] on sourcecomponentname.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> greenstone >> gatherer >> [ msm overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---