org.apache.cassandra.cql3

Class TokenRelation

java.lang.Object

org.apache.cassandra.cql3.Relation

org.apache.cassandra.cql3.TokenRelation

public final class TokenRelation
extends Relation

A relation using the token function. Examples:

• SELECT ... WHERE token(a) > token(1)
• SELECT ... WHERE token(a, b) > token(1, 3)

Field Summary

Fields inherited from class org.apache.cassandra.cql3.Relation

relationType

Constructor Summary

Constructors

Constructor and Description
TokenRelation(java.util.List<ColumnIdentifier.Raw> entities, Operator type, Term.Raw value)

Method Summary

Modifier and Type	Method and Description
java.util.List<? extends Term.Raw>	getInValues() Returns the list of raw IN values for this relation, or null if this is not an IN relation.
Term.Raw	getValue() Returns the raw value for this relation, or null if this is an IN relation.
protected Restriction	newContainsRestriction(CFMetaData cfm, VariableSpecifications boundNames, boolean isKey) Creates a new Contains restriction instance.
protected Restriction	newEQRestriction(CFMetaData cfm, VariableSpecifications boundNames) Creates a new EQ restriction instance.
protected Restriction	newINRestriction(CFMetaData cfm, VariableSpecifications boundNames) Creates a new IN restriction instance.
protected Restriction	newIsNotRestriction(CFMetaData cfm, VariableSpecifications boundNames)
protected Restriction	newSliceRestriction(CFMetaData cfm, VariableSpecifications boundNames, Bound bound, boolean inclusive) Creates a new Slice restriction instance.
boolean	onToken() Checks if this relation is a token relation (e.g.
Relation	renameIdentifier(ColumnIdentifier.Raw from, ColumnIdentifier.Raw to) Renames an identifier in this Relation, if applicable.
java.lang.String	toString()
protected Term	toTerm(java.util.List<? extends ColumnSpecification> receivers, Term.Raw raw, java.lang.String keyspace, VariableSpecifications boundNames) Converts the specified Raw into a Term.

Methods inherited from class org.apache.cassandra.cql3.Relation

isContains, isContainsKey, isEQ, isIN, isMultiColumn, isSlice, operator, toColumnDefinition, toRestriction, toTerms

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenRelation

public TokenRelation(java.util.List<ColumnIdentifier.Raw> entities,
                     Operator type,
                     Term.Raw value)

Method Detail

onToken

public boolean onToken()

Description copied from class: Relation

Checks if this relation is a token relation (e.g.

token(a) = token(1)

).

Overrides:

onToken in class Relation

Returns:

true if this relation is a token relation, false otherwise.

getValue

public Term.Raw getValue()

Description copied from class: Relation

Returns the raw value for this relation, or null if this is an IN relation.

Specified by:

getValue in class Relation

getInValues

public java.util.List<? extends Term.Raw> getInValues()

Description copied from class: Relation

Returns the list of raw IN values for this relation, or null if this is not an IN relation.

Specified by:

getInValues in class Relation

newEQRestriction

protected Restriction newEQRestriction(CFMetaData cfm,
                                       VariableSpecifications boundNames)
                                throws InvalidRequestException

Description copied from class: Relation

Creates a new EQ restriction instance.

Specified by:

newEQRestriction in class Relation

Parameters:

cfm - the Column Family meta data

boundNames - the variables specification where to collect the bind variables

Returns:

a new EQ restriction instance.

Throws:

InvalidRequestException - if the relation cannot be converted into an EQ restriction.

newINRestriction

protected Restriction newINRestriction(CFMetaData cfm,
                                       VariableSpecifications boundNames)
                                throws InvalidRequestException

Description copied from class: Relation

Creates a new IN restriction instance.

Specified by:

newINRestriction in class Relation

Parameters:

cfm - the Column Family meta data

boundNames - the variables specification where to collect the bind variables

Returns:

a new IN restriction instance

Throws:

InvalidRequestException - if the relation cannot be converted into an IN restriction.

newSliceRestriction

protected Restriction newSliceRestriction(CFMetaData cfm,
                                          VariableSpecifications boundNames,
                                          Bound bound,
                                          boolean inclusive)
                                   throws InvalidRequestException

Description copied from class: Relation

Creates a new Slice restriction instance.

Specified by:

newSliceRestriction in class Relation

Parameters:

cfm - the Column Family meta data

boundNames - the variables specification where to collect the bind variables

bound - the slice bound

inclusive - true if the bound is included.

Returns:

a new slice restriction instance

Throws:

InvalidRequestException - if the Relation is not valid

newContainsRestriction

protected Restriction newContainsRestriction(CFMetaData cfm,
                                             VariableSpecifications boundNames,
                                             boolean isKey)
                                      throws InvalidRequestException

Description copied from class: Relation

Creates a new Contains restriction instance.

Specified by:

newContainsRestriction in class Relation

Parameters:

cfm - the Column Family meta data

boundNames - the variables specification where to collect the bind variables

isKey - true if the restriction to create is a CONTAINS KEY

Returns:

a new Contains Restriction instance

Throws:

InvalidRequestException - if the Relation is not valid

newIsNotRestriction

protected Restriction newIsNotRestriction(CFMetaData cfm,
                                          VariableSpecifications boundNames)
                                   throws InvalidRequestException

Specified by:

newIsNotRestriction in class Relation

Throws:

InvalidRequestException

toTerm

protected Term toTerm(java.util.List<? extends ColumnSpecification> receivers,
                      Term.Raw raw,
                      java.lang.String keyspace,
                      VariableSpecifications boundNames)
               throws InvalidRequestException

Description copied from class: Relation

Converts the specified Raw into a Term.

Specified by:

toTerm in class Relation

Parameters:

receivers - the columns to which the values must be associated at

raw - the raw term to convert

keyspace - the keyspace name

boundNames - the variables specification where to collect the bind variables

Returns:

the Term corresponding to the specified Raw

Throws:

InvalidRequestException - if the Raw term is not valid

renameIdentifier

public Relation renameIdentifier(ColumnIdentifier.Raw from,
                                 ColumnIdentifier.Raw to)

Description copied from class: Relation

Renames an identifier in this Relation, if applicable.

Specified by:

renameIdentifier in class Relation

Parameters:

from - the old identifier

to - the new identifier

Returns:

this object, if the old identifier is not in the set of entities that this relation covers; otherwise a new Relation with "from" replaced by "to" is returned.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object