com.qubole.qds.sdk.java.client

Class ResultLatch

java.lang.Object

com.qubole.qds.sdk.java.client.ResultLatch

public class ResultLatch
extends Object

A utility for polling for a command result. Allows for blocking or callback on a running query

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResultLatch.Callback Callback interface.

Constructor Summary

Constructors

Constructor and Description
ResultLatch(QdsClient client, int queryId)
ResultLatch(QdsClient client, String queryId)

Method Summary

Modifier and Type	Method and Description
void	await() Await indefinitely for the result
boolean	await(long maxWait, TimeUnit timeUnit) Await up to a maximum time for the result
ResultValue	awaitResult() Await indefinitely for the result
ResultValue	awaitResult(long maxWait, TimeUnit timeUnit) Await up to a maximum time for the result
void	callback(ResultLatch.Callback callback) This method returns immediately and polls asynchronously for the result.
void	setPollSleep(long time, TimeUnit unit) Change the time that the query status is polled.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultLatch

public ResultLatch(QdsClient client,
                   int queryId)

Parameters:

client - the client

queryId - the query

ResultLatch

public ResultLatch(QdsClient client,
                   String queryId)

Parameters:

client - the client

queryId - the query

Method Detail

setPollSleep

public void setPollSleep(long time,
                         TimeUnit unit)

Change the time that the query status is polled. The default is DEFAULT_POLL_MS.

Parameters:

time - polling time

unit - time unit

callback

public void callback(ResultLatch.Callback callback)

This method returns immediately and polls asynchronously for the result. When the result is retrieved (or there is an error) the callback is called

Parameters:

callback - callback

await

public void await()
           throws Exception

Await indefinitely for the result

Throws:

Exception - errors

await

public boolean await(long maxWait,
                     TimeUnit timeUnit)
              throws Exception

Await up to a maximum time for the result

Parameters:

maxWait - max wait time

timeUnit - time unit

Returns:

true if the result is ready, false if not or time has run out

Throws:

Exception - errors

awaitResult

public ResultValue awaitResult()
                        throws Exception

Await indefinitely for the result

Returns:

the result

Throws:

Exception - errors

awaitResult

public ResultValue awaitResult(long maxWait,
                               TimeUnit timeUnit)
                        throws Exception

Await up to a maximum time for the result

Parameters:

maxWait - max wait time

timeUnit - time unit

Returns:

the result

Throws:

Exception - errors