com.spss.psapi.task

Class ExecutionFeedbackEvent

  • java.lang.Object
    • java.util.EventObject
      • com.spss.psapi.task.ExecutionFeedbackEvent
    • Field Detail

      • TYPE_DIAGNOSTIC

        public static final int TYPE_DIAGNOSTIC
        Event type: diagnostic message.
        See Also:
        Constant Field Values
      • TYPE_RECORD_COUNT

        public static final int TYPE_RECORD_COUNT
        Event type: record count.
        See Also:
        Constant Field Values
      • TYPE_PROGRESS

        public static final int TYPE_PROGRESS
        Event type: percentage progress.
        See Also:
        Constant Field Values
      • SEVERITY_INFORMATION

        public static final int SEVERITY_INFORMATION
        Severity level: information.
        See Also:
        Constant Field Values
      • SEVERITY_WARNING

        public static final int SEVERITY_WARNING
        Severity level: warning.
        See Also:
        Constant Field Values
      • SEVERITY_ERROR

        public static final int SEVERITY_ERROR
        Severity level: error.
        See Also:
        Constant Field Values
      • MESSAGE_ID_PREPARATION_STARTED

        public static final int MESSAGE_ID_PREPARATION_STARTED
        Message ID: preparation started.
        See Also:
        Constant Field Values
      • MESSAGE_ID_PREPARATION_STOPPED

        public static final int MESSAGE_ID_PREPARATION_STOPPED
        Message ID: preparation stopped.
        See Also:
        Constant Field Values
      • MESSAGE_ID_OPTIMIZATION_STARTED

        public static final int MESSAGE_ID_OPTIMIZATION_STARTED
        Message ID: optimization started.
        See Also:
        Constant Field Values
      • MESSAGE_ID_OPTIMIZATION_STOPPED

        public static final int MESSAGE_ID_OPTIMIZATION_STOPPED
        Message ID: optimization stopped.
        See Also:
        Constant Field Values
      • MESSAGE_ID_EXECUTION_STARTED

        public static final int MESSAGE_ID_EXECUTION_STARTED
        Message ID: execution started.
        See Also:
        Constant Field Values
      • MESSAGE_ID_EXECUTION_STOPPED

        public static final int MESSAGE_ID_EXECUTION_STOPPED
        Message ID: execution stopped.
        See Also:
        Constant Field Values
      • MESSAGE_ID_SQL_EXECUTION_STARTED

        public static final int MESSAGE_ID_SQL_EXECUTION_STARTED
        Message ID: SQL execution started.
        See Also:
        Constant Field Values
      • MESSAGE_ID_SQL_EXECUTION_STOPPED

        public static final int MESSAGE_ID_SQL_EXECUTION_STOPPED
        Message ID: SQL execution stopped.
        See Also:
        Constant Field Values
      • MESSAGE_ID_PROCESS_EXECUTION_STARTED

        public static final int MESSAGE_ID_PROCESS_EXECUTION_STARTED
        Message ID: external process execution started.
        See Also:
        Constant Field Values
      • MESSAGE_ID_PROCESS_EXECUTION_STOPPED

        public static final int MESSAGE_ID_PROCESS_EXECUTION_STOPPED
        Message ID: external process execution stopped.
        See Also:
        Constant Field Values
      • MESSAGE_ID_INTERRUPTED

        public static final int MESSAGE_ID_INTERRUPTED
        Message ID: interrupted.
        See Also:
        Constant Field Values
      • MESSAGE_ID_OTHER

        public static final int MESSAGE_ID_OTHER
        Message ID: other.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ExecutionFeedbackEvent

        protected ExecutionFeedbackEvent(ExecutionHandle handle,
                              int type,
                              int severity,
                              int messageId,
                              java.lang.String message)
        Constructs an ExecutionFeedbackEvent using the supplied parameters. If the value of messageId is not recognised, getMessageId() returns MESSAGE_ID_OTHER.
        Parameters:
        handle - the ExecutionHandle which originated the event
        type - the type of event
        severity - the severity level of the event
        messageId - the message ID associated with the event
        message - the message associated with the event
    • Method Detail

      • getMessageID

        protected static int getMessageID(int messageId)
        Converts the supplied arbitrary message Id to one of the defined MESSAGE_ID_ constants.
        Parameters:
        messageId -
        Returns:
        one of the MESSAGE_ID_ constants
      • createExecutionFeedbackEvent

        public static ExecutionFeedbackEvent createExecutionFeedbackEvent(ExecutionHandle handle,
                                                          int type,
                                                          int severity,
                                                          java.lang.String message)
        Creates a new execution feedback event. getMessageId() returns MESSAGE_ID_OTHER.
        Parameters:
        handle - the ExecutionHandle which originated the event
        type - the type of event
        severity - the severity level of the event
        message - the message associated with the event
        Returns:
        an execution feedback event
      • createExecutionFeedbackEvent

        public static ExecutionFeedbackEvent createExecutionFeedbackEvent(ExecutionHandle handle,
                                                          int type,
                                                          int severity,
                                                          int messageId,
                                                          java.lang.String message)
        Creates a new execution feedback event. If the value of messageId is not recognised, getMessageId() returns MESSAGE_ID_OTHER.
        Parameters:
        handle - the ExecutionHandle which originated the event
        type - the type of event
        severity - the severity level of the event
        messageId - the message ID associated with the event
        message - the message associated with the event
        Returns:
        an execution feedback event
      • getExecutionHandle

        public ExecutionHandle getExecutionHandle()
        Returns the ExecutionHandle that raised the event. This is the source of the event cast to type ExecutionHandle.
        Returns:
        the ExecutionHandle that raised the event
      • getType

        public int getType()
        Returns the type of feedback represented by this event. The result is one of the TYPE_ constants declared above.
        Returns:
        the type of feedback represented by this event
      • getSeverity

        public int getSeverity()
        Returns the severity level of this event. The result is one of the 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.
        Returns:
        the severity level of this event
      • getMessageId

        public int getMessageId()
        Returns the message ID associated with this event. This is one of the MESSAGE_ID_ constants.
        Returns:
        message ID
      • getMessage

        public java.lang.String getMessage()
        Returns the message associated with this event.

        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.0
        representing (an estimate of) the percentage of work completed. For example:
        "26.3"
        (26.3% completed).
        Returns:
        the message associated with this event
      • getRoot

        public java.lang.Object getRoot()
      • setRoot

        public void setRoot(java.lang.Object root)

(C) Copyright IBM Corp. 1994, 2015. All Rights Reserved.