com.cinchapi.concourse.lang

Class Criteria

Object

Criteria

All Implemented Interfaces:

Symbol

public class Criteria
extends Object
implements 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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Criteria() Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	add(Symbol symbol) Add a Symbol to this Criteria.
protected void	close() Mark this Criteria as built.
String	getCclString() Return a CCL string that is equivalent to this object.
protected List<Symbol>	getSymbols() Return the order list of symbols that make up this Criteria.
String	toString()
static StartState	where() Start building a new Criteria.

Methods inherited from class Object

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

Constructor Detail

Criteria

protected Criteria()

Construct a new instance.

Method Detail

where

public static StartState where()

Start building a new Criteria.

Returns:

the Criteria builder

getCclString

public String getCclString()

Return a CCL string that is equivalent to this object.

Returns:

an equivalent CCL string

toString

public String toString()

Overrides:

toString in class Object

add

protected void add(Symbol symbol)

Add a Symbol to this Criteria.

Parameters:

symbol -

close

protected void close()

Mark this Criteria as built.

getSymbols

protected List<Symbol> getSymbols()

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

Returns:

symbols