| org.pentaho.core.component.IPreparedComponent
All known Subclasses: org.pentaho.plugin.hql.HQLBaseComponent, org.pentaho.plugin.sql.SQLBaseComponent, org.pentaho.plugin.xquery.XQueryBaseComponent, org.pentaho.plugin.mdx.MDXBaseComponent,
| IPreparedComponent | | public interface IPreparedComponent extends IComponent,IDisposable(Code) | | The prepared component interface extends component,
allowing components to go into a prepared state vs. execute
state. These components may place themselves as an output
parameter, and then be used later in the action-sequence
for execution of prepared statements / etc.
author:
Will Gorman
See Also: MDXBaseComponent
See Also: SQLBaseComponent
See Also: IPentahoResultSet |
| Method Summary | |
| public void | dispose()
| | public IPentahoResultSet | executePrepared(Map preparedParams)
executes a prepared method that returns a result set
executePrepared looks up any "PREPARELATER" params
in the preparedParams map.
Parameters:
preparedParams - a map of possible parameters. | | public IPentahoConnection | shareConnection()
exposes the connection object for others to use. |
| PREPARED_COMPONENT_NAME | | final public static String PREPARED_COMPONENT_NAME(Code) | | The name of the output. If this appears as an output of
an IPreparedComponent the component should alter its
behavior and go into prepared mode.
|
| PREPARED_OUTPUT_TYPE | | final public static String PREPARED_OUTPUT_TYPE(Code) | | The type of the output. If this appears in an output of an
IPreparedComponent the component should alter its behavior
and go into prepared mode.
|
| PREPARE_LATER_INTER_PREFIX | | final public static String PREPARE_LATER_INTER_PREFIX(Code) | | this is an intermediate term used when resolving parameters
in the executePrepared call
|
| PREPARE_LATER_PLACEHOLDER | | final public static String PREPARE_LATER_PLACEHOLDER(Code) | | A placeholder for template strings and potential prepared lists, so
template fields can be replaced on the fly vs. during initial setup
of a prepared statement
|
| PREPARE_LATER_PREFIX | | final public static String PREPARE_LATER_PREFIX(Code) | | this term may appear when resolving parameters
"{PREPARELATER:PARAM_NAME}"
|
| dispose | | public void dispose()(Code) | | Disposes of resources held by the prepared component
|
| executePrepared | | public IPentahoResultSet executePrepared(Map preparedParams)(Code) | | executes a prepared method that returns a result set
executePrepared looks up any "PREPARELATER" params
in the preparedParams map.
Parameters:
preparedParams - a map of possible parameters. result set |
| shareConnection | | public IPentahoConnection shareConnection()(Code) | | exposes the connection object for others to use. The connection object in a prepared
component is not closed until parameters are disposed at the end of an action sequence
execution.
Note: getConnection was already in use when naming this method.
connection object |
|
|