public class ExecutionFeedbackEvent
extends java.util.EventObject
Processor
or ProcessorStream
.Session.run(com.spss.psapi.transform.ProcessorStream, java.util.Collection)
,
Session.run(com.spss.psapi.transform.Processor[], java.util.Collection)
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
MESSAGE_ID_EXECUTION_STARTED
Message ID: execution started.
|
static int |
MESSAGE_ID_EXECUTION_STOPPED
Message ID: execution stopped.
|
static int |
MESSAGE_ID_INTERRUPTED
Message ID: interrupted.
|
static int |
MESSAGE_ID_OPTIMIZATION_STARTED
Message ID: optimization started.
|
static int |
MESSAGE_ID_OPTIMIZATION_STOPPED
Message ID: optimization stopped.
|
static int |
MESSAGE_ID_OTHER
Message ID: other.
|
static int |
MESSAGE_ID_PREPARATION_STARTED
Message ID: preparation started.
|
static int |
MESSAGE_ID_PREPARATION_STOPPED
Message ID: preparation stopped.
|
static int |
MESSAGE_ID_PROCESS_EXECUTION_STARTED
Message ID: external process execution started.
|
static int |
MESSAGE_ID_PROCESS_EXECUTION_STOPPED
Message ID: external process execution stopped.
|
static int |
MESSAGE_ID_SQL_EXECUTION_STARTED
Message ID: SQL execution started.
|
static int |
MESSAGE_ID_SQL_EXECUTION_STOPPED
Message ID: SQL execution stopped.
|
static int |
SEVERITY_ERROR
Severity level: error.
|
static int |
SEVERITY_INFORMATION
Severity level: information.
|
static int |
SEVERITY_WARNING
Severity level: warning.
|
static int |
TYPE_DIAGNOSTIC
Event type: diagnostic message.
|
static int |
TYPE_PROGRESS
Event type: percentage progress.
|
static int |
TYPE_RECORD_COUNT
Event type: record count.
|
Modifier | Constructor and Description |
---|---|
protected |
ExecutionFeedbackEvent(ExecutionHandle handle,
int type,
int severity,
int messageId,
java.lang.String message)
Constructs an
ExecutionFeedbackEvent using the supplied
parameters. |
Modifier and Type | Method and Description |
---|---|
static ExecutionFeedbackEvent |
createExecutionFeedbackEvent(ExecutionHandle handle,
int type,
int severity,
int messageId,
java.lang.String message)
Creates a new execution feedback event.
|
static ExecutionFeedbackEvent |
createExecutionFeedbackEvent(ExecutionHandle handle,
int type,
int severity,
java.lang.String message)
Creates a new execution feedback event.
|
ExecutionHandle |
getExecutionHandle()
Returns the
ExecutionHandle that raised the event. |
java.lang.String |
getMessage()
Returns the message associated with this event.
|
int |
getMessageId()
Returns the message ID associated with this event.
|
protected static int |
getMessageID(int messageId)
Converts the supplied arbitrary message Id to one of the defined
MESSAGE_ID_ constants. |
int |
getSeverity()
Returns the severity level of this event.
|
int |
getType()
Returns the type of feedback represented by this event.
|
public static final int TYPE_DIAGNOSTIC
public static final int TYPE_RECORD_COUNT
public static final int TYPE_PROGRESS
public static final int SEVERITY_INFORMATION
public static final int SEVERITY_WARNING
public static final int SEVERITY_ERROR
public static final int MESSAGE_ID_PREPARATION_STARTED
public static final int MESSAGE_ID_PREPARATION_STOPPED
public static final int MESSAGE_ID_OPTIMIZATION_STARTED
public static final int MESSAGE_ID_OPTIMIZATION_STOPPED
public static final int MESSAGE_ID_EXECUTION_STARTED
public static final int MESSAGE_ID_EXECUTION_STOPPED
public static final int MESSAGE_ID_SQL_EXECUTION_STARTED
public static final int MESSAGE_ID_SQL_EXECUTION_STOPPED
public static final int MESSAGE_ID_PROCESS_EXECUTION_STARTED
public static final int MESSAGE_ID_PROCESS_EXECUTION_STOPPED
public static final int MESSAGE_ID_INTERRUPTED
public static final int MESSAGE_ID_OTHER
protected ExecutionFeedbackEvent(ExecutionHandle handle, int type, int severity, int messageId, java.lang.String message)
ExecutionFeedbackEvent
using the supplied
parameters. If the value of messageId is not recognised,
getMessageId()
returns MESSAGE_ID_OTHER.handle
- the ExecutionHandle
which originated the eventtype
- the type of eventseverity
- the severity level of the eventmessageId
- the message ID associated with the eventmessage
- the message associated with the eventprotected static int getMessageID(int messageId)
MESSAGE_ID_
constants.messageId
- MESSAGE_ID_
constantspublic static ExecutionFeedbackEvent createExecutionFeedbackEvent(ExecutionHandle handle, int type, int severity, java.lang.String message)
getMessageId()
returns MESSAGE_ID_OTHER.handle
- the ExecutionHandle
which originated the eventtype
- the type of eventseverity
- the severity level of the eventmessage
- the message associated with the eventpublic static ExecutionFeedbackEvent createExecutionFeedbackEvent(ExecutionHandle handle, int type, int severity, int messageId, java.lang.String message)
getMessageId()
returns MESSAGE_ID_OTHER.handle
- the ExecutionHandle
which originated the eventtype
- the type of eventseverity
- the severity level of the eventmessageId
- the message ID associated with the eventmessage
- the message associated with the eventpublic ExecutionHandle getExecutionHandle()
ExecutionHandle
that raised the event. This is
the source of the event cast to type ExecutionHandle
.ExecutionHandle
that raised the eventpublic int getType()
TYPE_
constants declared above.public int getSeverity()
SEVERITY_
constants declared above. The severity levels
SEVERITY_WARNING
and SEVERITY_ERROR
are
associated with the event type TYPE_DIAGNOSTIC
and indicate
a warning or error condition on the server. An error event ultimately
causes execution to fail.public int getMessageId()
MESSAGE_ID_
constants.public java.lang.String getMessage()
For an event of type TYPE_DIAGNOSTIC
the result is the
diagnostic message localized for the session.
For an event of type TYPE_RECORD_COUNT
the result consists
of two decimal integers separated by a space, representing, respectively,
the number of records read and written. For example:
"15000 0"(15000 records read, none written).
For an event of type TYPE_PROGRESS
the result consists
of a single floating point number in the range
0.0 <= n <= 100.0representing (an estimate of) the percentage of work completed. For example:
"26.3"(26.3% completed).
(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.