at.srfg.miner.clientlib

Class SingleProxyQuery

Object

at.srfg.miner.clientlib.SingleProxyQuery

All Implemented Interfaces:

Query

public class SingleProxyQuery
extends Object
implements Query

A Query implementation that is bound to exactly 1 ToolProxy.

Constructor Summary

Constructors

Constructor and Description
SingleProxyQuery(Execution exec, ResultHandle handle) Constructs a new instance from an execution and a resultHandle.
SingleProxyQuery(Execution exec, ResultHandle handle, Proxy proxy) Constructs a new instance.
SingleProxyQuery(Execution exec, ResultHandle handle, String queryString) Constructs a new instance from an execution, a resultHandle, and a queryString.
SingleProxyQuery(int execId, int scenarioId, int taskId, int actionId, int handleId, String resultName, String resultSelector, String datatype, String savePattern, Proxy proxy, String queryString) Constructs a new instance from the given identifiers and strings.

Method Summary

Methods

Modifier and Type	Method and Description
int	getLimit() Gets the query limit of this query.
String	getResultName() Gets the name of the underlying ResultHandle.
String	getResultSelector() Gets the selector of the underlying ResultHandle.
boolean	hasNext() Checks if there are results that have not yet been retrieved.
List<Result>	nextResultBlock() Incrementally retrieves the next chunk of results.
List<Result>	nextResults() This is a convenience method that repeatedly invokes Query.nextResultBlock() as long as Query.hasNext() returns true.
void	reset() Resets the query such that the internal result pointer offset is set to 0.
void	setLimit(int limit) Sets a limit for the maximum number of result instances that are retrieved per invocation of Query.nextResults() with this query.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleProxyQuery

public SingleProxyQuery(Execution exec,
                ResultHandle handle)

Constructs a new instance from an execution and a resultHandle. The construction fails if handle is not associated with exactly 1 proxy from which results have to be queried, see Action.addProxy(String) and ResultHandle.setQueryProxies(Proxy...).

Parameters:

exec - the execution

handle - the resultHandle

Throws:

IllegalStateException - if the resultHandle does not have exactly 1 proxy whose results have to be retrieved.

SingleProxyQuery

public SingleProxyQuery(Execution exec,
                ResultHandle handle,
                String queryString)

Constructs a new instance from an execution, a resultHandle, and a queryString. The construction fails if handle is not associated with exactly 1 proxy from which results have to be queried, see Action.addProxy(String) and ResultHandle.setQueryProxies(Proxy...).

Parameters:

exec - the execution

handle - the resultHandle

queryString - the queryString

Throws:

IllegalStateException - if the resultHandle does not have exactly 1 proxy whose results have to be retrieved.

SingleProxyQuery

public SingleProxyQuery(Execution exec,
                ResultHandle handle,
                Proxy proxy)

Constructs a new instance. Subsequent queries will get results that have been produced at the ToolProxy proxy Other proxies that may be associated with handle are not considered.

Parameters:

exec - the execution

handle - the resultHandle

proxy - the proxy whose results have to be queried

SingleProxyQuery

public SingleProxyQuery(int execId,
                int scenarioId,
                int taskId,
                int actionId,
                int handleId,
                String resultName,
                String resultSelector,
                String datatype,
                String savePattern,
                Proxy proxy,
                String queryString)

Constructs a new instance from the given identifiers and strings. The result query is bound to proxy.

Parameters:

execId - the execution Id

scenarioId - the scenario Id

taskId - the task Id

actionId - the action Id

handleId - the resulthandle Id

resultName - the result name

resultSelector - the result selector

datatype - the result type

savePattern - for pattern for saving binary results

proxy - the proxy whose results will be queried

queryString - the queryString

Method Detail

setLimit

public void setLimit(int limit)

Description copied from interface: Query

Sets a limit for the maximum number of result instances that are retrieved per invocation of Query.nextResults() with this query.

Specified by:

setLimit in interface Query

Parameters:

limit - the query limit

getLimit

public int getLimit()

Description copied from interface: Query

Gets the query limit of this query. Note that this does not get the limit which my be imposed by the server (and which overrides any query limit by a client).

Specified by:

getLimit in interface Query

Returns:

the limit of this query

hasNext

public boolean hasNext()
                throws at.srfg.miner.exception.MinerException

Checks if there are results that have not yet been retrieved.

This implementation doesn't necessarily make a query at the server. The query is skipped if it is known from the previous invocation of getResults that more results are available.

Specified by:

hasNext in interface Query

Returns:

true if more results are available, false otherwise.

Throws:

at.srfg.miner.exception.MinerException

nextResults

public List<Result> nextResults()
                         throws at.srfg.miner.exception.MinerException

Description copied from interface: Query

This is a convenience method that repeatedly invokes Query.nextResultBlock() as long as Query.hasNext() returns true. It thus retrieves all results that became available since the last result query, even if the number is higher than a local or server imposed limit.

WARNING: if there are many new results at the server, this call may lead to a heap space problem!

Specified by:

nextResults in interface Query

Returns:

An unsorted list of all new results. If there aren't any, an empty list is returned (but never null).

Throws:

at.srfg.miner.exception.MinerException

nextResultBlock

public List<Result> nextResultBlock()
                             throws at.srfg.miner.exception.MinerException

Description copied from interface: Query

Incrementally retrieves the next chunk of results. Note that there are possibly more results available than returned by the method. This can happen if the server imposed limit or the limit set by the user (see Query.setLimit(int)) is smaller than the number of results that became available since the last invocation of Query.nextResultBlock().

Specified by:

nextResultBlock in interface Query

Returns:

An unsorted list of new results, possibly limited by a local or server imposed limit. If there aren't any, an empty list is returned (but never null).

Throws:

at.srfg.miner.exception.MinerException

reset

public void reset()

Description copied from interface: Query

Resets the query such that the internal result pointer offset is set to 0. Thus, the next invocation of Query.hasNext() and Query.nextResults() will return results starting from the very first one, not the next result since the last use of the Query. The limit and queryString are not affected by the reset.

Specified by:

reset in interface Query

getResultName

public String getResultName()

Description copied from interface: Query

Gets the name of the underlying ResultHandle.

Specified by:

getResultName in interface Query

Returns:

the name of the ResultHandle

getResultSelector

public String getResultSelector()

Description copied from interface: Query

Gets the selector of the underlying ResultHandle.

Specified by:

getResultSelector in interface Query

Returns:

the selector