org.jpc.query

Class ObservableQuery

java.lang.Object

org.jpc.query.Cursor<Solution>

org.jpc.query.Query

org.jpc.query.QueryAdapter

org.jpc.query.ObservableQuery

All Implemented Interfaces:

AutoCloseable, Iterator<Solution>

public class ObservableQuery
extends QueryAdapter

Field Summary

Fields inherited from class org.jpc.query.QueryAdapter

adapterFunction, query

Constructor Summary

Constructors

Constructor and Description
ObservableQuery(Query query)
ObservableQuery(Query query, Iterable<QueryListener> listeners)

Method Summary

Modifier and Type	Method and Description
void	addQueryListener(QueryListener listener)
void	addQueryListeners(Iterable<QueryListener> listeners)
List<Solution>	allSolutions()
boolean	hasNext() Answers if there are still rows in the cursor.
Solution	next() Answers the next solution.
Solution	oneSolutionOrThrow()
void	removeQueryListener(QueryListener listener)
protected void	setState(CursorState state)
List<Solution>	solutionsRange(long from, long to)

Methods inherited from class org.jpc.query.QueryAdapter

basicAbort, basicAllSolutions, basicClose, basicNext, basicOneSolutionOrThrow, getDefaultSelectedTerm, getGoal, getJpcContext, getPrologEngine, isAbortable, isErrorHandledQuery, shouldVerifySolution

Methods inherited from class org.jpc.query.Query

allSolutionsMultimap, asTerm, cachedNext, errorCheck, getAllSolutionsBindingsTerm, select, select, select, selectObject, selectObject, selectObject, selectObject, selectObject, selectObject

Methods inherited from class org.jpc.query.Cursor

abort, adapt, basicSolutionsRange, close, filter, finalize, getState, hasSolution, isExhausted, isOpen, isReady, iterativeAllSolutions, nonSynchronizedClose, nSolutions, numberOfSolutions, oneSolution, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

ObservableQuery

public ObservableQuery(Query query)

ObservableQuery

public ObservableQuery(Query query,
                       Iterable<QueryListener> listeners)

Method Detail

setState

protected void setState(CursorState state)

Overrides:

setState in class Cursor<Solution>

hasNext

public boolean hasNext()

Description copied from class: Cursor

Answers if there are still rows in the cursor. This method may have effects on the state of the cursor. If the cursor is in READY state, it will change it to OPEN. If there are no more elements, it will change the state of the cursor to EXHAUSTED.

Specified by:

hasNext in interface Iterator<Solution>

Overrides:

hasNext in class Cursor<Solution>

Returns:

true if there are more solutions, false otherwise.

next

public Solution next()

Description copied from class: Cursor

Answers the next solution.

Specified by:

next in interface Iterator<Solution>

Overrides:

next in class Cursor<Solution>

Returns:

the next solution

oneSolutionOrThrow

public Solution oneSolutionOrThrow()

Overrides:

oneSolutionOrThrow in class Cursor<Solution>

Returns:

the first solution to the query.

solutionsRange

public List<Solution> solutionsRange(long from,
                                     long to)

Overrides:

solutionsRange in class Cursor<Solution>

Parameters:

from - the (0-based) index (inclusive) of the first solution

to - the (0-based) index (exclusive) of the last solution

Returns:

a list with the solutions starting from 'from' (inclusive) to 'to' (exclusive) or until exhaustion of the solutions (whatever happens first). If there are less than (from+1) solutions will return an empty List

allSolutions

public List<Solution> allSolutions()

Overrides:

allSolutions in class Cursor<Solution>

Returns:

a list with all solutions.

addQueryListeners

public void addQueryListeners(Iterable<QueryListener> listeners)

addQueryListener

public void addQueryListener(QueryListener listener)

removeQueryListener

public void removeQueryListener(QueryListener listener)