com.apelon.dts.client.events
Class ClassifyEvent

java.lang.Object
  java.util.EventObject
      com.apelon.dts.client.events.ClassifyEvent

All Implemented Interfaces:

Serializable

public class ClassifyEvent
extends EventObject

Defines the available Classify events that an interested class may listen for. This interface should be implemented by any class that may be required to perform an action when a Classify action occurs.

Since:

DTS 3.4

Version:

DTS 3.4

Author:

Apelon Inc.

See Also:

ClassifyEvent, Serialized Form

Field Summary

static int	CLASSIFY_CANCEL CLASSIFY_CANCELEvent ID = CLASSIFY_FIRST + 2
static int	CLASSIFY_ERRORS Classify Modify Event ID = CLASSIFY_FIRST + 2
static int	CLASSIFY_FIRST Starts the ID sequence at 2100 for Classify events.
static int	CLASSIFY_LAST Reflects the current end of the ID sequence at CLASSIFY_FIRST + 3 for Classify events.
static int	CLASSIFY_START CLASSIFY_START Event ID = CLASSIFY_START
static int	CLASSIFY_SUCCESS CLASSIFY_SUCCESS Event ID = CLASSIFY_FIRST + 1
static int	INVALID_CLASSIFY_EVENT Value of -1 to flag an unitialized or invalid setting for classifyEventType.

Fields inherited from class java.util.EventObject

source

Constructor Summary

ClassifyEvent(Object source, int eventType, int namespaceId)
Constructs a ClassifyEvent object.

Method Summary

int	getClassifyEventType() Get Classify Event Type.
int	getNamespaceId() Get Classify Namespace ID.

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

CLASSIFY_FIRST

public static final int CLASSIFY_FIRST

Starts the ID sequence at 2100 for Classify events.

See Also:

CLASSIFY_START, CLASSIFY_SUCCESS, CLASSIFY_ERRORS, CLASSIFY_CANCEL, Constant Field Values

CLASSIFY_START

public static final int CLASSIFY_START

CLASSIFY_START Event ID = CLASSIFY_START

See Also:

Constant Field Values

CLASSIFY_SUCCESS

public static final int CLASSIFY_SUCCESS

CLASSIFY_SUCCESS Event ID = CLASSIFY_FIRST + 1

See Also:

Constant Field Values

CLASSIFY_ERRORS

public static final int CLASSIFY_ERRORS

Classify Modify Event ID = CLASSIFY_FIRST + 2

See Also:

Constant Field Values

CLASSIFY_CANCEL

public static final int CLASSIFY_CANCEL

CLASSIFY_CANCELEvent ID = CLASSIFY_FIRST + 2

See Also:

Constant Field Values

CLASSIFY_LAST

public static final int CLASSIFY_LAST

Reflects the current end of the ID sequence at CLASSIFY_FIRST + 3 for Classify events.

See Also:

Constant Field Values

INVALID_CLASSIFY_EVENT

public static final int INVALID_CLASSIFY_EVENT

Value of -1 to flag an unitialized or invalid setting for classifyEventType.

See Also:

Constant Field Values

Constructor Detail

ClassifyEvent

public ClassifyEvent(Object source,
                     int eventType,
                     int namespaceId)

Constructs a ClassifyEvent object. eventType sets classifyEventType. If eventType is not a valid Classify Event code then classifyEventType will be set to INVALID_CLASSIFY_EVENT.

Parameters:

source - - Should be an object that is a valid source of Classify events.

eventType - - If valid ClassifyEvent value, used to set classifyEventType.

namespaceId - - Id of the namespace being classified.

See Also:

ClassifyListener

Method Detail

getClassifyEventType

public int getClassifyEventType()

Get Classify Event Type. The Event Type can be CLASSIFY_START, CLASSIFY_SUCCESS, CLASSIFY_ERRORS, or CLASSIFY_CANCEL.

Returns:

int The classify event type

getNamespaceId

public int getNamespaceId()

Get Classify Namespace ID.

Returns:

int The namespace id. The classify action occurs in this namespace