com.amazonaws.services.dynamodbv2.datamodeling
Class DynamoDBScanExpression

java.lang.Object
  com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBScanExpression

Deprecated. These classes have been deprecated, please use the classes in the com.amazonaws.mobileconnectors namespace.

public class DynamoDBScanExpression
extends java.lang.Object

Options for filtering results from a scan operation. For example, callers can specify filter conditions so that only objects whose attributes match different conditions are returned (see ComparisonOperator for more information on the available comparison types).

See Also:

DynamoDBMapper.scan(Class, DynamoDBScanExpression)

Constructor Summary

DynamoDBScanExpression()
Deprecated.

Method Summary

void	addFilterCondition(java.lang.String attributeName, Condition condition) Deprecated. Adds a new filter condition to the current scan filter.
java.lang.String	getConditionalOperator() Deprecated. Returns the logical operator on the filter conditions of this scan.
java.util.Map<java.lang.String,AttributeValue>	getExclusiveStartKey() Deprecated. Returns the exclusive start key for this scan.
java.lang.Integer	getLimit() Deprecated. Returns the limit of items to scan during this scan.
java.util.Map<java.lang.String,Condition>	getScanFilter() Deprecated. Returns the scan filter as a map of attribute names to conditions.
java.lang.Integer	getSegment() Deprecated. Returns the ID of the segment to be scanned.
java.lang.Integer	getTotalSegments() Deprecated. Returns the total number of segments into which the scan will be divided.
void	setConditionalOperator(ConditionalOperator conditionalOperator) Deprecated. Sets the logical operator on the filter conditions of this scan.
void	setConditionalOperator(java.lang.String conditionalOperator) Deprecated. Sets the logical operator on the filter conditions of this scan.
void	setExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey) Deprecated. Sets the exclusive start key for this scan.
void	setLimit(java.lang.Integer limit) Deprecated. Sets the limit of items to scan during this scan.
void	setScanFilter(java.util.Map<java.lang.String,Condition> scanFilter) Deprecated. Sets the scan filter to the map of attribute names to conditions given.
void	setSegment(java.lang.Integer segment) Deprecated. Sets the ID of the segment to be scanned.
void	setTotalSegments(java.lang.Integer totalSegments) Deprecated. Sets the total number of segments into which the scan will be divided.
DynamoDBScanExpression	withConditionalOperator(ConditionalOperator conditionalOperator) Deprecated. Sets the logical operator on the filter conditions of this scan and returns a pointer to this object for method-chaining.
DynamoDBScanExpression	withConditionalOperator(java.lang.String conditionalOperator) Deprecated. Sets the logical operator on the filter conditions of this scan and returns a pointer to this object for method-chaining.
DynamoDBScanExpression	withExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey) Deprecated. Sets the exclusive start key for this scan and returns a pointer to this object for method-chaining.
DynamoDBScanExpression	withFilterConditionEntry(java.lang.String attributeName, Condition condition) Deprecated. Adds a new filter condition to the current scan filter and returns a pointer to this object for method-chaining.
DynamoDBScanExpression	withLimit(java.lang.Integer limit) Deprecated. Sets the limit of items to scan and returns a pointer to this object for method-chaining.
DynamoDBScanExpression	withScanFilter(java.util.Map<java.lang.String,Condition> scanFilter) Deprecated. Sets the scan filter to the map of attribute names to conditions given and returns a pointer to this object for method-chaining.
DynamoDBScanExpression	withSegment(java.lang.Integer segment) Deprecated. Sets the ID of the segment to be scanned and returns a pointer to this object for method-chaining.
DynamoDBScanExpression	withTotalSegments(java.lang.Integer totalSegments) Deprecated. Sets the total number of segments into which the scan will be divided and returns a pointer to this object for method-chaining.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamoDBScanExpression

public DynamoDBScanExpression()

Deprecated.

Method Detail

getScanFilter

public java.util.Map<java.lang.String,Condition> getScanFilter()

Deprecated.

Returns the scan filter as a map of attribute names to conditions.

Returns:

The scan filter as a map of attribute names to conditions.

setScanFilter

public void setScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)

Deprecated.

Sets the scan filter to the map of attribute names to conditions given.

Parameters:

scanFilter - The map of attribute names to conditions to use when filtering scan results.

withScanFilter

public DynamoDBScanExpression withScanFilter(java.util.Map<java.lang.String,Condition> scanFilter)

Deprecated.

Sets the scan filter to the map of attribute names to conditions given and returns a pointer to this object for method-chaining.

Parameters:

scanFilter - The map of attribute names to conditions to use when filtering scan results.

addFilterCondition

public void addFilterCondition(java.lang.String attributeName,
                               Condition condition)

Deprecated.

Adds a new filter condition to the current scan filter.

Parameters:

attributeName - The name of the attribute on which the specified condition operates.

condition - The condition which describes how the specified attribute is compared and if a row of data is included in the results returned by the scan operation.

withFilterConditionEntry

public DynamoDBScanExpression withFilterConditionEntry(java.lang.String attributeName,
                                                       Condition condition)

Deprecated.

Adds a new filter condition to the current scan filter and returns a pointer to this object for method-chaining.

Parameters:

attributeName - The name of the attribute on which the specified condition operates.

condition - The condition which describes how the specified attribute is compared and if a row of data is included in the results returned by the scan operation.

getExclusiveStartKey

public java.util.Map<java.lang.String,AttributeValue> getExclusiveStartKey()

Deprecated.

Returns the exclusive start key for this scan.

setExclusiveStartKey

public void setExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)

Deprecated.

Sets the exclusive start key for this scan.

withExclusiveStartKey

public DynamoDBScanExpression withExclusiveStartKey(java.util.Map<java.lang.String,AttributeValue> exclusiveStartKey)

Deprecated.

Sets the exclusive start key for this scan and returns a pointer to this object for method-chaining.

getLimit

public java.lang.Integer getLimit()

Deprecated.

Returns the limit of items to scan during this scan.

Use with caution. Please note that this is not the same as the number of items to return from the scan operation -- the operation will cease and return as soon as this many items are scanned, even if no matching results are found. Furthermore, PaginatedScanList will execute as many scan operations as necessary until it either reaches the end of the result set as indicated by DynamoDB or enough elements are available to fulfill the list operation (e.g. iteration). Therefore, except when scanning without a scan filter, it's usually bad practice to set a low limit, since doing so will often generate the same amount of traffic to DynamoDB but with a greater number of round trips and therefore more overall latency.

setLimit

public void setLimit(java.lang.Integer limit)

Deprecated.

Sets the limit of items to scan during this scan. Please note that this is not the same as the number of items to return from the scan operation -- the operation will cease and return as soon as this many items are scanned, even if no matching results are found.

See Also:

getLimit()

withLimit

public DynamoDBScanExpression withLimit(java.lang.Integer limit)

Deprecated.

Sets the limit of items to scan and returns a pointer to this object for method-chaining. Please note that this is not the same as the number of items to return from the scan operation -- the operation will cease and return as soon as this many items are scanned, even if no matching results are found.

See Also:

getLimit()

getTotalSegments

public java.lang.Integer getTotalSegments()

Deprecated.

Returns the total number of segments into which the scan will be divided.

setTotalSegments

public void setTotalSegments(java.lang.Integer totalSegments)

Deprecated.

Sets the total number of segments into which the scan will be divided.

withTotalSegments

public DynamoDBScanExpression withTotalSegments(java.lang.Integer totalSegments)

Deprecated.

Sets the total number of segments into which the scan will be divided and returns a pointer to this object for method-chaining.

getSegment

public java.lang.Integer getSegment()

Deprecated.

Returns the ID of the segment to be scanned.

setSegment

public void setSegment(java.lang.Integer segment)

Deprecated.

Sets the ID of the segment to be scanned.

withSegment

public DynamoDBScanExpression withSegment(java.lang.Integer segment)

Deprecated.

Sets the ID of the segment to be scanned and returns a pointer to this object for method-chaining.

getConditionalOperator

public java.lang.String getConditionalOperator()

Deprecated.

Returns the logical operator on the filter conditions of this scan.

setConditionalOperator

public void setConditionalOperator(java.lang.String conditionalOperator)

Deprecated.

Sets the logical operator on the filter conditions of this scan.

withConditionalOperator

public DynamoDBScanExpression withConditionalOperator(java.lang.String conditionalOperator)

Deprecated.

Sets the logical operator on the filter conditions of this scan and returns a pointer to this object for method-chaining.

setConditionalOperator

public void setConditionalOperator(ConditionalOperator conditionalOperator)

Deprecated.

Sets the logical operator on the filter conditions of this scan.

withConditionalOperator

public DynamoDBScanExpression withConditionalOperator(ConditionalOperator conditionalOperator)

Deprecated.

Sets the logical operator on the filter conditions of this scan and returns a pointer to this object for method-chaining.