com.scalar.db.api

Class ScanWithIndex

java.lang.Object

com.scalar.db.api.Operation

com.scalar.db.api.Selection

com.scalar.db.api.Scan

com.scalar.db.api.ScanWithIndex

public class ScanWithIndex
extends Scan

Nested Class Summary

Nested classes/interfaces inherited from class com.scalar.db.api.Scan

Scan.Ordering

Constructor Summary

Constructors

Constructor and Description
ScanWithIndex(Key indexKey) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use Scan.newBuilder() instead
ScanWithIndex(ScanWithIndex scanWithIndex) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use Scan.newBuilder(Scan) instead

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Indicates whether some other object is "equal to" this object.
ScanWithIndex	forNamespace(java.lang.String namespace) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()
ScanWithIndex	forTable(java.lang.String tableName) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()
int	hashCode()
java.lang.String	toString()
ScanWithIndex	withConsistency(Consistency consistency) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()
ScanWithIndex	withEnd(Key clusteringKey) Deprecated. Unsupported operation.
ScanWithIndex	withEnd(Key clusteringKey, boolean inclusive) Deprecated. Unsupported operation.
ScanWithIndex	withLimit(int limit) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()
ScanWithIndex	withOrdering(Scan.Ordering ordering) Deprecated. Unsupported operation.
ScanWithIndex	withProjection(java.lang.String projection) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()
ScanWithIndex	withProjections(java.util.Collection<java.lang.String> projections) Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()
ScanWithIndex	withStart(Key clusteringKey) Deprecated. Unsupported operation.
ScanWithIndex	withStart(Key clusteringKey, boolean inclusive) Deprecated. Unsupported operation.

Methods inherited from class com.scalar.db.api.Scan

accept, getEndClusteringKey, getEndInclusive, getLimit, getOrderings, getStartClusteringKey, getStartInclusive, newBuilder, newBuilder

Methods inherited from class com.scalar.db.api.Selection

clearProjections, getProjections

Methods inherited from class com.scalar.db.api.Operation

forFullTableName, forNamespace, forTable, getClusteringKey, getConsistency, getPartitionKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScanWithIndex

@Deprecated
public ScanWithIndex(Key indexKey)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use Scan.newBuilder() instead

Parameters:

indexKey - an index key

ScanWithIndex

@Deprecated
public ScanWithIndex(ScanWithIndex scanWithIndex)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use Scan.newBuilder(Scan) instead

Copy a ScanWithIndex.

Parameters:

scanWithIndex - a ScanWithIndex

Method Detail

withStart

@Deprecated
public ScanWithIndex withStart(Key clusteringKey)

Deprecated. Unsupported operation.

Guaranteed to throw an exception.

Overrides:

withStart in class Scan

Parameters:

clusteringKey - a starting clustering key

Returns:

this object

Throws:

java.lang.UnsupportedOperationException - always

withStart

@Deprecated
public ScanWithIndex withStart(Key clusteringKey,
                                           boolean inclusive)

Deprecated. Unsupported operation.

Guaranteed to throw an exception.

Overrides:

withStart in class Scan

Parameters:

clusteringKey - a starting clustering key

inclusive - indicates whether the boundary is inclusive or not

Returns:

this object

Throws:

java.lang.UnsupportedOperationException - always

withEnd

@Deprecated
public ScanWithIndex withEnd(Key clusteringKey)

Deprecated. Unsupported operation.

Guaranteed to throw an exception.

Overrides:

withEnd in class Scan

Parameters:

clusteringKey - an ending clustering key

Returns:

this object

Throws:

java.lang.UnsupportedOperationException - always

withEnd

@Deprecated
public ScanWithIndex withEnd(Key clusteringKey,
                                         boolean inclusive)

Deprecated. Unsupported operation.

Guaranteed to throw an exception.

Overrides:

withEnd in class Scan

Parameters:

clusteringKey - an ending clustering key

inclusive - indicates whether the boundary is inclusive or not

Returns:

this object

Throws:

java.lang.UnsupportedOperationException - always

withOrdering

@Deprecated
public ScanWithIndex withOrdering(Scan.Ordering ordering)

Deprecated. Unsupported operation.

Guaranteed to throw an exception.

Overrides:

withOrdering in class Scan

Parameters:

ordering - a scan ordering

Returns:

this object

Throws:

java.lang.UnsupportedOperationException - always

withLimit

@Deprecated
public ScanWithIndex withLimit(int limit)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()

Description copied from class: Scan

Sets the specified number of results to be returned

Overrides:

withLimit in class Scan

Parameters:

limit - the number of results to be returned

Returns:

this object

forNamespace

@Deprecated
public ScanWithIndex forNamespace(java.lang.String namespace)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()

Description copied from class: Operation

Sets the specified target namespace for this operation

Overrides:

forNamespace in class Scan

Parameters:

namespace - target namespace for this operation

Returns:

this object

forTable

@Deprecated
public ScanWithIndex forTable(java.lang.String tableName)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()

Description copied from class: Operation

Sets the specified target table for this operation

Overrides:

forTable in class Scan

Parameters:

tableName - target table name for this operation

Returns:

this object

withConsistency

@Deprecated
public ScanWithIndex withConsistency(Consistency consistency)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()

Description copied from class: Operation

Sets the specified consistency level for this operation

Overrides:

withConsistency in class Scan

Parameters:

consistency - consistency level to set

Returns:

this object

withProjection

@Deprecated
public ScanWithIndex withProjection(java.lang.String projection)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()

Description copied from class: Selection

Appends the specified column name to the list of projections.

Overrides:

withProjection in class Scan

Parameters:

projection - a column name to project

Returns:

this object

withProjections

@Deprecated
public ScanWithIndex withProjections(java.util.Collection<java.lang.String> projections)

Deprecated. As of release 3.6.0. Will be removed in release 5.0.0. Use the setter method of the Scan builder instead; to create a Scan builder, use Scan.newBuilder()

Description copied from class: Selection

Appends the specified collection of the specified column names to the list of projections.

Overrides:

withProjections in class Scan

Parameters:

projections - a collection of the column names to project

Returns:

this object

equals

public boolean equals(java.lang.Object o)

Description copied from class: Scan

Indicates whether some other object is "equal to" this object. The other object is considered equal if:

• both super class instances are equal and
• it is also an Scan and
• both instances have the same clustering key range, orderings and limit

Overrides:

equals in class Scan

Parameters:

o - an object to be tested for equality

Returns:

true if the other object is "equal to" this object otherwise false

hashCode

public int hashCode()

Overrides:

hashCode in class Scan

toString

public java.lang.String toString()

Overrides:

toString in class Scan