org.asam.ods

Class _QueryStub

java.lang.Object

org.omg.CORBA.portable.ObjectImpl

org.asam.ods._QueryStub

All Implemented Interfaces:

java.io.Serializable, Query, QueryOperations, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity

public class _QueryStub
extends org.omg.CORBA.portable.ObjectImpl
implements Query

The ASAM ODS interface Query.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
_QueryStub()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	_ids()
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.)

Methods inherited from class org.omg.CORBA.portable.ObjectImpl

_create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Constructor Detail

_QueryStub

public _QueryStub()

Method Detail

getQueryEvaluator

public QueryEvaluator getQueryEvaluator()
                                 throws AoException

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

Specified by:

getQueryEvaluator in interface QueryOperations

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

public 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.

Specified by:

prepareQuery in interface QueryOperations

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

public void executeQuery(NameValue[] params)
                  throws AoException

(26002) Execute query in asynchronous mode.

Specified by:

executeQuery in interface QueryOperations

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

public 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.

Specified by:

getStatus in interface QueryOperations

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

public 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.

Specified by:

getInstances in interface QueryOperations

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

public 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.

Specified by:

getTableRows in interface QueryOperations

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

public 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.

Specified by:

getTable in interface QueryOperations

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

_ids

public java.lang.String[] _ids()

Specified by:

_ids in class org.omg.CORBA.portable.ObjectImpl