org.asam.ods

Interface QueryOperations

All Known Subinterfaces:

Query

All Known Implementing Classes:

_QueryStub, Query, Query, QueryPOA

public interface QueryOperations

The ASAM ODS interface Query.

Method Summary

Methods

Modifier and Type	Method and Description
void	executeQuery(NameValue[] params) (26002) Execute query in asynchronous mode.
InstanceElementIterator	getInstances() (26004) Get the query result.
QueryEvaluator	getQueryEvaluator() (26000) Get the QueryEvaluator object which is responsible for this query.
QueryStatus	getStatus() (26003) Return query status.
NameValueSeqUnit[]	getTable() (26006) Get the query result.
NameValueUnitSequenceIterator	getTableRows() (26005) Get the query result.
void	prepareQuery(NameValue[] params) (26001) Do the query pre-processing (optimization, etc.)

Method Detail

getQueryEvaluator

QueryEvaluator getQueryEvaluator()
                                 throws AoException

(26000) Get the QueryEvaluator object which is responsible for this query.

Returns:

The QueryEvaluator object which is responsible for this query.

Throws:

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

prepareQuery

void prepareQuery(NameValue[] params)
                  throws AoException

(26001) Do the query pre-processing (optimization, etc.) Call can be omitted by the client. In this case the functionality is executed on the call of executeQuery.

Parameters:

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, this parameter is required if the parameters isn't given at the method createQuery of the interface QueryEvaluator. Default value: INSTELEM_ITERATOR_AS_RESULT

Throws:

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

executeQuery

void executeQuery(NameValue[] params)
                  throws AoException

(26002) Execute query in asynchronous mode.

Parameters:

params - Sequence of parameter names and values. The following parameter should be passed: Name: "QueryResultType"; Type: ResultType. Comment: Specifies what kind of result is expected by the client, this parameter is required if the parameters isn't given at the method prepareQuery or the method createQuery of the interface QueryEvaluator. Default value: INSTELEM_ITERATOR_AS_RESULT Name: "Synchronous"; Type: T_BOOLEAN Comment: In case of "true" guarantees synchronous execution. Default value: "false"

Throws:

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

getStatus

QueryStatus getStatus()
                      throws AoException

(26003) Return query status. Returns INCOMPLETE if the query is still executing. Returns COMPLETE if the query finished execution or if the query execution stopped because of an error or because the timeout was exceeded.

Returns:

The status of the query.

Throws:

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

getInstances

InstanceElementIterator getInstances()
                                     throws AoException

(26004) Get the query result. This method should only be called after the query has been executed. It returns an iterator on the instances that were found by the query.

Returns:

The result of the query as an instance element iterator.

Throws:

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

getTableRows

NameValueUnitSequenceIterator getTableRows()
                                           throws AoException

(26005) Get the query result. This method should only be called after the query has been executed. It returns an iterator on the name value unit sequence.

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_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_QUERY_PROCESSING_ERROR AO_QUERY_TIMEOUT_EXCEEDED AO_QUERY_INCOMPLETE AO_QUERY_INVALID_RESULTTYPE

getTable

NameValueSeqUnit[] getTable()
                            throws AoException

(26006) Get the query result. This method should only be called after the query has been executed. It returns the result as a structure.

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_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE AO_QUERY_PROCESSING_ERROR AO_QUERY_TIMEOUT_EXCEEDED AO_QUERY_INCOMPLETE AO_QUERY_INVALID_RESULTTYPE