com.microsoft.azure.storage.table

Class QueryTableOperation

java.lang.Object

com.microsoft.azure.storage.table.TableOperation

com.microsoft.azure.storage.table.QueryTableOperation

public class QueryTableOperation
extends TableOperation

A class that extends TableOperation to implement a query to retrieve a single table entity. To execute a QueryTableOperation instance, call the execute method on a CloudTableClient instance. This operation can be executed directly or as part of a TableBatchOperation. If the QueryTableOperation returns an entity result, it is stored in the corresponding TableResult returned by the execute method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryTableOperation() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected Class<? extends TableEntity>	getClazzType() Reserved for internal use.
String	getPartitionKey() Gets the PartitionKey value for the entity to retrieve.
EntityResolver<?>	getResolver() Gets the resolver to project the entity retrieved as a particular type.
String	getRowKey() Gets the RowKey value for the entity to retrieve.
protected boolean	isPrimaryOnlyRetrieve()
protected TableResult	parseResponse(InputStream inStream, int httpStatusCode, String etagFromHeader, OperationContext opContext, TableRequestOptions options) Reserved for internal use.
protected TableResult	performRetrieve(CloudTableClient client, String tableName, TableRequestOptions options, OperationContext opContext) Reserved for internal use.
protected void	setClazzType(Class<? extends TableEntity> clazzType) Reserved for internal use.
protected void	setPartitionKey(String partitionKey) Reserved for internal use.
protected void	setPrimaryOnlyRetrieve(boolean isPrimaryOnlyRetrieve)
protected void	setResolver(EntityResolver<?> resolver) Reserved for internal use.
protected void	setRowKey(String rowKey) Reserved for internal use.

Methods inherited from class com.microsoft.azure.storage.table.TableOperation

delete, execute, generateRequestIdentity, generateRequestIdentityWithTable, getEchoContent, getEntity, getOperationType, insert, insert, insertOrMerge, insertOrReplace, merge, replace, retrieve, retrieve, setEchoContent, setEntity

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryTableOperation

protected QueryTableOperation()

Default constructor.

Method Detail

getPartitionKey

public String getPartitionKey()

Gets the PartitionKey value for the entity to retrieve.

Returns:

A String containing the PartitionKey value for the entity.

getResolver

public EntityResolver<?> getResolver()

Gets the resolver to project the entity retrieved as a particular type.

Returns:

The EntityResolver instance.

getRowKey

public String getRowKey()

Gets the RowKey value for the entity to retrieve.

Returns:

A String containing the RowKey value for the entity.

getClazzType

protected Class<? extends TableEntity> getClazzType()

Reserved for internal use. Gets the class type of the entity returned by the query.

Returns:

The java.lang.Class implementing TableEntity that represents the entity type for the query.

parseResponse

protected TableResult parseResponse(InputStream inStream,
                                    int httpStatusCode,
                                    String etagFromHeader,
                                    OperationContext opContext,
                                    TableRequestOptions options)
                             throws InstantiationException,
                                    IllegalAccessException,
                                    StorageException,
                                    com.fasterxml.jackson.core.JsonParseException,
                                    IOException

Reserved for internal use. Parses the table operation response into a TableResult to return.

Overrides:

parseResponse in class TableOperation

Parameters:

inStream - An InputStream containing the response to a query operation.

httpStatusCode - The HTTP status code returned from the operation request.

etagFromHeader - The String containing the Etag returned with the operation response.

opContext - An OperationContext object that represents the context for the current operation.

Returns:

The TableResult representing the result of the query operation.

Throws:

InstantiationException - if an error occurs in object construction.

IllegalAccessException - if an error occurs in reflection on an object type.

StorageException - if an error occurs in the storage operation.

IOException - if an error occurs while accessing the InputStream with Json.

com.fasterxml.jackson.core.JsonParseException - if an error occurs while parsing the Json, if Json is used.

performRetrieve

protected TableResult performRetrieve(CloudTableClient client,
                                      String tableName,
                                      TableRequestOptions options,
                                      OperationContext opContext)
                               throws StorageException

Reserved for internal use. Performs a retrieve operation on the specified table, using the specified TableRequestOptions and OperationContext.

This method will invoke the Storage Service REST API to execute this table operation, using the Table service endpoint and storage account credentials in the CloudTableClient object.

Parameters:

client - A CloudTableClient instance specifying the Table service endpoint and storage account credentials to use.

tableName - A String containing the name of the table to query.

options - A TableRequestOptions object that specifies execution options such as retry policy and timeout settings for the operation.

opContext - An OperationContext object for tracking the current operation.

Returns:

A TableResult containing the results of executing the query operation.

Throws:

StorageException - if an error occurs in the storage operation.

setClazzType

protected void setClazzType(Class<? extends TableEntity> clazzType)

Reserved for internal use. Sets the class type of the entity returned by the query.

Parameters:

clazzType - The java.lang.Class implementing TableEntity that represents the entity type for the query.

setPartitionKey

protected void setPartitionKey(String partitionKey)

Reserved for internal use. Sets the PartitionKey value for the entity to retrieve.

Parameters:

partitionKey - A String containing the PartitionKey value for the entity.

setResolver

protected void setResolver(EntityResolver<?> resolver)

Reserved for internal use. Sets the resolver to project the entity retrieved as a particular type.

Parameters:

resolver - The EntityResolver instance to use.

setRowKey

protected void setRowKey(String rowKey)

Reserved for internal use. Sets the RowKey value for the entity to retrieve.

Parameters:

rowKey - A String containing the RowKey value for the entity.

isPrimaryOnlyRetrieve

protected final boolean isPrimaryOnlyRetrieve()

Returns:

the isPrimaryOnlyRetrieve

setPrimaryOnlyRetrieve

protected void setPrimaryOnlyRetrieve(boolean isPrimaryOnlyRetrieve)

Parameters:

isPrimaryOnlyRetrieve - the isPrimaryOnlyRetrieve to set