com.cinchapi.concourse.lang

Interface Criteria

All Superinterfaces:

Symbol

All Known Implementing Classes:

BuildableStartState, BuildableState, BuiltCriteria, TimestampState, ValueState

public interface Criteria
extends Symbol

A Criteria is an object that is used to encapsulate the semantics of a complex query. Any any given time, objects of this class can exist in one of two modes: building or built. When a Criteria is built, it is guaranteed to represent a fully and well formed query that can be processed. On the other hand, when a Criteria is building it is in an incomplete state.

This class is the public interface to Criteria construction. It is meant to be used in a chained manner, where the caller initially calls where() and continues to construct the Criteria using the options available from each subsequently returned state.

Read times for individual keys can be expressed as annotations in any key string passed to the builder — for example, where().key("name[t]")… pins the read of name to t. Annotations on a navigation path stamp each stop independently. An annotation on a key always wins over the operation-level default supplied via at(Timestamp).

Method Summary

Modifier and Type	Method and Description
Criteria	at(Timestamp timestamp) Return this Criteria with its operation-level default timestamp set to timestamp.
String	ccl() Return a CCL string that is equivalent to this object.
default String	getCclString() Deprecated. in favor of ccl()
static Criteria	parse(String ccl) Return a Criteria object that expresses the same as the ccl statement.
List<Symbol>	symbols() Return the order list of symbols that make up this Criteria.
static StartState	where() Start building a new Criteria.

Method Detail

parse

static Criteria parse(String ccl)

Return a Criteria object that expresses the same as the ccl statement.

Parameters:

ccl - the CCL statement to parse

Returns:

an equivalent Criteria object

where

static StartState where()

Start building a new Criteria.

Returns:

the Criteria builder

at

Criteria at(Timestamp timestamp)

Return this Criteria with its operation-level default timestamp set to timestamp. The operation-level default is the read time for every unannotated leaf in the Criteria; per-key annotations (e.g. "name[t]") on a leaf's KeyTokenSymbol are not overwritten and continue to pin their own reads.

Parameters:

timestamp - the operation-level default Timestamp

Returns:

this Criteria with its operation-level default timestamp set to timestamp

ccl

String ccl()

Return a CCL string that is equivalent to this object.

Returns:

an equivalent CCL string

getCclString

@Deprecated
default String getCclString()

Deprecated. in favor of ccl()

Return a CCL string that is equivalent to this object.

Returns:

an equivalent CCL string

symbols

List<Symbol> symbols()

Return the order list of symbols that make up this Criteria.

Returns:

symbols