org.jpc.query

Class QueryAdapter

java.lang.Object

org.jpc.query.Cursor<Solution>

org.jpc.query.Query

org.jpc.query.QueryAdapter

All Implemented Interfaces:

AutoCloseable, Iterator<Solution>

Direct Known Subclasses:

LogtalkQuery, ObservableQuery

public class QueryAdapter
extends Query

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.base.Function<Solution,Solution>	adapterFunction
protected Query	query

Constructor Summary

Constructors

Constructor and Description
QueryAdapter(Query query)
QueryAdapter(Query query, com.google.common.base.Function<Solution,Solution> adapterFunction)

Method Summary

Modifier and Type	Method and Description
protected void	basicAbort()
protected List<Solution>	basicAllSolutions() The default implementation for obtaining all the solutions consists on just making use of the existing next() method However, children could override this in case many calls to next() are more expensive that obtaining all the results of the query at once (e.g., a findall/3 query in Prolog)
protected void	basicClose()
protected Solution	basicNext() Returns the next available element in the cursor.
protected Solution	basicOneSolutionOrThrow()
protected Term	getDefaultSelectedTerm() The default selected term when select* methods are called without specifying a select term By default, a PrologEngineQuery uses its goal.
Term	getGoal()
Jpc	getJpcContext()
PrologEngine	getPrologEngine()
boolean	isAbortable()
boolean	isErrorHandledQuery()
protected boolean	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, allSolutions, basicSolutionsRange, close, filter, finalize, getState, hasNext, hasSolution, isExhausted, isOpen, isReady, iterativeAllSolutions, next, nonSynchronizedClose, nSolutions, numberOfSolutions, oneSolution, oneSolutionOrThrow, remove, setState, solutionsRange

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

Field Detail

adapterFunction

protected com.google.common.base.Function<Solution,Solution> adapterFunction

query

protected Query query

Constructor Detail

QueryAdapter

public QueryAdapter(Query query)

QueryAdapter

public QueryAdapter(Query query,
                    com.google.common.base.Function<Solution,Solution> adapterFunction)

Method Detail

isAbortable

public boolean isAbortable()

Specified by:

isAbortable in class Cursor<Solution>

getJpcContext

public Jpc getJpcContext()

Specified by:

getJpcContext in class Query

getPrologEngine

public PrologEngine getPrologEngine()

Specified by:

getPrologEngine in class Query

getGoal

public Term getGoal()

Specified by:

getGoal in class Query

isErrorHandledQuery

public boolean isErrorHandledQuery()

Specified by:

isErrorHandledQuery in class Query

shouldVerifySolution

protected boolean shouldVerifySolution()

Overrides:

shouldVerifySolution in class Query

getDefaultSelectedTerm

protected Term getDefaultSelectedTerm()

Description copied from class: Query

The default selected term when select* methods are called without specifying a select term By default, a PrologEngineQuery uses its goal. QueryAdapter queries use their adapted default selected term. Other QueryAdapter classes may find useful to override this method. For example, ExceptionHandledQuery overrides this method so it is the first argument in the catch block of the original goal. Logtalk queries overrides this so the default selected term is the Logtalk method and parameters (excluding the id of the Logtalk object and the :: operator)

Specified by:

getDefaultSelectedTerm in class Query

Returns:

basicOneSolutionOrThrow

protected Solution basicOneSolutionOrThrow()

Overrides:

basicOneSolutionOrThrow in class Cursor<Solution>

basicAllSolutions

protected List<Solution> basicAllSolutions()

Description copied from class: Cursor

The default implementation for obtaining all the solutions consists on just making use of the existing next() method However, children could override this in case many calls to next() are more expensive that obtaining all the results of the query at once (e.g., a findall/3 query in Prolog)

Overrides:

basicAllSolutions in class Query

Returns:

a list with all solutions.

basicAbort

protected void basicAbort()

Specified by:

basicAbort in class Cursor<Solution>

basicClose

protected void basicClose()

Specified by:

basicClose in class Cursor<Solution>

basicNext

protected Solution basicNext()

Description copied from class: Cursor

Returns the next available element in the cursor. If the cursor is exhausted it should throw a NoSuchElementException the first time it is invoked. Its behavior is undetermined if invoked more than once after the cursor has been exhausted.

Specified by:

basicNext in class Cursor<Solution>

Returns: