oracle.ifs.core.extraction.handlers

Class InformationExtractionHandlerDispatcher

java.lang.Object

oracle.ifs.core.handlers.AuditEventHandlerAdapter

oracle.ifs.core.extraction.handlers.InformationExtractionHandlerDispatcher

All Implemented Interfaces:

AuditEventHandler

Direct Known Subclasses:

InformationExtractionHandler

public class InformationExtractionHandlerDispatcher
extends AuditEventHandlerAdapter

InformationExtractionHandlerDispatcher implements the AuditEventHandler interface, and handles dispatching and overall control of events used to drive the creation of an NLP InformationExtraction.

Author:

Dave Long

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InformationExtractionHandlerDispatcher.DispatcherCallback DispatcherCallback is used to provide notifications of when handlers are disposed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_NAME_FINISHER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for FINISH phases (a SystemObject array specifying AuditSpecifications).
static String	PROPERTY_NAME_PARSER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for PARSE phases (a SystemObject array specifying AuditSpecifications).
static String	PROPERTY_NAME_PREPARER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for PREPARE phases (a SystemObject array specifying AuditSpecifications).
static String	PROPERTY_NAME_PRIORITY_FINISHER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for FINISH phases for high priority finishes.
static String	PROPERTY_NAME_PRIORITY_PARSER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for PARSE phases for high priority parses.
static String	PROPERTY_NAME_PRIORITY_PREPARER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for PREPARE phases for high priority prepares.
static String	PROPERTY_NAME_PRIORITY_SOLVER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for SOLVE phases for high priority solves.
static String	PROPERTY_NAME_PRIORITY_TRAINER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for TRAIN phases for high priority trains.
static String	PROPERTY_NAME_SOLVER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for SOLVE phases (a SystemObject array specifying AuditSpecifications).
static String	PROPERTY_NAME_TRAINER_HANDLERS Handler property that specifies the handlers that are the dispatch targets for TRAIN phases (a SystemObject array specifying AuditSpecifications).

Fields inherited from class oracle.ifs.core.handlers.AuditEventHandlerAdapter

DEFAULT_BATCHSIZE

Constructor Summary

Constructors

Constructor and Description
InformationExtractionHandlerDispatcher()

Method Summary

Modifier and Type	Method and Description
void	addCallback(String type, InformationExtractionHandlerDispatcher.DispatcherCallback callback) Add (register) a DispatcherCallback.
InformationExtractionHandlerDispatcher.DispatcherCallback	getCallback(String type) Gets a DispatcherCallback by type.
protected AuditSpecification[]	getFinisherHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the handlers to use for the FINISH phase.
IfsLogger	getLogger() Gets the logger, optionally from a subclass.
protected AuditSpecification	getNextFinisherHandler(InformationExtraction ext) Gets the next Handler for a FINISH.
protected AuditSpecification	getNextParserHandler(InformationExtraction ext) Gets the next Handler for a PARSE.
protected AuditSpecification	getNextPreparerHandler(InformationExtraction ext) Gets the next Handler for a PREPARE.
protected AuditSpecification	getNextSolverHandler(InformationExtraction ext) Gets the next Handler for a SOLVE.
protected AuditSpecification	getNextTrainerHandler(InformationExtraction ext) Gets the next Handler for a TRAIN.
protected AuditSpecification[]	getParserHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the handlers to use for the PARSE phase.
protected AuditSpecification[]	getPreparerHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the handlers to use for the PREPARE phase.
protected AuditSpecification[]	getPriorityFinisherHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the high-priority handlers to use for the FINISH phase.
protected AuditSpecification[]	getPriorityParserHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the high-priority handlers to use for the PARSE phase.
protected AuditSpecification[]	getPriorityPreparerHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the high-priority handlers to use for the PREPARE phase.
protected AuditSpecification[]	getPrioritySolverHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the high-priority handlers to use for the SOLVE phase.
protected AuditSpecification[]	getPriorityTrainerHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the high-priority handlers to use for the TRAIN phase.
protected AuditSpecification[]	getSolverHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the handlers to use for the SOLVE phase.
protected AuditSpecification[]	getTargetHandlersFromEventAssignmentTableList(InformationExtraction ext, SimplePropertyTableList sptl, String propName) Get the set of AuditSpecification objects identifying the handlers to use as dispatch targets, using the specified EventAssignmentTableList.
protected AuditSpecification[]	getTrainerHandlers(InformationExtraction ext) Get the set of AuditSpecification objects identifying the handlers to use for the TRAIN phase.
void	handleDispose(AuditEventHandlerContext context) Called when the AuditEventHandler instance will no longer be used.
void	handleEventPosted(AuditEventHandlerContext context) Called when at least one registered event is posted.
protected void	handleInformationExtractionPrepareRequested(InformationExtraction ext) Handle the PREPARE of an InformationExtraction.
void	handleInitialize(AuditEventHandlerContext context) Initializes this handler.
void	handleTimerExpired(AuditEventHandlerContext context) Called when the timer for this AuditEventHandler expires.
protected boolean	isDefaultHandlerSet(SimplePropertyTable spt) Return indication as to whether the specified handlerSet table from the EventAssignmentTableList is the default.
protected boolean	isMatchingHandlerSet(SimplePropertyTable spt, InformationExtraction ext) Return indication as to whether the specified InformationExtraction matches the specifcations in the specified handlerSet table from the EventAssignmentTableList
protected void	processEvent(AuditEventHandlerContext context, AuditEvent event) Process an event, either directly or by dispatching the event.
protected void	processScheduledExtractions(AuditEventHandlerContext context) Process any extractions that have been scheduled to run in the future.
void	removeCallback(String type) Remove (unregister) a DispatcherCallback.

Methods inherited from class oracle.ifs.core.handlers.AuditEventHandlerAdapter

deleteEvents, getAuditHandlerSpecification, getAuditSpecification, getHandlerProperty, processEvents, processEvents, selectEvents, selectEvents, selectMaximumEventId, setHandlerProperty

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME_PREPARER_HANDLERS

public static final String PROPERTY_NAME_PREPARER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for PREPARE phases (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

PROPERTY_NAME_PARSER_HANDLERS

public static final String PROPERTY_NAME_PARSER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for PARSE phases (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

PROPERTY_NAME_SOLVER_HANDLERS

public static final String PROPERTY_NAME_SOLVER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for SOLVE phases (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

PROPERTY_NAME_FINISHER_HANDLERS

public static final String PROPERTY_NAME_FINISHER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for FINISH phases (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

PROPERTY_NAME_TRAINER_HANDLERS

public static final String PROPERTY_NAME_TRAINER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for TRAIN phases (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

PROPERTY_NAME_PRIORITY_PREPARER_HANDLERS

public static final String PROPERTY_NAME_PRIORITY_PREPARER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for PREPARE phases for high priority prepares. (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

PROPERTY_NAME_PRIORITY_PARSER_HANDLERS

public static final String PROPERTY_NAME_PRIORITY_PARSER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for PARSE phases for high priority parses. (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

PROPERTY_NAME_PRIORITY_SOLVER_HANDLERS

public static final String PROPERTY_NAME_PRIORITY_SOLVER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for SOLVE phases for high priority solves. (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

PROPERTY_NAME_PRIORITY_FINISHER_HANDLERS

public static final String PROPERTY_NAME_PRIORITY_FINISHER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for FINISH phases for high priority finishes. (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

PROPERTY_NAME_PRIORITY_TRAINER_HANDLERS

public static final String PROPERTY_NAME_PRIORITY_TRAINER_HANDLERS

Handler property that specifies the handlers that are the dispatch targets for TRAIN phases for high priority trains. (a SystemObject array specifying AuditSpecifications).

See Also:

Constant Field Values

Constructor Detail

InformationExtractionHandlerDispatcher

public InformationExtractionHandlerDispatcher()

Method Detail

getLogger

public IfsLogger getLogger()

Gets the logger, optionally from a subclass.

Returns:

the logger

handleInitialize

public void handleInitialize(AuditEventHandlerContext context)
                      throws Exception

Description copied from class: AuditEventHandlerAdapter

Initializes this handler.

Called immediately after construction.

Specified by:

handleInitialize in interface AuditEventHandler

Overrides:

handleInitialize in class AuditEventHandlerAdapter

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

handleEventPosted

public void handleEventPosted(AuditEventHandlerContext context)
                       throws Exception

Description copied from class: AuditEventHandlerAdapter

Called when at least one registered event is posted.

Specified by:

handleEventPosted in interface AuditEventHandler

Overrides:

handleEventPosted in class AuditEventHandlerAdapter

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

handleTimerExpired

public void handleTimerExpired(AuditEventHandlerContext context)
                        throws Exception

Description copied from class: AuditEventHandlerAdapter

Called when the timer for this AuditEventHandler expires.

Specified by:

handleTimerExpired in interface AuditEventHandler

Overrides:

handleTimerExpired in class AuditEventHandlerAdapter

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

handleDispose

public void handleDispose(AuditEventHandlerContext context)
                   throws Exception

Description copied from class: AuditEventHandlerAdapter

Called when the AuditEventHandler instance will no longer be used.

The instance should release any resources it is holding that would not be automatically released as part of the object's garbage collection.

Specified by:

handleDispose in interface AuditEventHandler

Overrides:

handleDispose in class AuditEventHandlerAdapter

Parameters:

context - the AuditEventHandlerContext to use for processing

Throws:

Exception - if the operation fails

getCallback

public InformationExtractionHandlerDispatcher.DispatcherCallback getCallback(String type)

Gets a DispatcherCallback by type.

Parameters:

type - the callback type

addCallback

public void addCallback(String type,
                        InformationExtractionHandlerDispatcher.DispatcherCallback callback)

Add (register) a DispatcherCallback.

Parameters:

type - the callback type

callback - the callback

removeCallback

public void removeCallback(String type)

Remove (unregister) a DispatcherCallback.

Parameters:

type - the callback type

getPreparerHandlers

protected AuditSpecification[] getPreparerHandlers(InformationExtraction ext)
                                            throws IfsException

Get the set of AuditSpecification objects identifying the handlers to use for the PREPARE phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for PREPARE

Throws:

IfsException - if the operation fails

getParserHandlers

protected AuditSpecification[] getParserHandlers(InformationExtraction ext)
                                          throws IfsException

Get the set of AuditSpecification objects identifying the handlers to use for the PARSE phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for PARSE

Throws:

IfsException - if the operation fails

getSolverHandlers

protected AuditSpecification[] getSolverHandlers(InformationExtraction ext)
                                          throws IfsException

Get the set of AuditSpecification objects identifying the handlers to use for the SOLVE phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for SOLVE

Throws:

IfsException - if the operation fails

getFinisherHandlers

protected AuditSpecification[] getFinisherHandlers(InformationExtraction ext)
                                            throws IfsException

Get the set of AuditSpecification objects identifying the handlers to use for the FINISH phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for FINISH

Throws:

IfsException - if the operation fails

getTrainerHandlers

protected AuditSpecification[] getTrainerHandlers(InformationExtraction ext)
                                           throws IfsException

Get the set of AuditSpecification objects identifying the handlers to use for the TRAIN phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for TRAIN

Throws:

IfsException - if the operation fails

getPriorityPreparerHandlers

protected AuditSpecification[] getPriorityPreparerHandlers(InformationExtraction ext)
                                                    throws IfsException

Get the set of AuditSpecification objects identifying the high-priority handlers to use for the PREPARE phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for high-priority PREPARE

Throws:

IfsException - if the operation fails

getPriorityParserHandlers

protected AuditSpecification[] getPriorityParserHandlers(InformationExtraction ext)
                                                  throws IfsException

Get the set of AuditSpecification objects identifying the high-priority handlers to use for the PARSE phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for high-priority PARSE

Throws:

IfsException - if the operation fails

getPrioritySolverHandlers

protected AuditSpecification[] getPrioritySolverHandlers(InformationExtraction ext)
                                                  throws IfsException

Get the set of AuditSpecification objects identifying the high-priority handlers to use for the SOLVE phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for high-priority SOLVE

Throws:

IfsException - if the operation fails

getPriorityFinisherHandlers

protected AuditSpecification[] getPriorityFinisherHandlers(InformationExtraction ext)
                                                    throws IfsException

Get the set of AuditSpecification objects identifying the high-priority handlers to use for the FINISH phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for high-priority FINISH

Throws:

IfsException - if the operation fails

getPriorityTrainerHandlers

protected AuditSpecification[] getPriorityTrainerHandlers(InformationExtraction ext)
                                                   throws IfsException

Get the set of AuditSpecification objects identifying the high-priority handlers to use for the TRAIN phase.

Parameters:

ext - the InformationExtraction object being processed

Returns:

the AuditSpecification targets to use for high-priority TRAIN

Throws:

IfsException - if the operation fails

getTargetHandlersFromEventAssignmentTableList

protected AuditSpecification[] getTargetHandlersFromEventAssignmentTableList(InformationExtraction ext,
                                                                             SimplePropertyTableList sptl,
                                                                             String propName)
                                                                      throws IfsException

Get the set of AuditSpecification objects identifying the handlers to use as dispatch targets, using the specified EventAssignmentTableList.

Parameters:

ext - the InformationExtraction

sptl - the EventAssignmentTableList

propName - the SimpleProperty name within the handlerSet table

Returns:

the AuditSpecification targets to use

Throws:

IfsException - if the operation fails

isMatchingHandlerSet

protected boolean isMatchingHandlerSet(SimplePropertyTable spt,
                                       InformationExtraction ext)
                                throws IfsException

Return indication as to whether the specified InformationExtraction matches the specifcations in the specified handlerSet table from the EventAssignmentTableList

Parameters:

spt - the handlerSet table from the EventAssignmentTableList

ext - the InformationExtraction

Returns:

true if this handlerSet table matches the specified InformationExtraction

Throws:

IfsException - if the operation fails

isDefaultHandlerSet

protected boolean isDefaultHandlerSet(SimplePropertyTable spt)
                               throws IfsException

Return indication as to whether the specified handlerSet table from the EventAssignmentTableList is the default.

Parameters:

spt - the handlerSet table from the EventAssignmentTableList

Returns:

true if this handlerSet table is the default

Throws:

IfsException - if the operation fails

getNextPreparerHandler

protected AuditSpecification getNextPreparerHandler(InformationExtraction ext)
                                             throws IfsException

Gets the next Handler for a PREPARE.

Parameters:

ext - the InformationExtraction

Returns:

the Preparer handler to dispatch to, or null if the dispatcher should handle the event

Throws:

IfsException - if the operation fails

getNextParserHandler

protected AuditSpecification getNextParserHandler(InformationExtraction ext)
                                           throws IfsException

Gets the next Handler for a PARSE.

Parameters:

ext - the InformationExtraction

Returns:

the Parser handler to dispatch to, or null if the dispatcher should handle the event

Throws:

IfsException - if the operation fails

getNextSolverHandler

protected AuditSpecification getNextSolverHandler(InformationExtraction ext)
                                           throws IfsException

Gets the next Handler for a SOLVE.

Parameters:

ext - the InformationExtraction

Returns:

the Solver handler to dispatch to, or null if the dispatcher should handle the event

Throws:

IfsException - if the operation fails

getNextFinisherHandler

protected AuditSpecification getNextFinisherHandler(InformationExtraction ext)
                                             throws IfsException

Gets the next Handler for a FINISH.

Parameters:

ext - the InformationExtraction

Returns:

the Finisher handler to dispatch to, or null if the dispatcher should handle the event

Throws:

IfsException - if the operation fails

getNextTrainerHandler

protected AuditSpecification getNextTrainerHandler(InformationExtraction ext)
                                            throws IfsException

Gets the next Handler for a TRAIN.

Parameters:

ext - the InformationExtraction

Returns:

the Trainer handler to dispatch to, or null if the dispatcher should handle the event

Throws:

IfsException - if the operation fails

processScheduledExtractions

protected void processScheduledExtractions(AuditEventHandlerContext context)
                                    throws IfsException

Process any extractions that have been scheduled to run in the future.

Parameters:

context - the AuditEventHandlerContext to use for processing

session - the session context

Throws:

IfsException - if the operation fails

processEvent

protected void processEvent(AuditEventHandlerContext context,
                            AuditEvent event)
                     throws IfsException

Process an event, either directly or by dispatching the event.

Delete the event after processing.

Overrides:

processEvent in class AuditEventHandlerAdapter

Parameters:

context - the AuditEventHandlerContext to use for processing

event - the event to process

Throws:

IfsException - if the operation fails

handleInformationExtractionPrepareRequested

protected void handleInformationExtractionPrepareRequested(InformationExtraction ext)
                                                    throws IfsException

Handle the PREPARE of an InformationExtraction.

Parameters:

ext - the InformationExtraction

Throws:

IfsException - if the operation fails