io.inversion.rql

Class Query<T extends Query,D extends Db,S extends Select,F extends From,W extends Where,R extends Group,O extends Order,G extends Page>

java.lang.Object

io.inversion.rql.Builder<T,T>

io.inversion.rql.Query<T,D,S,F,W,R,O,G>

public class Query<T extends Query,D extends Db,S extends Select,F extends From,W extends Where,R extends Group,O extends Order,G extends Page>
extends Builder<T,T>

Represents a full RQL query with a SELECT,WHERE,GROUP,ORDER, and PAGE clause.

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection	collection
protected D	db
protected boolean	dryRun
protected F	from
protected R	group
protected O	order
protected G	page
protected S	select
protected java.util.List<org.apache.commons.collections4.KeyValue>	values
protected W	where

Fields inherited from class io.inversion.rql.Builder

builders, functions, parent, terms

Constructor Summary

Constructors

Constructor and Description
Query()
Query(D db, Collection coll)
Query(D db, Collection coll, java.lang.Object terms, java.lang.String... functions)

Method Summary

Modifier and Type	Method and Description
protected T	clearValues()
protected F	createFrom()
protected R	createGroup()
protected O	createOrder()
protected G	createPage()
protected S	createSelect()
protected W	createWhere()
Results	doSelect()
java.util.List<Builder>	getBuilders()
Collection	getCollection()
org.apache.commons.collections4.KeyValue<java.lang.String,java.lang.String>	getColValue(int index)
java.util.List<java.lang.String>	getColValueKeys()
java.util.List<java.lang.Object>	getColValues()
D	getDb()
F	getFrom()
R	getGroup()
int	getNumValues()
O	getOrder()
G	getPage()
S	getSelect()
java.util.List<org.apache.commons.collections4.KeyValue>	getValues()
W	getWhere()
boolean	isDryRun() Test if this query sould actually be run or just planned.
T	withCollection(Collection coll)
protected T	withColValue(java.lang.String columnName, java.lang.Object value)
T	withDb(D db)
T	withDryRun(boolean dryRun)
T	withTerm(Term term) OVERRIDE ME TO ADD CUSTOM FUNCTIONALITY TO YOUR FLUENT API

Methods inherited from class io.inversion.rql.Builder

addTerm, clearFunctions, find, find, findAll, findInt, findTerm, getParent, getRoot, getTerms, isFunction, parse, r, removeBuilder, toString, toString, withBuilder, withFunctions, withFunctions, withParent, withTerm, withTerm, withTerms

Methods inherited from class java.lang.Object

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

Field Detail

values

protected final java.util.List<org.apache.commons.collections4.KeyValue> values

db

protected D extends Db db

collection

protected Collection collection

select

protected S extends Select select

from

protected F extends From from

where

protected W extends Where where

group

protected R extends Group group

order

protected O extends Order order

page

protected G extends Page page

dryRun

protected boolean dryRun

Constructor Detail

Query

public Query()

Query

public Query(D db,
             Collection coll)

Query

public Query(D db,
             Collection coll,
             java.lang.Object terms,
             java.lang.String... functions)

Method Detail

createSelect

protected S createSelect()

createFrom

protected F createFrom()

createWhere

protected W createWhere()

createGroup

protected R createGroup()

createOrder

protected O createOrder()

createPage

protected G createPage()

withTerm

public T withTerm(Term term)

Description copied from class: Builder

OVERRIDE ME TO ADD CUSTOM FUNCTIONALITY TO YOUR FLUENT API

Overrides:

withTerm in class Builder<T extends Query,T extends Query>

Parameters:

term - the term to add to the builder

Returns:

this

doSelect

public Results doSelect()
                 throws ApiException

Throws:

ApiException

getBuilders

public java.util.List<Builder> getBuilders()

Overrides:

getBuilders in class Builder<T extends Query,T extends Query>

getSelect

public S getSelect()

getFrom

public F getFrom()

getWhere

public W getWhere()

getGroup

public R getGroup()

getOrder

public O getOrder()

getPage

public G getPage()

getCollection

public Collection getCollection()

getDb

public D getDb()

withDb

public T withDb(D db)

withCollection

public T withCollection(Collection coll)

getNumValues

public int getNumValues()

clearValues

protected T clearValues()

withColValue

protected T withColValue(java.lang.String columnName,
                         java.lang.Object value)

getColValueKeys

public java.util.List<java.lang.String> getColValueKeys()

getColValues

public java.util.List<java.lang.Object> getColValues()

getColValue

public org.apache.commons.collections4.KeyValue<java.lang.String,java.lang.String> getColValue(int index)

getValues

public java.util.List<org.apache.commons.collections4.KeyValue> getValues()

isDryRun

public boolean isDryRun()

Test if this query sould actually be run or just planned.

Returns:

true if dryRun is true or db.isDryRun is true

withDryRun

public T withDryRun(boolean dryRun)