io.github.prolobjectlink.prolog

Class AbstractQuery

java.lang.Object

io.github.prolobjectlink.prolog.AbstractIterator<Collection<PrologTerm>>

io.github.prolobjectlink.prolog.AbstractQuery

All Implemented Interfaces:

PrologQuery, Iterable<Collection<PrologTerm>>, Iterator<Collection<PrologTerm>>

public abstract class AbstractQuery
extends AbstractIterator<Collection<PrologTerm>>
implements PrologQuery

Partial implementation of PrologQuery interface.

Since:

1.0

Author:

Jose Zalacain

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractEngine	engine

Constructor Summary

Constructors

Constructor and Description
AbstractQuery(AbstractEngine engine)

Method Summary

Modifier and Type	Method and Description
List<List<Object>>	allResults() Return a list of list of Java Objects that conform the solution set for the current query.
List<Map<String,Object>>	allVariablesResults() Return a list of map of variables name key and Java objects as value that conform the solution set for the current query.
protected boolean	contains(List<Map<String,PrologTerm>> maps, Map<String,PrologTerm> map)
protected boolean	contains(List<PrologTerm[]> arrays, PrologTerm[] array)
boolean	equals(Object obj)
protected <K> K	fromTerm(PrologTerm term, Class<K> to)
PrologEngine	getEngine() Engine hold by the current query
protected PrologLogger	getLogger()
PrologProvider	getProvider() Provider instance
int	hashCode()
boolean	hasNext()
Iterator<Collection<PrologTerm>>	iterator()
Map<String,PrologTerm>	more() Return the next prolog terms that conform the solution set for the current query.
Collection<PrologTerm>	next()
List<Object>	nextResult() Return the next Java objects solution list for the current query.
Map<String,Object>	nextVariablesResult() Return the next Java objects that conform the solution set for the current query.
List<List<Object>>	nResult(int n) Return a list of list of Java Objects that conform the solution set for the current query where n is the solution number and m is a free variable number in the query.
List<Map<String,PrologTerm>>	nths(int n) Return a list of n size with maps of variables name key and Prolog terms as value that conform the solution set for the current query where n is the solution number.
List<Map<String,Object>>	nVariablesResults(int n) Return a list of n size with maps of variables name key and Java objects as value that conform the solution set for the current query where n is the solution number.
Map<String,PrologTerm>	one() Return a map of variables name key and Prolog terms as value that conform the solution set for the current query.
List<Object>	oneResult() Return the equivalent Java objects that conform the solution set for the current query.
Map<String,Object>	oneVariablesResult() Return the equivalent Java objects that conform the solution set for the current query.
void	remove()
protected <K extends PrologTerm> K	toTerm(Object o, Class<K> from)
protected <K extends PrologTerm,V> Map<String,PrologTerm>[]	toTermMapArray(Map<String,V>[] map, Class<K> from)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.prolobjectlink.prolog.PrologQuery

all, allSolutions, allVariablesSolutions, dispose, hasMoreSolutions, hasSolution, nextSolution, nextVariablesSolution, nSolutions, nVariablesSolutions, oneSolution, oneVariablesSolution

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

engine

protected final AbstractEngine engine

Constructor Detail

AbstractQuery

public AbstractQuery(AbstractEngine engine)

Method Detail

getEngine

public final PrologEngine getEngine()

Description copied from interface: PrologQuery

Engine hold by the current query

Specified by:

getEngine in interface PrologQuery

Returns:

used by the current query

getProvider

public final PrologProvider getProvider()

Description copied from interface: PrologQuery

Provider instance

Specified by:

getProvider in interface PrologQuery

Returns:

provider instance

toTerm

protected final <K extends PrologTerm> K toTerm(Object o,
                                                Class<K> from)

toTermMapArray

protected final <K extends PrologTerm,V> Map<String,PrologTerm>[] toTermMapArray(Map<String,V>[] map,
                                                                                 Class<K> from)

fromTerm

protected final <K> K fromTerm(PrologTerm term,
                               Class<K> to)

contains

protected final boolean contains(List<Map<String,PrologTerm>> maps,
                                 Map<String,PrologTerm> map)

contains

protected final boolean contains(List<PrologTerm[]> arrays,
                                 PrologTerm[] array)

getLogger

protected final PrologLogger getLogger()

iterator

public final Iterator<Collection<PrologTerm>> iterator()

Specified by:

iterator in interface Iterable<Collection<PrologTerm>>

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface Iterator<Collection<PrologTerm>>

next

public final Collection<PrologTerm> next()

Specified by:

next in interface Iterator<Collection<PrologTerm>>

remove

public final void remove()

Specified by:

remove in interface Iterator<Collection<PrologTerm>>

Overrides:

remove in class AbstractIterator<Collection<PrologTerm>>

one

public final Map<String,PrologTerm> one()

Description copied from interface: PrologQuery

Return a map of variables name key and Prolog terms as value that conform the solution set for the current query.

Specified by:

one in interface PrologQuery

Returns:

a map of variables name key and Prolog terms as value that conform the solution set

nths

public final List<Map<String,PrologTerm>> nths(int n)

Description copied from interface: PrologQuery

Return a list of n size with maps of variables name key and Prolog terms as value that conform the solution set for the current query where n is the solution number.

Specified by:

nths in interface PrologQuery

Parameters:

n - list order or Prolog term items number

Returns:

an list of n size with maps of variables name key and Prolog terms as value that conform the solution set

more

public final Map<String,PrologTerm> more()

Description copied from interface: PrologQuery

Return the next prolog terms that conform the solution set for the current query. The solution set is a prolog terms map and every map entry is a pair variable name and variable instance value for the variables not anonymous involved in the query.

Specified by:

more in interface PrologQuery

Returns:

variable name - variable instance (key - value) map that conform the solution set for the current query.

oneResult

public final List<Object> oneResult()

Description copied from interface: PrologQuery

Return the equivalent Java objects that conform the solution set for the current query. The solution set is a Java objects list and every term is a conversion of the instance value for the variables not anonymous involved in the query.

 List<Object> solution = query.oneResult();
 for (int i = 0; i < solution.size(); i++) {
        System.out.println(solution.get(i));
 }
 

Specified by:

oneResult in interface PrologQuery

Returns:

Java objects solution list for the current query

nextResult

public final List<Object> nextResult()

Description copied from interface: PrologQuery

Return the next Java objects solution list for the current query. The solution is a Java objects list and every object is an instance value for the variables not anonymous involved in the query.

Specified by:

nextResult in interface PrologQuery

Returns:

Java objects solution list for the current query

nResult

public final List<List<Object>> nResult(int n)

Description copied from interface: PrologQuery

Return a list of list of Java Objects that conform the solution set for the current query where n is the solution number and m is a free variable number in the query.

Specified by:

nResult in interface PrologQuery

Parameters:

n - list order or Java objects rows number

Returns:

a list of list of Java Objects that conform the solution set

allResults

public final List<List<Object>> allResults()

Description copied from interface: PrologQuery

Return a list of list of Java Objects that conform the solution set for the current query.

Specified by:

allResults in interface PrologQuery

Returns:

a list of list of Java Objects that conform the solution set for the current query.

oneVariablesResult

public final Map<String,Object> oneVariablesResult()

Description copied from interface: PrologQuery

Return the equivalent Java objects that conform the solution set for the current query. The solution set is a Java object map and every map entry is a pair variable name and a Java object conversion of the variable instance value for the variables not anonymous involved in the query.

Specified by:

oneVariablesResult in interface PrologQuery

Returns:

variable name - Java object conversion of the variable instance (key - value) map that conform the solution set for the current query.

nextVariablesResult

public final Map<String,Object> nextVariablesResult()

Description copied from interface: PrologQuery

Return the next Java objects that conform the solution set for the current query. The solution set is an objects map and every map entry is a pair variable name and variable instance value for the variables not anonymous involved in the query.

Specified by:

nextVariablesResult in interface PrologQuery

Returns:

variable name - variable instance (key - value) map that conform the solution set for the current query.

nVariablesResults

public final List<Map<String,Object>> nVariablesResults(int n)

Description copied from interface: PrologQuery

Return a list of n size with maps of variables name key and Java objects as value that conform the solution set for the current query where n is the solution number.

Specified by:

nVariablesResults in interface PrologQuery

Parameters:

n - list order or Java objects items number

Returns:

a list of n size with maps of variables name key and Java objects as value that conform the solution set

allVariablesResults

public final List<Map<String,Object>> allVariablesResults()

Description copied from interface: PrologQuery

Return a list of map of variables name key and Java objects as value that conform the solution set for the current query.

Specified by:

allVariablesResults in interface PrologQuery

Returns:

a list of map of variables name key and Java objects as value that conform the solution set

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object