com.scooterframework.orm.sqldataexpress.processor
Interface DataProcessor

All Known Implementing Classes:

DataProcessorImpl, FunctionProcessor, JdbcStatementProcessor, StoredProcedureProcessor

public interface DataProcessor

DataProcessor interface.

Field Summary

static int	DEFAULT_PAGINATION_LIMIT Default limit number of records for pagination.
static java.lang.String	framework_input_key_prefix The following are reserved key words in inputs Map object.
static java.lang.String	input_key_database_connection_context Key to an instance of DatabaseConnectionContext.
static java.lang.String	input_key_database_connection_name Key to the database connection name as specified in the config/database.properties file.
static java.lang.String	input_key_max_row_index
static java.lang.String	input_key_min_row_index
static java.lang.String	input_key_records_fixed Specifies that the retrieved records number is fixed.
static java.lang.String	input_key_records_limit Specifies the number of desired records to be retrieved.
static java.lang.String	input_key_records_offset Specifies how many records to skip in the result set.
static java.lang.String	input_key_use_pagination Specified whether to use pagination.
static int	NO_ROW_LIMIT No retrieval limit.

Method Summary

OmniDTO	execute(UserDatabaseConnection udc, java.util.Map<java.lang.String,java.lang.Object> inputs) execute
OmniDTO	execute(UserDatabaseConnection udc, java.util.Map<java.lang.String,java.lang.Object> inputs, java.util.Map<java.lang.String,java.lang.String> outputFilters) execute with output filter

Field Detail

framework_input_key_prefix

static final java.lang.String framework_input_key_prefix

The following are reserved key words in inputs Map object. All keys must be in upper case.

See Also:

Constant Field Values

input_key_database_connection_name

static final java.lang.String input_key_database_connection_name

Key to the database connection name as specified in the config/database.properties file.

See Also:

Constant Field Values

input_key_database_connection_context

static final java.lang.String input_key_database_connection_context

Key to an instance of DatabaseConnectionContext.

See Also:

Constant Field Values

input_key_max_row_index

static final java.lang.String input_key_max_row_index

See Also:

Constant Field Values

input_key_min_row_index

static final java.lang.String input_key_min_row_index

See Also:

Constant Field Values

input_key_records_offset

static final java.lang.String input_key_records_offset

Specifies how many records to skip in the result set. This property must be used with input_key_records_limit property.

See Also:

Constant Field Values

input_key_records_limit

static final java.lang.String input_key_records_limit

Specifies the number of desired records to be retrieved. If the number of records retrieved is more than required, an exception will be thrown.

See Also:

Constant Field Values

input_key_records_fixed

static final java.lang.String input_key_records_fixed

Specifies that the retrieved records number is fixed. If the retrieved records number is not equal to the number of records specified by input_key_records_limit, an exception will be thrown.

See Also:

Constant Field Values

input_key_use_pagination

static final java.lang.String input_key_use_pagination

Specified whether to use pagination. If the value is true, then pagination is used.

See Also:

Constant Field Values

NO_ROW_LIMIT

static final int NO_ROW_LIMIT

No retrieval limit.

See Also:

Constant Field Values

DEFAULT_PAGINATION_LIMIT

static final int DEFAULT_PAGINATION_LIMIT

Default limit number of records for pagination.

See Also:

Constant Field Values

Method Detail

execute

OmniDTO execute(UserDatabaseConnection udc,
                java.util.Map<java.lang.String,java.lang.Object> inputs)
                throws BaseSQLException

execute

Throws:

BaseSQLException

execute

OmniDTO execute(UserDatabaseConnection udc,
                java.util.Map<java.lang.String,java.lang.Object> inputs,
                java.util.Map<java.lang.String,java.lang.String> outputFilters)
                throws BaseSQLException

execute with output filter

Throws:

BaseSQLException