AbstractClause (prolobjectlink-jpi 1.2-SNAPSHOT API)

java.lang.Object
- io.github.prolobjectlink.prolog.AbstractClause

All Implemented Interfaces:

PrologClause, PrologDocumentable, PrologElement
```
public abstract class AbstractClause
extends Object
implements PrologClause
```
Partial implementation of PrologClause interface.

Since:

1.0

Author:

Jose Zalacain

Field Summary

Fields
Modifier and Type Field and Description

protected PrologProvider provider

Fields
Modifier and Type	Field and Description
`protected PrologProvider`	`provider`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractClause(PrologProvider provider, PrologTerm head, boolean dynamic, boolean multifile, boolean discontiguous)` Create a new fact clause.
`protected`	`AbstractClause(PrologProvider provider, PrologTerm head, PrologTerm body, boolean dynamic, boolean multifile, boolean discontiguous)` Create a new rule clause.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends PrologClause> T`	`cast()` Casts the current PrologClause to the class or interface represented by this `Class` object.
`boolean`	`equals(Object obj)`
`PrologTerm`	`getArgument(int index)` Term located at some given index position in the clause head arguments.
`PrologTerm[]`	`getArguments()` Term arguments present in the clause head.
`int`	`getArity()` Integer number that represent the arguments number in the clause head.
`String`	`getAuthor()` Get the author tag in doc comment
`PrologTerm`	`getBody()` Prolog term that represent the clause body.
`PrologTerm[]`	`getBodyArray()` Get the clause body as terms array.
`Iterator<PrologTerm>`	`getBodyIterator()` Iterator to iterate over all body terms.
`String`	`getDescription()` Get the description tag in doc comment
`String`	`getFunctor()` String that represent the functor in the clause head.
`PrologTerm`	`getHead()` Prolog term that represent the clause head.
`String`	`getIndicator()` Clause family functor/arity based indicator.
`PrologIndicator`	`getPrologIndicator()` Clause family PrologIndicator based indicator.
`String`	`getSee()` Get the see tag in doc comment
`String`	`getSince()` Get the since tag in doc comment
`PrologTerm`	`getTerm()` Prolog term representation of the current clause.
`String`	`getVersion()` Get the version tag in doc comment
`boolean`	`hasAuthor()` Check if exist author tag in doc comment
`boolean`	`hasDescription()` Check if exist description tag in doc comment
`boolean`	`hasDocumentation()` Check if exist at least one tag like documentation comment
`int`	`hashCode()`
`boolean`	`hasIndicator(String functor, int arity)` Check if the current clause have functor/arity based indicator specified by arguments, false in otherwise.
`boolean`	`hasSee()` Check if exist see tag in doc comment
`boolean`	`hasSince()` Check if exist since tag in doc comment
`boolean`	`hasVersion()` Check if exist version tag in doc comment
`boolean`	`isClause()` True if this element is a clause
`boolean`	`isDirective()` True if this clause is a directive, false in other case.
`boolean`	`isDiscontiguous()` True if this clause is a discontiguos, false in other case
`boolean`	`isDynamic()` True if this clause is a dynamic, false in other case
`boolean`	`isFact()` True if this clause is a fact, false in other case.
`boolean`	`isFunction()` True if this clause is a function, false in other case.
`boolean`	`isMethod()` True if this clause is a rule, false in other case.
`boolean`	`isMultifile()` True if this clause is a multifile, false in other case
`boolean`	`isRule()` True if this clause is a rule, false in other case.
`boolean`	`isTerm()` True if this term is a term
`void`	`setAuthor(String author)` Set the author tag in doc comment
`void`	`setDescription(String description)` Set the description tag in doc comment
`void`	`setSee(String see)` Set the see tag in doc comment
`void`	`setSince(String since)` Set the since tag in doc comment
`void`	`setVersion(String version)` Set the version tag in doc comment
`String`	`toString()`
`boolean`	`unify(PrologClause clause)` Check that two clauses unify.

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

- Field Detail
  - provider
```
protected final PrologProvider provider
```
- Constructor Detail
  - AbstractClause
```
protected AbstractClause(PrologProvider provider,
                         PrologTerm head,
                         boolean dynamic,
                         boolean multifile,
                         boolean discontiguous)
```
    Create a new fact clause. A fatc clause is only represented by clause head and no have clause body. The body for this clause type is null. The other parameters are boolean clause properties. If a clause have any of this properties specify with true value.
    
    Parameters:
    
    provider - prolog provider
    
    head - clause head
    
    dynamic - true if clause is dynamic, false otherwise
    
    multifile - true if clause is multifile, false otherwise
    
    discontiguous - true if clause is discontiguous, false otherwise
    
    Since:
    
    1.0
  - AbstractClause
```
protected AbstractClause(PrologProvider provider,
                         PrologTerm head,
                         PrologTerm body,
                         boolean dynamic,
                         boolean multifile,
                         boolean discontiguous)
```
    Create a new rule clause. A rule clause is represented by clause head and body. The other parameters are boolean clause properties. If a clause have any of this properties specify with true value.
    
    Parameters:
    
    provider - prolog provider
    
    head - clause head
    
    body - clause body
    
    dynamic - true if clause is dynamic, false otherwise
    
    multifile - true if clause is multifile, false otherwise
    
    discontiguous - true if clause is discontiguous, false otherwise
    
    Since:
    
    1.0
- Method Detail
  - getTerm
```
public PrologTerm getTerm()
```
    Description copied from interface: PrologClause
    
    Prolog term representation of the current clause. This prolog term is a structure with functor/arity (:-/2) and the arguments head and body.
    
    Specified by:
    
    getTerm in interface PrologClause
    
    Returns:
    
    term representation of the current clause.
  - getHead
```
public final PrologTerm getHead()
```
    Description copied from interface: PrologClause
    
    Prolog term that represent the clause head.
    
    Specified by:
    
    getHead in interface PrologClause
    
    Returns:
    
    the clause head.
  - getBody
```
public final PrologTerm getBody()
```
    Description copied from interface: PrologClause
    
    Prolog term that represent the clause body. If the clause body representation it's not the term itself, the prolog term should be created and returned.
    
    Specified by:
    
    getBody in interface PrologClause
    
    Returns:
    
    the clause body.
  - getBodyArray
```
public final PrologTerm[] getBodyArray()
```
    Description copied from interface: PrologClause
    
    Get the clause body as terms array.
    
    Specified by:
    
    getBodyArray in interface PrologClause
    
    Returns:
    
    clause terms body array.
  - getBodyIterator
```
public final Iterator<PrologTerm> getBodyIterator()
```
    Description copied from interface: PrologClause
    
    Iterator to iterate over all body terms.
    
    Specified by:
    
    getBodyIterator in interface PrologClause
    
    Returns:
    
    Iterator to iterate over all body terms.
  - getFunctor
```
public final String getFunctor()
```
    Description copied from interface: PrologClause
    
    String that represent the functor in the clause head. The functor for this clause can be implemented like getHead().getFunctor().
    
    Specified by:
    
    getFunctor in interface PrologClause
    
    Returns:
    
    the functor in the clause head
  - getArity
```
public final int getArity()
```
    Description copied from interface: PrologClause
    
    Integer number that represent the arguments number in the clause head. The arity for this clause can be implemented like getHead().getArity().
    
    Specified by:
    
    getArity in interface PrologClause
    
    Returns:
    
    the arguments number in the clause head.
  - getArguments
```
public PrologTerm[] getArguments()
```
    Description copied from interface: PrologClause
    
    Term arguments present in the clause head.
    
    Specified by:
    
    getArguments in interface PrologClause
    
    Returns:
    
    Term arguments present in the clause head.
  - getArgument
```
public PrologTerm getArgument(int index)
```
    Description copied from interface: PrologClause
    
    Term located at some given index position in the clause head arguments.
    
    Specified by:
    
    getArgument in interface PrologClause
    
    Parameters:
    
    index - position to retrieve the correspondent term.
    
    Returns:
    
    Term located at some given index position.
  - hasIndicator
```
public final boolean hasIndicator(String functor,
                                  int arity)
```
    Description copied from interface: PrologClause
    
    Check if the current clause have functor/arity based indicator specified by arguments, false in otherwise.
    
    Specified by:
    
    hasIndicator in interface PrologClause
    
    Parameters:
    
    functor - clause functor to be checked
    
    arity - clause arity to be checked
    
    Returns:
    
    true if the current clause have functor/arity based indicator specified by arguments, false in otherwise.
  - getIndicator
```
public final String getIndicator()
```
    Description copied from interface: PrologClause
    
    Clause family functor/arity based indicator. The clause family indicator is the same indicator for all clauses head in the clause family.
    
    Specified by:
    
    getIndicator in interface PrologClause
    
    Returns:
    
    functor/arity based indicator of the current clause family.
  - isDirective
```
public final boolean isDirective()
```
    Description copied from interface: PrologClause
    
    True if this clause is a directive, false in other case. The implementation for this method can be getHead()==null && getBody()!=null.
    
    Specified by:
    
    isDirective in interface PrologClause
    
    Returns:
    
    whether this clause is a directive.
  - isFact
```
public final boolean isFact()
```
    Description copied from interface: PrologClause
    
    True if this clause is a fact, false in other case. The implementation for this method can be getHead()!=null && getBody()==null.
    
    Specified by:
    
    isFact in interface PrologClause
    
    Returns:
    
    whether this clause is a fact.
  - isRule
```
public final boolean isRule()
```
    Description copied from interface: PrologClause
    
    True if this clause is a rule, false in other case. The implementation for this method can be getHead()!=null && getBody()!=null.
    
    Specified by:
    
    isRule in interface PrologClause
    
    Returns:
    
    whether this clause is a rule.
  - isMethod
```
public boolean isMethod()
```
    Description copied from interface: PrologClause
    
    True if this clause is a rule, false in other case. The implementation for this method can be getHead()!=null && getBody()!=null.
    
    Specified by:
    
    isMethod in interface PrologClause
    
    Returns:
    
    whether this clause is a rule.
  - isFunction
```
public boolean isFunction()
```
    Description copied from interface: PrologClause
    
    True if this clause is a function, false in other case. The implementation for this method can be getHead()!=null && getBody()!=null.
    
    Specified by:
    
    isFunction in interface PrologClause
    
    Returns:
    
    whether this clause is a rule.
  - isClause
```
public final boolean isClause()
```
    Description copied from interface: PrologElement
    
    True if this element is a clause
    
    Specified by:
    
    isClause in interface PrologElement
    
    Returns:
    
    whether this element represents a clause, false in other case
  - isTerm
```
public final boolean isTerm()
```
    Description copied from interface: PrologElement
    
    True if this term is a term
    
    Specified by:
    
    isTerm in interface PrologElement
    
    Returns:
    
    whether this element represents a term, false in other case
  - unify
```
public final boolean unify(PrologClause clause)
```
    Description copied from interface: PrologClause
    
    Check that two clauses unify. Prolog clauses unify if and only if the head and the body for both clauses unify.
    
    Specified by:
    
    unify in interface PrologClause
    
    Parameters:
    
    clause - the clause to unify with the current clause
    
    Returns:
    
    true if the given clause unify whit the current clause, false otherwise
  - isDynamic
```
public final boolean isDynamic()
```
    Description copied from interface: PrologClause
    
    True if this clause is a dynamic, false in other case
    
    Specified by:
    
    isDynamic in interface PrologClause
    
    Returns:
    
    whether this clause is a dynamic
  - isMultifile
```
public final boolean isMultifile()
```
    Description copied from interface: PrologClause
    
    True if this clause is a multifile, false in other case
    
    Specified by:
    
    isMultifile in interface PrologClause
    
    Returns:
    
    whether this clause is a multifile
  - isDiscontiguous
```
public final boolean isDiscontiguous()
```
    Description copied from interface: PrologClause
    
    True if this clause is a discontiguos, false in other case
    
    Specified by:
    
    isDiscontiguous in interface PrologClause
    
    Returns:
    
    whether this clause is a discontiguos.
  - getPrologIndicator
```
public PrologIndicator getPrologIndicator()
```
    Description copied from interface: PrologClause
    
    Clause family PrologIndicator based indicator. The clause family indicator is the same indicator for all clauses head in the clause family.
    
    Specified by:
    
    getPrologIndicator in interface PrologClause
    
    Returns:
    
    PrologIndicator based indicator of the current clause family.
  - cast
```
public final <T extends PrologClause> T cast()
```
    Description copied from interface: PrologClause
    
    Casts the current PrologClause to the class or interface represented by this Class object.
    
    Specified by:
    
    cast in interface PrologClause
    
    Returns:
    
    the PrologTerm after casting, or null if term is null
  - getSee
```
public final String getSee()
```
    Description copied from interface: PrologDocumentable
    
    Get the see tag in doc comment
    
    Specified by:
    
    getSee in interface PrologDocumentable
  - setSee
```
public final void setSee(String see)
```
    Description copied from interface: PrologDocumentable
    
    Set the see tag in doc comment
    
    Specified by:
    
    setSee in interface PrologDocumentable
    
    Parameters:
    
    see - see for this doc object
  - getSince
```
public final String getSince()
```
    Description copied from interface: PrologDocumentable
    
    Get the since tag in doc comment
    
    Specified by:
    
    getSince in interface PrologDocumentable
  - setSince
```
public final void setSince(String since)
```
    Description copied from interface: PrologDocumentable
    
    Set the since tag in doc comment
    
    Specified by:
    
    setSince in interface PrologDocumentable
    
    Parameters:
    
    since - since for this doc object
  - getAuthor
```
public final String getAuthor()
```
    Description copied from interface: PrologDocumentable
    
    Get the author tag in doc comment
    
    Specified by:
    
    getAuthor in interface PrologDocumentable
  - setAuthor
```
public final void setAuthor(String author)
```
    Description copied from interface: PrologDocumentable
    
    Set the author tag in doc comment
    
    Specified by:
    
    setAuthor in interface PrologDocumentable
    
    Parameters:
    
    author - author for this doc object
  - getVersion
```
public final String getVersion()
```
    Description copied from interface: PrologDocumentable
    
    Get the version tag in doc comment
    
    Specified by:
    
    getVersion in interface PrologDocumentable
  - setVersion
```
public final void setVersion(String version)
```
    Description copied from interface: PrologDocumentable
    
    Set the version tag in doc comment
    
    Specified by:
    
    setVersion in interface PrologDocumentable
    
    Parameters:
    
    version - version for this doc object
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: PrologDocumentable
    
    Get the description tag in doc comment
    
    Specified by:
    
    getDescription in interface PrologDocumentable
  - setDescription
```
public final void setDescription(String description)
```
    Description copied from interface: PrologDocumentable
    
    Set the description tag in doc comment
    
    Specified by:
    
    setDescription in interface PrologDocumentable
    
    Parameters:
    
    description - description for this doc object
  - hasDescription
```
public final boolean hasDescription()
```
    Description copied from interface: PrologDocumentable
    
    Check if exist description tag in doc comment
    
    Specified by:
    
    hasDescription in interface PrologDocumentable
  - hasVersion
```
public final boolean hasVersion()
```
    Description copied from interface: PrologDocumentable
    
    Check if exist version tag in doc comment
    
    Specified by:
    
    hasVersion in interface PrologDocumentable
  - hasAuthor
```
public final boolean hasAuthor()
```
    Description copied from interface: PrologDocumentable
    
    Check if exist author tag in doc comment
    
    Specified by:
    
    hasAuthor in interface PrologDocumentable
  - hasSince
```
public final boolean hasSince()
```
    Description copied from interface: PrologDocumentable
    
    Check if exist since tag in doc comment
    
    Specified by:
    
    hasSince in interface PrologDocumentable
  - hasSee
```
public final boolean hasSee()
```
    Description copied from interface: PrologDocumentable
    
    Check if exist see tag in doc comment
    
    Specified by:
    
    hasSee in interface PrologDocumentable
  - hasDocumentation
```
public final boolean hasDocumentation()
```
    Description copied from interface: PrologDocumentable
    
    Check if exist at least one tag like documentation comment
    
    Specified by:
    
    hasDocumentation in interface PrologDocumentable
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AbstractClause

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

provider

Constructor Detail

AbstractClause

AbstractClause

Method Detail

getTerm

getHead

getBody

getBodyArray

getBodyIterator

getFunctor

getArity

getArguments

getArgument

hasIndicator

getIndicator

isDirective

isFact

isRule

isMethod

isFunction

isClause

isTerm

unify

isDynamic

isMultifile

isDiscontiguous

getPrologIndicator

cast

getSee

setSee

getSince

setSince

getAuthor

setAuthor

getVersion

setVersion

getDescription

setDescription

hasDescription

hasVersion

hasAuthor

hasSince

hasSee

hasDocumentation

hashCode

equals

toString