io.github.prolobjectlink.prolog

Interface PrologQuery

All Superinterfaces:

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

All Known Implementing Classes:

AbstractQuery

public interface PrologQuery
extends Iterator<Collection<PrologTerm>>, Iterable<Collection<PrologTerm>>

Prolog query is the mechanism to query the prolog database loaded in prolog engine. The way to create a new prolog query is invoking PrologEngine.query(String), PrologEngine.query(PrologTerm, PrologTerm...) or PrologEngine.query(PrologTerm[]). When this methods are called the prolog query is open an only with dispose() close the current query and release all internal resources.

Prolog query implement Iterable and Iterator. This implementation help to obtain successive solutions present in the query.

 PrologEngine engine = provider.newEngine("zoo.pl");
 PrologVariable x = provider.newVariable("X", 0);
 PrologQuery query = engine.query(provider.newStructure("dark", x));
 while (query.hasNext()) {
        PrologTerm value = query.nextVariablesSolution().get("X");
        System.out.println(value);
 }
 query.dispose();
 

 PrologEngine engine = provider.newEngine("zoo.pl");
 PrologVariable x = provider.newVariable("X", 0);
 PrologQuery query = engine.query(provider.newStructure("dark", x));
 for (Collection<PrologTerm> col : query) {
        for (PrologTerm prologTerm : col) {
                System.out.println(prologTerm);
        }
 }
 query.dispose();
 

Since:

1.0

Author:

Jose Zalacain

Method Summary

Modifier and Type	Method and Description
List<Map<String,PrologTerm>>	all() Return a list of map of variables name key and Prolog terms as value that conform the solution set for the current query.
List<List<Object>>	allResults() Return a list of list of Java Objects that conform the solution set for the current query.
PrologTerm[][]	allSolutions() Return a Prolog terms matrix of n x m order 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,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.
Map<String,PrologTerm>[]	allVariablesSolutions() Return an array of map of variables name key and Prolog terms as value that conform the solution set for the current query.
void	dispose() Release all allocations for the query
PrologEngine	getEngine() Engine hold by the current query
PrologProvider	getProvider() Provider instance
boolean	hasMoreSolutions() Check if the current query has more solutions.
boolean	hasSolution() Check that the current query has solution.
Map<String,PrologTerm>	more() Return the next prolog terms that conform the solution set for the current query.
List<Object>	nextResult() Return the next Java objects solution list for the current query.
PrologTerm[]	nextSolution() Return the next prolog terms solution array for the current query.
Map<String,Object>	nextVariablesResult() Return the next Java objects that conform the solution set for the current query.
Map<String,PrologTerm>	nextVariablesSolution() Return the next prolog terms 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.
PrologTerm[][]	nSolutions(int n) Return a Prolog terms matrix of n x m order 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>[]	nVariablesSolutions(int n) Return an array 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.
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.
PrologTerm[]	oneSolution() Return the prolog terms 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.
Map<String,PrologTerm>	oneVariablesSolution() Return the prolog terms that conform the solution set for the current query.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getProvider

PrologProvider getProvider()

Provider instance

Returns:

provider instance

Since:

1.0

getEngine

PrologEngine getEngine()

Engine hold by the current query

Returns:

used by the current query

Since:

1.0

hasSolution

boolean hasSolution()

Check that the current query has solution.

Returns:

true if the current query has solution, false if not

Since:

1.0

hasMoreSolutions

boolean hasMoreSolutions()

Check if the current query has more solutions.

Returns:

true if the current query has more solutions, false if not

Since:

1.0

oneSolution

PrologTerm[] oneSolution()

Return the prolog terms that conform the solution set for the current query. The solution is a prolog terms array and every term is an instance value for the variables not anonymous involved in the query.

Returns:

prolog terms solution array for the current query

Since:

1.0

oneVariablesSolution

Map<String,PrologTerm> oneVariablesSolution()

Return the 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.

Returns:

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

Since:

1.0

nextSolution

PrologTerm[] nextSolution()

Return the next prolog terms solution array for the current query. The solution is a prolog terms array and every term is an instance value for the variables not anonymous involved in the query.

Returns:

prolog terms solution array for the current query

Since:

1.0

nextVariablesSolution

Map<String,PrologTerm> nextVariablesSolution()

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.

Returns:

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

Since:

1.0

nSolutions

PrologTerm[][] nSolutions(int n)

Return a Prolog terms matrix of n x m order 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.

Parameters:

n - array order or Prolog term rows number

Returns:

a Prolog terms matrix of n x m order that conform the solution set

Since:

1.0

nVariablesSolutions

Map<String,PrologTerm>[] nVariablesSolutions(int n)

Return an array 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.

Parameters:

n - array order or Prolog term items number

Returns:

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

Since:

1.0

allSolutions

PrologTerm[][] allSolutions()

Return a Prolog terms matrix of n x m order 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.

Returns:

a Prolog terms matrix of n x m order that conform the solution set

Since:

1.0

allVariablesSolutions

Map<String,PrologTerm>[] allVariablesSolutions()

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

Returns:

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

Since:

1.0

oneResult

List<Object> oneResult()

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));
 }
 

Returns:

Java objects solution list for the current query

Since:

1.0

oneVariablesResult

Map<String,Object> oneVariablesResult()

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.

Returns:

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

Since:

1.0

nextResult

List<Object> nextResult()

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.

Returns:

Java objects solution list for the current query

Since:

1.1

nextVariablesResult

Map<String,Object> nextVariablesResult()

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.

Returns:

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

Since:

1.1

nResult

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.

Parameters:

n - list order or Java objects rows number

Returns:

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

Since:

1.1

nVariablesResults

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.

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

Since:

1.1

allResults

List<List<Object>> allResults()

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

Returns:

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

Since:

1.0

allVariablesResults

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.

Returns:

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

Since:

1.0

one

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.

Returns:

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

Since:

1.0

more

Map<String,PrologTerm> more()

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.

Returns:

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

Since:

1.1

nths

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.

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

Since:

1.1

all

List<Map<String,PrologTerm>> all()

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

Returns:

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

Since:

1.0

dispose

void dispose()

Release all allocations for the query

Since:

1.0