com.cinchapi.concourse.lang

Class ConcourseCompiler

Object

Compiler

ConcourseCompiler

public final class ConcourseCompiler
extends Compiler

A CCL Compiler for Concourse.

Field Summary

Fields inherited from class Compiler

operatorParser, valueParser

Method Summary

Modifier and Type	Method and Description
AbstractSyntaxTree	compile(Command command, Multimap<String,Object> data) Compile a single command into an AbstractSyntaxTree and bind the local data.
List<AbstractSyntaxTree>	compile(List<Command> commands, Multimap<String,Object> data) Compile the commands into distinct trees and bind the local data.
List<AbstractSyntaxTree>	compile(String ccl, Multimap<String,Object> data)
boolean	evaluate(ConditionTree tree, Association data) Return true if the data is described by the condition encapsulated in the tree.
boolean	evaluate(ConditionTree tree, Multimap<String,Object> data) Return true if the data is described by the condition encapsulated in the tree.
static ConcourseCompiler	get() Return a ConcourseCompiler.
AbstractSyntaxTree	parse(Criteria criteria) Parse the criteria.
AbstractSyntaxTree	parse(Criteria criteria, Multimap<String,Object> data) Parse the criteria, resolving $variable value placeholders against data.
AbstractSyntaxTree	parse(TCriteria criteria) Parse the typed TSymbols carried by the criteria into an AbstractSyntaxTree.
AbstractSyntaxTree	parse(TCriteria criteria, Multimap<String,Object> data) Parse the typed TSymbols carried by the criteria into an AbstractSyntaxTree, resolving $variable value placeholders against data.

Methods inherited from class Compiler

analyze, analyze, arrange, compile, create, evaluate, evaluate, parse, parse, parse, parse, tokenize

Methods inherited from class Object

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

Method Detail

get

public static ConcourseCompiler get()

Return a ConcourseCompiler.

Returns:

a ConcourseCompiler

compile

public AbstractSyntaxTree compile(Command command,
                                  Multimap<String,Object> data)

Compile a single command into an AbstractSyntaxTree and bind the local data.

Parameters:

command - the Command to compile

data - the local data to bind

Returns:

an AbstractSyntaxTree representing the command

compile

public List<AbstractSyntaxTree> compile(List<Command> commands,
                                        Multimap<String,Object> data)

Compile the commands into distinct trees and bind the local data.

Parameters:

commands - the Commands to compile

data - the local data to bind

Returns:

a List of AbstractSyntaxTrees representing the commands

compile

public List<AbstractSyntaxTree> compile(String ccl,
                                        Multimap<String,Object> data)

Specified by:

compile in class Compiler

evaluate

public final boolean evaluate(ConditionTree tree,
                              Association data)

Return true if the data is described by the condition encapsulated in the tree.

Parameters:

tree - the ConditionTree that represents the condition

data - the data to test for adherences to the condition

Returns:

true if the data is described by the criteria that has been parsed

evaluate

public final boolean evaluate(ConditionTree tree,
                              Multimap<String,Object> data)

Return true if the data is described by the condition encapsulated in the tree.

Parameters:

tree - the ConditionTree that represents the condition

data - the data to test for adherences to the condition

Returns:

true if the data is described by the criteria that has been parsed

parse

public final AbstractSyntaxTree parse(Criteria criteria)

Parse the criteria.

Parameters:

criteria - the Criteria

Returns:

an AbstractSyntaxTree representing the criteria

parse

public final AbstractSyntaxTree parse(Criteria criteria,
                                      Multimap<String,Object> data)

Parse the criteria, resolving $variable value placeholders against data.

Parameters:

criteria - the Criteria

data - the Multimap of locally-bound values

Returns:

an AbstractSyntaxTree representing the criteria

parse

public final AbstractSyntaxTree parse(TCriteria criteria)

Parse the typed TSymbols carried by the criteria into an AbstractSyntaxTree.

Key names that collide with reserved CCL command keywords (e.g., select, find) are valid because no CCL text parsing occurs.

Parameters:

criteria - the TCriteria

Returns:

an AbstractSyntaxTree representing the criteria

Throws:

SyntaxException - if a $variable reference appears in a value position (no local bindings are available)

parse

public final AbstractSyntaxTree parse(TCriteria criteria,
                                      Multimap<String,Object> data)

Parse the typed TSymbols carried by the criteria into an AbstractSyntaxTree, resolving $variable value placeholders against data.

A value of the form $name is replaced with the value bound to name in data; \$name denotes the literal $name. Key names that collide with reserved CCL command keywords (e.g., select, find) are valid because no CCL text parsing occurs.

Parameters:

criteria - the TCriteria

data - the Multimap of locally-bound values

Returns:

an AbstractSyntaxTree representing the criteria

Throws:

SyntaxException - if a $variable reference has no binding or has multiple bindings in data