Package com.tonic.analysis.query.ast

Class FindQuery

java.lang.Object

com.tonic.analysis.query.ast.FindQuery

All Implemented Interfaces:

Query

public final class FindQuery
extends Object
implements Query

FIND query - returns matching entities with evidence.

Constructor Summary

Constructors

Constructor	Description
FindQuery(Target target, Scope scope, Condition condition, RunSpec runSpec, Integer limit, OrderBy orderBy)	Creates a FIND query.

Method Summary

Modifier and Type	Method	Description
Condition	condition()
boolean	equals(Object o)
int	hashCode()
Integer	limit()
OrderBy	orderBy()
RunSpec	runSpec()
Scope	scope()
Target	target()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FindQuery

public FindQuery(Target target,
                 Scope scope,
                 Condition condition,
                 RunSpec runSpec,
                 Integer limit,
                 OrderBy orderBy)

Creates a FIND query.

Parameters:

target - the entity kind being searched

scope - the scope restricting the search, may be null

condition - the WHERE condition, may be null

runSpec - optional execution settings, may be null

limit - optional result cap, may be null

orderBy - optional result ordering, may be null

Method Detail

target

public Target target()

Specified by:

target in interface Query

Returns:

the kind of entity the query returns

scope

public Scope scope()

Specified by:

scope in interface Query

Returns:

the scope restricting what is searched, null when unrestricted

condition

public Condition condition()

Specified by:

condition in interface Query

Returns:

the WHERE condition, null when there is none

runSpec

public RunSpec runSpec()

Specified by:

runSpec in interface Query

Returns:

the execution budget and tracing settings, null when the query needs no run

limit

public Integer limit()

Specified by:

limit in interface Query

Returns:

the maximum number of results, null when uncapped

orderBy

public OrderBy orderBy()

Specified by:

orderBy in interface Query

Returns:

the result ordering, null when unordered

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object