oracle.ifs.utils.action

Class ActionQueueCreator

java.lang.Object

oracle.ifs.utils.action.ActionQueueCreator

public class ActionQueueCreator
extends Object

Copyright (c) 2002, 2008, Oracle. All rights reserved. ActionQueueCreator creates an ActionQueue from an XML list of actions. To create an ActionQueue from an XML source, one of the variants of createActionQueue() should be called passing it the source.
The actions added to the ActionQueue will be of type Action. Clients can override createAction(), which is called to process each action tag, to create their own custom Actions.
The default element is defined as follows:







Actions can wrapped by multiple conditions. Only if all the conditions surrounding an action evaluate to true, the action is added to the ActionQueue. Conditions evaluate to true if (left op right) is successfule. Valid operations and their semantics for success are defined in the specific implementations of ActionConditions, which are identified by the type attribute. The element is defined as follows:





Finally, as a convenience, default properties can be assigned to each action in the XML file. The default properties can be specified using a elements. An action can override a specific defaulted property by listing the property in its body. The element is defined as follows:

The XML input should only contain a list of actions and conditions, and possibly a set of default properties to be applied to all actions:

Author:

Boulos Harb

Modified:

bharb 1/18/2002 Created. 2018-10-25 tschnell Remove oracle parser dependency

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_TAG The "action" tag in the XML action list file.
static String	CLASS_TAG The "class" tag in the XML action list file indicating the fully qualified class name that represents the action specified by the ACTION_TAG
static String	CONDITION_TAG The "condition" tag in the XML action list file.
static String	CONDITION_TYPE An attribute of the CONDITION_TAG.
static String	DEFAULTS_TAG The "defaults" tag in the XML action list file.
static String	DESCRIPTION The DESCRIPTION is an optional attribute of the ACTION_TAG.
static String	LABEL The LABEL is an attribute of the ACTION_TAG.
static String	LEFT_OPERAND An attribute of the CONDITION_TAG.
protected Substitutor	m_Substitutor The Substitutor used to substitute values extracted from the XML file.
static String	NAME An attribute of the PROPERTY_TAG representing the name of the property the action expects.
static String	NO Common false value for boolean attributes.
static String	OPERATION An attribute of the CONDITION_TAG.
static String	PROPERTY_TAG The "property" tag in the XML action list file.
static String	RIGHT_OPERAND An attribute of the CONDITION_TAG.
static String	VALUE An attribute of the PROPERTY_TAG representing the value of the property the action expects.
static String	YES Common true value for boolean attributes.

Constructor Summary

Constructors

Constructor and Description
ActionQueueCreator() Creates an instance of an ActionQueueCreator
ActionQueueCreator(Substitutor substitutor) Creates an instance of an ActionQueueCreator with a Substitutor.

Method Summary

Modifier and Type	Method and Description
protected Action	createAction(Element actionElement) Creates an Action from the XMLElement provided.
ActionQueue	createActionQueue(InputSource xmlInput) Creates an ActionQueue representing the XML list of actions provided.
ActionQueue	createActionQueue(InputStream xmlInput) Creates an ActionQueue representing the XML list of actions provided.
ActionQueue	createActionQueue(Reader xmlInput) Creates an ActionQueue representing the XML list of actions provided.
ActionQueue	createActionQueue(String xmlInput) Creates an ActionQueue representing the XML list of actions provided.
ActionQueue	createActionQueue(URL xmlInput) Creates an ActionQueue representing the XML list of actions provided.
protected String	sub(String value) Passes the value through the Substitutor if one is provided.

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_TAG

public static final String ACTION_TAG

The "action" tag in the XML action list file. An action should contain a LABEL attribute. It includes an associated CLASS_TAG and an optional set of PROPERTY_TAG's.

See Also:

Constant Field Values

CLASS_TAG

public static final String CLASS_TAG

The "class" tag in the XML action list file indicating the fully qualified class name that represents the action specified by the ACTION_TAG

See Also:

Constant Field Values

PROPERTY_TAG

public static final String PROPERTY_TAG

The "property" tag in the XML action list file. Properties are optional. If present, a PROPERTY_TAG should include NAME and VALUE attributes.

See Also:

Constant Field Values

NAME

public static final String NAME

An attribute of the PROPERTY_TAG representing the name of the property the action expects.

See Also:

Constant Field Values

VALUE

public static final String VALUE

An attribute of the PROPERTY_TAG representing the value of the property the action expects.

See Also:

Constant Field Values

LABEL

public static final String LABEL

The LABEL is an attribute of the ACTION_TAG.

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

The DESCRIPTION is an optional attribute of the ACTION_TAG.

See Also:

Constant Field Values

CONDITION_TAG

public static final String CONDITION_TAG

The "condition" tag in the XML action list file. A condition should contain CONDITION_TYPE, OPERATION, LEFT_OPERAND, and RIGHT_OPERAND attributes, which are all required.

See Also:

Constant Field Values

CONDITION_TYPE

public static final String CONDITION_TYPE

An attribute of the CONDITION_TAG. Identifies the specific type of ActionCondition used to evaluate the OPERATION on the LEFT_OPERNAD and RIGHT_OPERAND.

See Also:

Constant Field Values

OPERATION

public static final String OPERATION

An attribute of the CONDITION_TAG. Identifies the operation executed on the LEFT_OPERAND and RIGHT_OPERAND. Valid operations and their semantics are defined by the specific implemnetations of ActionCondition identified by the CONDITION_TYPE attribute.

See Also:

Constant Field Values

LEFT_OPERAND

public static final String LEFT_OPERAND

An attribute of the CONDITION_TAG. Identifies the left operand.

See Also:

Constant Field Values

RIGHT_OPERAND

public static final String RIGHT_OPERAND

An attribute of the CONDITION_TAG. Identifies the right operand.

See Also:

Constant Field Values

DEFAULTS_TAG

public static final String DEFAULTS_TAG

The "defaults" tag in the XML action list file. Contains default properties to be set on every action in the file. Optional.

See Also:

Constant Field Values

YES

public static final String YES

Common true value for boolean attributes. Equals "yes".

See Also:

Constant Field Values

NO

public static final String NO

Common false value for boolean attributes. Equals "no".

See Also:

Constant Field Values

m_Substitutor

protected Substitutor m_Substitutor

The Substitutor used to substitute values extracted from the XML file.

Constructor Detail

ActionQueueCreator

public ActionQueueCreator()

Creates an instance of an ActionQueueCreator

ActionQueueCreator

public ActionQueueCreator(Substitutor substitutor)

Creates an instance of an ActionQueueCreator with a Substitutor. Tag and attribute values are passed through the substiute method of the Substitutor before being set on the Actions added to the ActionQueue.

Method Detail

createActionQueue

public final ActionQueue createActionQueue(InputSource xmlInput)
                                    throws ActionProcessingException,
                                           SAXException,
                                           IOException

Creates an ActionQueue representing the XML list of actions provided.

Parameters:

xmlInput - InputSource containing an XML representation of the list of actions

Returns:

ActionQueue contiaing the list of actions. The queue will be empty if there are no actions specified.

Throws:

ActionProcessingException - If an error occurred while processing an action tag and creating the the corrosponding Action, possibly wrapping another exception.

SAXException - If any SAX error or warning is encountered while processing the XML input, possibly wrapping another exception.

IOException - If an IO error is encountered in the XML input.

See Also:

#createAction(XMLElement)

createActionQueue

public final ActionQueue createActionQueue(InputStream xmlInput)
                                    throws ActionProcessingException,
                                           SAXException,
                                           IOException

Creates an ActionQueue representing the XML list of actions provided.

Parameters:

xmlInput - InputStream containing an XML representation of the list of actions

Returns:

ActionQueue contiaing the list of actions. The queue will be empty if there are no actions specified.

Throws:

ActionProcessingException - If an error occurred while processing an action tag and creating the the corrosponding Action, possibly wrapping another exception.

SAXException - If any SAX error or warning is encountered while processing the XML input, possibly wrapping another exception.

IOException - If an IO error is encountered in the XML input.

See Also:

#createAction(XMLElement)

createActionQueue

public final ActionQueue createActionQueue(Reader xmlInput)
                                    throws ActionProcessingException,
                                           SAXException,
                                           IOException

Creates an ActionQueue representing the XML list of actions provided.

Parameters:

xmlInput - Reader containing an XML representation of the list of actions

Returns:

ActionQueue contiaing the list of actions. The queue will be empty if there are no actions specified.

Throws:

ActionProcessingException - If an error occurred while processing an action tag and creating the the corrosponding Action, possibly wrapping another exception.

SAXException - If any SAX error or warning is encountered while processing the XML input, possibly wrapping another exception.

IOException - If an IO error is encountered in the XML input.

See Also:

#createAction(XMLElement)

createActionQueue

public final ActionQueue createActionQueue(URL xmlInput)
                                    throws ActionProcessingException,
                                           SAXException,
                                           IOException

Creates an ActionQueue representing the XML list of actions provided.

Parameters:

xmlInput - URL pointing to an XML representation of the list of actions

Returns:

ActionQueue contiaing the list of actions. The queue will be empty if there are no actions specified.

Throws:

ActionProcessingException - If an error occurred while processing an action tag and creating the the corrosponding Action, possibly wrapping another exception.

SAXException - If any SAX error or warning is encountered while processing the XML input, possibly wrapping another exception.

IOException - If an IO error is encountered in the XML input.

See Also:

#createAction(XMLElement)

createActionQueue

public final ActionQueue createActionQueue(String xmlInput)
                                    throws ActionProcessingException,
                                           SAXException,
                                           IOException

Creates an ActionQueue representing the XML list of actions provided.

Parameters:

xmlInput - String containing an XML representation of the list of actions

Returns:

ActionQueue contiaing the list of actions. The queue will be empty if there are no actions specified.

Throws:

ActionProcessingException - If an error occurred while processing an action tag and creating the the corrosponding Action, possibly wrapping another exception.

SAXException - If any SAX error or warning is encountered while processing the XML input, possibly wrapping another exception.

IOException - If an IO error is encountered in the XML input.

See Also:

#createAction(XMLElement)

createAction

protected Action createAction(Element actionElement)
                       throws ActionProcessingException

Creates an Action from the XMLElement provided. The XMLElement is an XML DOM Node representing one action in the XML input. This method is used by createActionQueue() to process each action tag in the XML input and produce corrosponding Actions that are added to the ActionQueue. The default implementation fills in the Action's name, and fills in the Action's description and property list if they exist. If a Substitutor is provided in the constructor, all values are passed through its substitute() method before being set on the Action. If null is returned by this method, the action tag provided is ignored.

Parameters:

actionElement - XML DOM Node representing an tag in the XML.

Returns:

Action An Action Object representing the tag provided. If null is returned, the ActionQueue will not be modified.

Throws:

ActionProcessingException - If an error occurred while processing the action tag and creating the Action, possibly wrapping another exception. The default implementation wraps one of the following:

• ClassNotFoundException If the class found in the CLASS_TAG of the action is invalid or cannot be found.
• InstantiationException If the class found in the CLASS_TAG represents an abstract class, an interface, an array class, a primitive type, or void; or if the instantiation fails for some other reason.
• IllegalAccessException If the class specified in the CLASS_TAG is not accessible.

See Also:

createActionQueue(String)

sub

protected String sub(String value)

Passes the value through the Substitutor if one is provided.