Public Functions
 FunctionDefined by
  
_(a:*):Literal
Returns a new Literal operator.
flare.query.methods
  
add(a:*, b:*):Arithmetic
Creates a new addition Arithmetic query operator.
flare.query.methods
  
and(... rest):And
Creates a new And query operator.
flare.query.methods
  
average(expr:*):Average
Creates a new Average query operator.
flare.query.methods
  
count(expr:*):Count
Creates a new Count query operator.
flare.query.methods
  
distinct(expr:*):Distinct
Creates a new Distinct query operator.
flare.query.methods
  
div(a:*, b:*):Arithmetic
Creates a new division Arithmetic query operator.
flare.query.methods
  
eq(a:*, b:*):Comparison
Creates a new equality Comparison query operator.
flare.query.methods
  
fn(name:String, ... args):Fn
Creates a new Fn query operator for a function in a query.
flare.query.methods
  
gt(a:*, b:*):Comparison
Creates a new greater-than Comparison query operator.
flare.query.methods
  
gte(a:*, b:*):Comparison
Creates a new greater-than-or-equal Comparison query operator.
flare.query.methods
  
iff(test:*, then:*, els:*):If
Creates a new If query operator.
flare.query.methods
  
isa(type:Class, x:* = null):IsA
Creates a new IsType query operator.
flare.query.methods
  
lt(a:*, b:*):Comparison
Creates a new less-than Comparison query operator.
flare.query.methods
  
lte(a:*, b:*):Comparison
Creates a new less-than-or-equal Comparison query operator.
flare.query.methods
  
max(expr:*):Maximum
Creates a new Maximum query operator.
flare.query.methods
  
min(expr:*):Minimum
Creates a new Minimum query operator.
flare.query.methods
  
mod(a:*, b:*):Arithmetic
Creates a new modulo Arithmetic query operator.
flare.query.methods
  
mul(a:*, b:*):Arithmetic
Creates a new multiplication Arithmetic query operator.
flare.query.methods
  
neq(a:*, b:*):Comparison
Creates a new inequality Comparison query operator.
flare.query.methods
  
not(x:*):Not
Creates a new Not query operator.
flare.query.methods
  
or(... rest):Or
Creates a new Or query operator.
flare.query.methods
  
orderby(... terms):Query
Create a new Query with the given sort criteria.
flare.query.methods
  
range(min:*, max:*, val:*):Range
Creates a new Range query operator.
flare.query.methods
  
select(... terms):Query
Create a new Query with the given select clauses.
flare.query.methods
  
stddev(expr:*):Variance
Creates a new Variance query operator that computes the population standard deviation.
flare.query.methods
  
sub(a:*, b:*):Arithmetic
Creates a new subtraction Arithmetic query operator.
flare.query.methods
  
sum(expr:*):Sum
Creates a new 'sum' Arithmetic query operator.
flare.query.methods
  
update(... terms):Query
Create a new Query with the given update clauses.
flare.query.methods
  
variance(expr:*):Variance
Creates a new Variance query operator that computes the population variance.
flare.query.methods
  
where(expr:*):Query
Create a new Query with the given filter expression.
flare.query.methods
  
xor(... rest):Xor
Creates a new Xor (exclusive or) query operator.
flare.query.methods
Function detail
_()function
public function _(a:*):Literal

Returns a new Literal operator.

Parameters
a:* — input object

Returns
Literal — the new Literal expression
add()function 
public function add(a:*, b:*):Arithmetic

Creates a new addition Arithmetic query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Arithmetic — the new query operator
and()function 
public function and(... rest):And

Creates a new And query operator.

Parameters
... rest — a list of expressions to include in the and

Returns
And — the new query operator
average()function 
public function average(expr:*):Average

Creates a new Average query operator.

Parameters
expr:* — the input expression

Returns
Average — the new query operator
count()function 
public function count(expr:*):Count

Creates a new Count query operator.

Parameters
expr:* — the input expression

Returns
Count — the new query operator
distinct()function 
public function distinct(expr:*):Distinct

Creates a new Distinct query operator.

Parameters
expr:* — the input expression

Returns
Distinct — the new query operator
div()function 
public function div(a:*, b:*):Arithmetic

Creates a new division Arithmetic query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Arithmetic — the new query operator
eq()function 
public function eq(a:*, b:*):Comparison

Creates a new equality Comparison query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Comparison — the new query operator
fn()function 
public function fn(name:String, ... args):Fn

Creates a new Fn query operator for a function in a query.

Parameters
name:String — the name of the function. This should be a function registered with the Fn class.
 
... args — a list of arguments to the function

Returns
Fn — the new Fn operator
gt()function 
public function gt(a:*, b:*):Comparison

Creates a new greater-than Comparison query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Comparison — the new query operator
gte()function 
public function gte(a:*, b:*):Comparison

Creates a new greater-than-or-equal Comparison query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Comparison — the new query operator
iff()function 
public function iff(test:*, then:*, els:*):If

Creates a new If query operator.

Parameters
test:* — the if test expression. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
then:* — the then case expression This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
els:* — the else case expression This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
If — the new query operator
isa()function 
public function isa(type:Class, x:* = null):IsA

Creates a new IsType query operator.

Parameters
type:Class — the class type to check for
 
x:* (default = null) — the expression to type check This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
IsA — the new query operator
lt()function 
public function lt(a:*, b:*):Comparison

Creates a new less-than Comparison query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Comparison — the new query operator
lte()function 
public function lte(a:*, b:*):Comparison

Creates a new less-than-or-equal Comparison query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Comparison — the new query operator
max()function 
public function max(expr:*):Maximum

Creates a new Maximum query operator.

Parameters
expr:* — the input expression

Returns
Maximum — the new query operator
min()function 
public function min(expr:*):Minimum

Creates a new Minimum query operator.

Parameters
expr:* — the input expression

Returns
Minimum — the new query operator
mod()function 
public function mod(a:*, b:*):Arithmetic

Creates a new modulo Arithmetic query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Arithmetic — the new query operator
mul()function 
public function mul(a:*, b:*):Arithmetic

Creates a new multiplication Arithmetic query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Arithmetic — the new query operator
neq()function 
public function neq(a:*, b:*):Comparison

Creates a new inequality Comparison query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Comparison — the new query operator
not()function 
public function not(x:*):Not

Creates a new Not query operator.

Parameters
x:* — the expression to negate This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Not — the new query operator
or()function 
public function or(... rest):Or

Creates a new Or query operator.

Parameters
... rest — a list of expressions to include in the or

Returns
Or — the new query operator
orderby()function 
public function orderby(... terms):Query

Create a new Query with the given sort criteria.

Parameters
... terms — a list of sort criteria

Returns
Query — the created query.
range()function 
public function range(min:*, max:*, val:*):Range

Creates a new Range query operator.

Parameters
min:* — the minimum range value. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
max:* — the maximum range value. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
val:* — the value to test for range inclusion. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Range — the new query operator
select()function 
public function select(... terms):Query

Create a new Query with the given select clauses.

Parameters
... terms — a list of select clauses

Returns
Query — the created query.
stddev()function 
public function stddev(expr:*):Variance

Creates a new Variance query operator that computes the population standard deviation.

Parameters
expr:* — the input expression

Returns
Variance — the new query operator
sub()function 
public function sub(a:*, b:*):Arithmetic

Creates a new subtraction Arithmetic query operator.

Parameters
a:* — the left side argument. This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.
 
b:* — the right side argument This value can be an expression or a literal value. Literal values are parsed using the Expression.expr method.

Returns
Arithmetic — the new query operator
sum()function 
public function sum(expr:*):Sum

Creates a new 'sum' Arithmetic query operator.

Parameters
expr:* — the input expression

Returns
Sum — the new query operator
update()function 
public function update(... terms):Query

Create a new Query with the given update clauses.

Parameters
... terms — a list of update clauses

Returns
Query — the created query.
variance()function 
public function variance(expr:*):Variance

Creates a new Variance query operator that computes the population variance.

Parameters
expr:* — the input expression

Returns
Variance — the new query operator
where()function 
public function where(expr:*):Query

Create a new Query with the given filter expression.

Parameters
expr:* — the filter expression

Returns
Query — the created query.
xor()function 
public function xor(... rest):Xor

Creates a new Xor (exclusive or) query operator.

Parameters
... rest — a list of expressions to include in the exclusive or

Returns
Xor — the new query operator