io.github.prolobjectlink.prolog

Interface PrologQueryBuilder

public interface PrologQueryBuilder

Prolog query builder to create prolog queries. The mechanism to create a new query builder is using PrologEngine.newQueryBuilder(). The query builder emulate the query creation process. After define all participant terms with the begin(PrologTerm) method, we specify the first term in the query. If the query have more terms, they are created using comma(PrologTerm) for every one. Clause builder have a getQueryString() for string representation of the clause in progress. After clause definition this builder have query() method that create the final query instance ready to be used.

 PrologVariable x = provider.newVariable("X", 0);
 PrologStructure big = provider.newStructure("big", x);
 PrologStructure dark = provider.newStructure("dark", x);
 PrologQueryBuilder builder = engine.newQueryBuilder();
 PrologQuery query = builder.begin(dark).comma(big).query();
 

Prolog result

 ?- big(X), dark(X).
 

Since:

1.0

Author:

Jose Zalacain

Method Summary

Modifier and Type	Method and Description
PrologQueryBuilder	begin(PrologTerm term) Append to the query builder the first term to be query.
PrologQueryBuilder	begin(String functor, PrologTerm... arguments) Append to the query builder the first term to be query.
PrologQueryBuilder	comma(PrologTerm term) Append to the query builder other term to be query in conjunctive mode.
PrologQueryBuilder	comma(PrologTerm left, String operator, PrologTerm right) Append to the query builder other term to be query in conjunctive mode.
PrologQueryBuilder	comma(String functor, PrologTerm... arguments) Append to the query builder other term to be query in conjunctive mode.
PrologEngine	getEngine() Engine hold by the current builder
String	getQueryString() Get the query in string format.
PrologQuery	query() Create and return the result query.
PrologQueryBuilder	semicolon(PrologTerm term) Append to the query builder other term to be query in disjunctive mode.
PrologQueryBuilder	semicolon(PrologTerm left, String operator, PrologTerm right) Append to the query builder other term to be query in disjunctive mode.
PrologQueryBuilder	semicolon(String functor, PrologTerm... arguments) Append to the query builder other term to be query in disjunctive mode.

Method Detail

begin

PrologQueryBuilder begin(PrologTerm term)

Append to the query builder the first term to be query. Return the current builder instance after append the term to be query.

Parameters:

term - term to be query.

Returns:

the current builder instance after append the term to be query.

Since:

1.0

begin

PrologQueryBuilder begin(String functor,
                         PrologTerm... arguments)

Append to the query builder the first term to be query. The term passed to the builder for this case is an structure created using the given functor and arguments array. Return the current builder instance after append the term to be query.

Parameters:

functor - string name for the structure term to be query.

arguments - prolog term arguments for the structure term to be query.

Returns:

the current builder instance after append the term to be query.

Since:

1.0

semicolon

PrologQueryBuilder semicolon(PrologTerm left,
                             String operator,
                             PrologTerm right)

Append to the query builder other term to be query in disjunctive mode. The term passed to the builder for this case is an expression created using the given operator and operands. Return the current builder instance after append the term to be query.

Parameters:

operator - expression operator.

left - left hand prolog term operand.

right - right hand prolog term operand.

Returns:

the current builder instance after append the term to be query.

Since:

1.0

semicolon

PrologQueryBuilder semicolon(String functor,
                             PrologTerm... arguments)

Append to the query builder other term to be query in disjunctive mode. The term passed to the builder for this case is an structure created using the given functor and arguments array. Return the current builder instance after append the term to be query.

Parameters:

functor - string name for the structure term to be query.

arguments - prolog term arguments for the structure term to be query.

Returns:

the current builder instance after append the term to be query.

Since:

1.0

semicolon

PrologQueryBuilder semicolon(PrologTerm term)

Append to the query builder other term to be query in disjunctive mode. Return the current builder instance after append the term to be query.

Parameters:

term - term to be query.

Returns:

the current builder instance after append the term to be query.

Since:

1.0

comma

PrologQueryBuilder comma(PrologTerm left,
                         String operator,
                         PrologTerm right)

Append to the query builder other term to be query in conjunctive mode. The term passed to the builder for this case is an expression created using the given operator and operands. Return the current builder instance after append the term to be query.

Parameters:

operator - expression operator.

left - left hand prolog term operand.

right - right hand prolog term operand.

Returns:

the current builder instance after append the term to be query.

Since:

1.0

comma

PrologQueryBuilder comma(String functor,
                         PrologTerm... arguments)

Append to the query builder other term to be query in conjunctive mode. The term passed to the builder for this case is an structure created using the given functor and arguments array. Return the current builder instance after append the term to be query.

Parameters:

functor - string name for the structure term to be query.

arguments - prolog term arguments for the structure term to be query.

Returns:

the current builder instance after append the term to be query.

Since:

1.0

comma

PrologQueryBuilder comma(PrologTerm term)

Append to the query builder other term to be query in conjunctive mode. Return the current builder instance after append the term to be query.

Parameters:

term - term to be query.

Returns:

the current builder instance after append the term to be query.

Since:

1.0

getQueryString

String getQueryString()

Get the query in string format.

Returns:

string query.

Since:

1.0

query

PrologQuery query()

Create and return the result query.

Returns:

the result query.

Since:

1.0

getEngine

PrologEngine getEngine()

Engine hold by the current builder

Returns:

engine used by the current builder

Since:

1.0