Inspect

java.lang.Object
- org.projog.core.predicate.AbstractPredicateFactory
- - org.projog.core.predicate.builtin.kb.Inspect

All Implemented Interfaces:

KnowledgeBaseConsumer, PredicateFactory
```
public final class Inspect
extends AbstractPredicateFactory
```
clause(X,Y) / retract(X) - matches terms to existing clauses.
clause(X,Y) causes X and Y to be matched to the head and body of an existing clause. If no clauses are found for the predicate represented by X then the goal fails. If there are more than one that matches, the clauses will be matched one at a time as the goal is re-satisfied. X must be suitably instantiated that the predicate of the clause can be determined.

retract(X) - remove clauses from the knowledge base. The first clause that X matches is removed from the knowledge base. When an attempt is made to re-satisfy the goal, the next clause that X matches is removed. X must be suitably instantiated that the predicate of the clause can be determined.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

private class Inspect.InspectPredicate

Field Summary

Fields
Modifier and Type	Field	Description
`private boolean`	`doRemoveMatches`	`true` if matching rules should be removed (retracted) from the knowledge base as part of calls to `#evaluate(Term, Term)` or `false` if the knowledge base should remain unaltered.

Constructor Summary

Constructors
Modifier Constructor Description

private Inspect(boolean doRemoveMatches)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Predicate`	`getPredicate(Term clauseHead)`
`protected Predicate`	`getPredicate(Term clauseHead, Term clauseBody)`
`static Inspect`	`inspectClause()`
`static Inspect`	`retract()`

Methods inherited from class org.projog.core.predicate.AbstractPredicateFactory
getArithmeticOperators, getFileHandles, getKnowledgeBase, getOperands, getPredicate, getPredicate, getPredicate, getPredicate, getPredicates, getProjogListeners, getSpyPoints, getTermFormatter, init, isRetryable, setKnowledgeBase

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.projog.core.predicate.PredicateFactory
isAlwaysCutOnBacktrack

- Field Detail
  - doRemoveMatches
```
private final boolean doRemoveMatches
```
    true if matching rules should be removed (retracted) from the knowledge base as part of calls to #evaluate(Term, Term) or false if the knowledge base should remain unaltered.
- Constructor Detail
  - Inspect
```
private Inspect(boolean doRemoveMatches)
```
- Method Detail
  - inspectClause
```
public static Inspect inspectClause()
```
  - retract
```
public static Inspect retract()
```
  - getPredicate
```
protected Predicate getPredicate(Term clauseHead)
```
    Overrides:
    
    getPredicate in class AbstractPredicateFactory
  - getPredicate
```
protected Predicate getPredicate(Term clauseHead,
                                 Term clauseBody)
```
    Overrides:
    
    getPredicate in class AbstractPredicateFactory