io.github.prolobjectlink.prolog

Interface PrologClauseBuilder

public interface PrologClauseBuilder

Prolog clause builder to create prolog clauses. The mechanism to create a new clause builder is using PrologEngine.newClauseBuilder(). The clause builder emulate the clause creation process. After define all participant terms with the begin(PrologTerm) method, we specify the head of the clause.

If the clause is a rule, after head definition, the clause body is created with neck(PrologTerm) for the first term in the clause body. If the clause body have more terms, they are created using comma(PrologTerm) for every one.

Clause builder have a getClauseString() for string representation of the clause in progress. After clause definition this builder have asserta(),assertz(),clause(),retract() that use the wrapped engine invoking the correspondent methods for check, insert or remove clause respectively.

 PrologStructure blackZ = provider.newStructure("black", z);
 PrologStructure brownZ = provider.newStructure("brown", z);
 PrologClauseBuilder builder = engine.newClauseBuilder();
 builder.begin(darkZ).neck(blackZ).assertz();
 builder.begin(darkZ).neck(brownZ).assertz();
 

Prolog result.

 dark(Z) :- 
        black(Z).
 dark(Z) :- 
        brown(Z).
 

Since:

1.0

Author:

Jose Zalacain

Method Summary

Modifier and Type	Method and Description
void	asserta() Add the current clause in the main memory program if the clause non exist.
void	assertz() Add the clause in the main memory program if the clause non exist.
PrologClauseBuilder	begin(PrologTerm term) Append to the clause builder the head term in the clause.
PrologClauseBuilder	begin(String functor, PrologTerm... arguments) Append to the clause builder the head term in the clause.
boolean	clause() Check if the clause in the main memory program unify with the current clause and return true.
PrologClauseBuilder	comma(PrologTerm term) Append to the clause builder other term in the clause body in conjunctive mode.
PrologClauseBuilder	comma(PrologTerm left, String operator, PrologTerm right) Append to the clause builder other term in the clause body in conjunctive mode.
PrologClauseBuilder	comma(String functor, PrologTerm... arguments) Append to the clause builder other term in the clause body in conjunctive mode.
String	getClauseString() Get the clause in string format.
PrologEngine	getEngine() Engine hold by the current builder
PrologClauseBuilder	neck(PrologTerm term) Append to the clause builder the first term in the clause body.
PrologClauseBuilder	neck(PrologTerm left, String operator, PrologTerm right) Append to the clause builder the first term in the clause body.
PrologClauseBuilder	neck(String functor, PrologTerm... arguments) Append to the clause builder the first term in the clause body.
void	retract() Remove the clause in the main memory program if the clause exist.

Method Detail

begin

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

Append to the clause builder the head term in the clause. 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 in the clause.

Parameters:

functor - string name for the structure term.

arguments - prolog term arguments for the structure.

Returns:

the current builder instance after append the term in the clause.

Since:

1.0

begin

PrologClauseBuilder begin(PrologTerm term)

Append to the clause builder the head term in the clause. Return the current builder instance after append the term in the clause.

Parameters:

term - term to be the head in the clause.

Returns:

the current builder instance after append the term in the clause.

Since:

1.0

neck

PrologClauseBuilder neck(PrologTerm left,
                         String operator,
                         PrologTerm right)

Append to the clause builder the first term in the clause body. 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 in the clause body

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 in the clause body.

Since:

1.0

neck

PrologClauseBuilder neck(String functor,
                         PrologTerm... arguments)

Append to the clause builder the first term in the clause body. 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 in the clause body

Parameters:

functor - string name for the structure term.

arguments - prolog term arguments for the structure term.

Returns:

the current builder instance after append the term in the clause body.

Since:

1.0

neck

PrologClauseBuilder neck(PrologTerm term)

Append to the clause builder the first term in the clause body. Return the current builder instance after append the term in the clause body.

Parameters:

term - term to be append in the clause body.

Returns:

the current builder instance after append the term in the clause body.

Since:

1.0

comma

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

Append to the clause builder other term in the clause body 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 in the clause body.

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 in the clause body.

Since:

1.0

comma

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

Append to the clause builder other term in the clause body 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 in the clause body.

Parameters:

functor - string name for the structure term.

arguments - prolog term arguments for the structure term.

Returns:

the current builder instance after append the term in the clause body.

Since:

1.0

comma

PrologClauseBuilder comma(PrologTerm term)

Append to the clause builder other term in the clause body in conjunctive mode. Return the current builder instance after append the term in the clause body.

Parameters:

term - term to be query.

Returns:

the current builder instance after append the term in the clause body.

Since:

1.0

getClauseString

String getClauseString()

Get the clause in string format.

Returns:

string clause.

Since:

1.0

clause

boolean clause()

Check if the clause in the main memory program unify with the current clause and return true. If the clause not exist in main memory program or exist but not unify with the given clause false value is returned.

Returns:

true if the clause in the main memory program unify with the current clause, false otherwise.

Since:

1.0

asserta

void asserta()

Add the current clause in the main memory program if the clause non exist. If the clause exist, will not overwritten and the clause will not added. The added clause will be the first clause for a clause lot with the same predicate indicator (PI).

Since:

1.0

assertz

void assertz()

Add the clause in the main memory program if the clause non exist. If the clause exist, will not overwritten and the clause will not added. The added clause will be the last clause for a clause lot with the same predicate indicator (PI).

Since:

1.0

retract

void retract()

Remove the clause in the main memory program if the clause exist.

Since:

1.0

getEngine

PrologEngine getEngine()

Engine hold by the current builder

Returns:

engine used by the current builder

Since:

1.0