io.inversion

Class Results<M extends java.util.Map<java.lang.String,java.lang.Object>>

java.lang.Object

io.inversion.Results<M>

All Implemented Interfaces:

java.lang.Iterable<M>

public class Results<M extends java.util.Map<java.lang.String,java.lang.Object>>
extends java.lang.Object
implements java.lang.Iterable<M>

Results are returned by a Db and transformed by Actions into Response content.

Dbs are not responsible for mapping from column names to json names so a Results rows and terms will use column names until they are potentially transformed by an Action.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	debugQuery
protected int	foundRows The total number of rows (if known) in the Db that match the query, not the number of rows returned in this Results.
static java.lang.String	LAST_QUERY
protected java.util.List<Term>	next The RQL terms that will get the next page of results the DB things there are more results.
protected Query	query the query that produced these results.
protected java.util.List<M>	rows The data the query produced.
protected java.lang.String	testQuery

Constructor Summary

Constructors

Constructor and Description
Results(Query query)
Results(Query query, int foundRows, java.util.List<M> rows)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDebugQuery()
int	getFoundRows()
java.util.List<Term>	getNext()
Query	getQuery()
M	getRow(int index)
java.util.List<M>	getRows()
java.lang.String	getTestQuery()
boolean	isDryRun()
java.util.Iterator<M>	iterator()
Results	setRow(int index, M row)
int	size()
Results	withDebugQuery(java.lang.String debugQuery)
Results	withFoundRows(int foundRows)
Results	withNext(java.util.List<Term> next)
Results	withNext(Term next)
Results	withQuery(Query query)
Results	withRow(M row)
Results	withRows(java.util.List rows)
Results	withTestQuery(java.lang.String testQuery)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LAST_QUERY

public static java.lang.String LAST_QUERY

next

protected final java.util.List<Term> next

The RQL terms that will get the next page of results the DB things there are more results.

Dbs are not responsible for mapping from column names to json names so these terms will have column names when initially returned from the Db.

Actions should map the keys to the corresponding json name property names before returning to the caller.

query

protected Query query

the query that produced these results.

rows

protected java.util.List<M extends java.util.Map<java.lang.String,java.lang.Object>> rows

The data the query produced.

Dbs are not responsible for mapping from column names to json names so these maps will have column names keys when initially returned from the Db.

Actions should map them to the corresponding json property names before returning to the caller.

foundRows

protected int foundRows

The total number of rows (if known) in the Db that match the query, not the number of rows returned in this Results.

For paginated listings, foundRows generally be greater than rows.size()

debugQuery

protected java.lang.String debugQuery

testQuery

protected java.lang.String testQuery

Constructor Detail

Results

public Results(Query query)

Results

public Results(Query query,
               int foundRows,
               java.util.List<M> rows)

Method Detail

getQuery

public Query getQuery()

withQuery

public Results withQuery(Query query)

iterator

public java.util.Iterator<M> iterator()

Specified by:

iterator in interface java.lang.Iterable<M extends java.util.Map<java.lang.String,java.lang.Object>>

size

public int size()

getRow

public M getRow(int index)

setRow

public Results setRow(int index,
                      M row)

getRows

public java.util.List<M> getRows()

withRows

public Results withRows(java.util.List rows)

withRow

public Results withRow(M row)

getNext

public java.util.List<Term> getNext()

withNext

public Results withNext(Term next)

withNext

public Results withNext(java.util.List<Term> next)

getFoundRows

public int getFoundRows()

withFoundRows

public Results withFoundRows(int foundRows)

isDryRun

public boolean isDryRun()

getDebugQuery

public java.lang.String getDebugQuery()

withDebugQuery

public Results withDebugQuery(java.lang.String debugQuery)

getTestQuery

public java.lang.String getTestQuery()

withTestQuery

public Results withTestQuery(java.lang.String testQuery)