org.apache.lens.api.query

Class QueryStatus

java.lang.Object

org.apache.lens.api.ToYAMLString

org.apache.lens.api.query.QueryStatus

All Implemented Interfaces:

Serializable, org.jvnet.jaxb2_commons.lang.ToString

public class QueryStatus
extends ToYAMLString
implements Serializable

Instantiates a new query status.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryStatus.Status The Enum Status.

Nested classes/interfaces inherited from class org.apache.lens.api.ToYAMLString

ToYAMLString.FieldNameAndValue

Constructor Summary

Constructors

Constructor and Description
QueryStatus(double progress, Integer queueNumber, QueryStatus.Status status, String statusMessage, boolean isResultSetAvailable, String progressMessage, String errorMessage, LensErrorTO lensErrorTO)

Method Summary

Modifier and Type	Method and Description
boolean	cancelled()
boolean	executed()
boolean	failed()
boolean	failing()
boolean	finished()
Integer	getErrorCode()
String	getErrorMessage() The error message.
LensErrorTO	getLensErrorTO()
String	getLensErrorTOErrorMsg()
double	getProgress() The progress.
String	getProgressMessage() The progress message.
static QueryStatus	getQueuedStatus()
Integer	getQueueNumber() Queue number of a query when it is in waiting state.
QueryStatus.Status	getStatus() The status.
String	getStatusMessage() The status message.
boolean	isResultSetAvailable() The is result set available.
boolean	isValidTransition(QueryStatus.Status newState) Checks if is validate transition.
static boolean	isValidTransition(QueryStatus.Status oldState, QueryStatus.Status newState) Checks if is valid transition.
boolean	launched()
boolean	queued()
boolean	running()
void	setErrorMessage(String errorMessage) The error message.
void	setProgressMessage(String progressMessage) The progress message.
void	setQueueNumber(Integer queueNumber) Queue number of a query when it is in waiting state.
boolean	successful()

Methods inherited from class org.apache.lens.api.ToYAMLString

append, appendFields, fromXMLString, getFieldsToAppend, toString, toXMLString

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryStatus

@ConstructorProperties(value={"progress","queueNumber","status","statusMessage","isResultSetAvailable","progressMessage","errorMessage","lensErrorTO"})
 @Generated(value="lombok")
public QueryStatus(double progress,
                                                                                                                                                                                                       Integer queueNumber,
                                                                                                                                                                                                       QueryStatus.Status status,
                                                                                                                                                                                                       String statusMessage,
                                                                                                                                                                                                       boolean isResultSetAvailable,
                                                                                                                                                                                                       String progressMessage,
                                                                                                                                                                                                       String errorMessage,
                                                                                                                                                                                                       LensErrorTO lensErrorTO)

Method Detail

finished

public boolean finished()

successful

public boolean successful()

launched

public boolean launched()

running

public boolean running()

queued

public boolean queued()

failed

public boolean failed()

failing

public boolean failing()

cancelled

public boolean cancelled()

executed

public boolean executed()

isValidTransition

public static boolean isValidTransition(QueryStatus.Status oldState,
                                        QueryStatus.Status newState)

Checks if is valid transition.

Parameters:

oldState - the old state

newState - the new state

Returns:

true, if is valid transition

isValidTransition

public boolean isValidTransition(QueryStatus.Status newState)

Checks if is validate transition.

Parameters:

newState - the new state

Returns:

true, if is validate transition

getErrorCode

public Integer getErrorCode()

getLensErrorTOErrorMsg

public String getLensErrorTOErrorMsg()

getQueuedStatus

public static QueryStatus getQueuedStatus()

getProgress

@Generated(value="lombok")
public double getProgress()

The progress.

getQueueNumber

@Generated(value="lombok")
public Integer getQueueNumber()

Queue number of a query when it is in waiting state.

setQueueNumber

@Generated(value="lombok")
public void setQueueNumber(Integer queueNumber)

Queue number of a query when it is in waiting state.

getStatus

@Generated(value="lombok")
public QueryStatus.Status getStatus()

The status.

getStatusMessage

@Generated(value="lombok")
public String getStatusMessage()

The status message.

isResultSetAvailable

@Generated(value="lombok")
public boolean isResultSetAvailable()

The is result set available.

getProgressMessage

@Generated(value="lombok")
public String getProgressMessage()

The progress message.

setProgressMessage

@Generated(value="lombok")
public void setProgressMessage(String progressMessage)

The progress message.

getErrorMessage

@Generated(value="lombok")
public String getErrorMessage()

The error message.

setErrorMessage

@Generated(value="lombok")
public void setErrorMessage(String errorMessage)

The error message.

getLensErrorTO

@Generated(value="lombok")
public LensErrorTO getLensErrorTO()