org.asam.ods

Interface QueryEvaluatorOperations

All Known Subinterfaces:

QueryEvaluator

All Known Implementing Classes:

_QueryEvaluatorStub, QueryEvaluator, QueryEvaluator, QueryEvaluatorPOA

public interface QueryEvaluatorOperations

The ASAM ODS query evaluator interface allows to perform queries in synchronous mode and to create Query objects for asynchronous execution.

Method Summary

Methods

Modifier and Type	Method and Description
Query	createQuery(java.lang.String queryStr, NameValue[] params) (25003) Create a query object to execute it in asynchronous mode.
InstanceElementIterator	getInstances(java.lang.String queryStr, NameValue[] params) (25000) Evaluate a query in synchronous mode.
NameValueSeqUnit[]	getTable(java.lang.String queryStr, NameValue[] params) (25002) Evaluate a query in synchronous mode.
NameValueUnitSequenceIterator	getTableRows(java.lang.String queryStr, NameValue[] params) (25001) Evaluate a query in synchronous mode.

Method Detail

getInstances

InstanceElementIterator getInstances(java.lang.String queryStr,
                                   NameValue[] params)
                                     throws AoException

(25000) Evaluate a query in synchronous mode.

Parameters:

queryStr - The query string.

params - Sequence of parameter names and values. The following parameters should be passed: Name: "MaxDuration"; Type: T_LONG Comment: Can be used to restrict the processing time. The time is given in milliseconds, Default value: 0 (no restriction)

Returns:

The result of the query as an instance element iterator.

Throws:

AoException - with the following possible error codes: AO_QUERY_TYPE_INVALID AO_QUERY_INVALID AO_QUERY_PROCESSING_ERROR AO_QUERY_TIMEOUT_EXCEEDED AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getTableRows

NameValueUnitSequenceIterator getTableRows(java.lang.String queryStr,
                                         NameValue[] params)
                                           throws AoException

(25001) Evaluate a query in synchronous mode.

Parameters:

queryStr - The query string.

params - Sequence of parameter names and values. The following parameters should be passed: Name: "MaxDuration"; Type: T_LONG Comment: Can be used to restrict the processing time. The time is given in milliseconds, Default value: 0 (no restriction)

Returns:

The result of the query as a name value unit sequence iterator. Each name value unit tuple is one cell of the table. The name value unit sequence is one row of the table.

Throws:

AoException - with the following possible error codes: AO_QUERY_TYPE_INVALID AO_QUERY_INVALID AO_QUERY_PROCESSING_ERROR AO_QUERY_TIMEOUT_EXCEEDED AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getTable

NameValueSeqUnit[] getTable(java.lang.String queryStr,
                          NameValue[] params)
                            throws AoException

(25002) Evaluate a query in synchronous mode.

Parameters:

queryStr - The query string.

params - Sequence of parameter names and values. The following parameters should be passed: Name: "MaxDuration"; Type: T_LONG Comment: Can be used to restrict the processing time. The time is given in milliseconds, Default value: 0 (no restriction)

Returns:

The result of the query as a name value sequence unit sequence. Each name value sequence unit tuple is one column of the table. The name value sequence unit sequence is the table. The result structure can be very huge.

Throws:

AoException - with the following possible error codes: AO_QUERY_TYPE_INVALID AO_QUERY_INVALID AO_QUERY_PROCESSING_ERROR AO_QUERY_TIMEOUT_EXCEEDED AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

createQuery

Query createQuery(java.lang.String queryStr,
                NameValue[] params)
                  throws AoException

(25003) Create a query object to execute it in asynchronous mode.

Parameters:

queryStr - The query string

params - Sequence of parameter names and values. The following parameters should be passed: Name: "QueryResultType"; Type: ResultType. Comment: Specifies what kind of result is expected by the client. Default value: INSTELEM_ITERATOR_AS_RESULT Name: "MaxDuration"; Type: T_LONG Comment: Can be used to restrict the processing time. The time is given in milliseconds, Default value: 0 (no restriction)

Returns:

The query object.

Throws:

AoException - with the following possible error codes: AO_QUERY_TYPE_INVALID AO_QUERY_INVALID AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE