AbstractTerm (prolobjectlink-jpi 1.2-SNAPSHOT API)

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

All Implemented Interfaces:

PrologElement, PrologTerm, Comparable<PrologTerm>

Direct Known Subclasses:

AbstractCompounds
```
public abstract class AbstractTerm
extends Object
implements PrologTerm
```
Partial implementation of PrologTerm interface.

Since:

1.0

Author:

Jose Zalacain

Field Summary

Fields
Modifier and Type Field and Description

protected PrologProvider provider

protected int type

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractTerm(int type, PrologProvider provider)

Constructors
Modifier	Constructor and Description
`protected`	`AbstractTerm(int type, PrologProvider provider)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends PrologTerm> T`	`cast()` Casts the current PrologTerm to the class or interface represented by this `Class` object.
`protected <T extends PrologTerm> T`	`cast(PrologTerm term)` Casts a PrologTerm to the class or interface represented by this `Class` object.
`protected <T extends PrologTerm> T`	`cast(PrologTerm term, Class<T> type)` Casts a PrologTerm to the class or interface represented by this `Class` object.
`protected void`	`checkIndex(int index)`
`protected void`	`checkIndex(int index, int max)`
`protected <K> K`	`fromTerm(PrologTerm term, Class<K> to)`
`protected <K> K[]`	`fromTermArray(PrologTerm[] terms, Class<K[]> to)`
`PrologTerm`	`getArgument(int index)` Term located at some given index position in the current term arguments if current term is a compound term.
`String`	`getIndicator()` Gets the term indicator represented by one string with the format functor/arity.
`protected PrologLogger`	`getLogger()`
`Object`	`getObject()` For references terms return the referenced object.
`PrologProvider`	`getProvider()` Prolog provider associated to the current term.
`PrologTerm`	`getTerm()` Return current term instance if current term is not a variable or is a free variable term.
`int`	`getType()` Get the term type.
`boolean`	`hasIndicator(String functor, int arity)` True if term has an indicator with the format functor/arity that match with the given functor and arity.
`boolean`	`isClass()` True if this Term is a Class, false in other case
`boolean`	`isClause()` True if this element is a clause
`boolean`	`isEntry()` True if this Term is a Entry, false in other case
`boolean`	`isField()` True if this Term is a Field, false in other case
`boolean`	`isMap()` True if this Term is a Map, false in other case
`boolean`	`isMixin()` True if this Term is a Mixin, false in other case
`boolean`	`isParameter()` True if this Term is a Parameter, false in other case
`boolean`	`isResult()` True if this Term is a Result, false in other case
`boolean`	`isTerm()` True if this term is a term
`boolean`	`isVariableBound()` True if this Term is a instanced variable, false in other case
`boolean`	`isVariableNotBound()` True if this Term is a not instanced variable, false in other case
`Map<String,PrologTerm>`	`match(PrologTerm term)` Match to other term returning list of substitutions.
`protected String`	`removeQuoted(String functor)`
`protected <K extends PrologTerm> K`	`toTerm(Object o, Class<K> from)`
`protected <K extends PrologTerm> K[]`	`toTermArray(Object[] os, Class<K[]> from)`

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

Methods inherited from interface io.github.prolobjectlink.prolog.PrologTerm
getArguments, getArity, getFunctor, isAtom, isAtomic, isCompound, isDouble, isEmptyList, isEvaluable, isFalseType, isFloat, isInteger, isList, isLong, isNil, isNullType, isNumber, isObjectType, isReference, isStructure, isTrueType, isVariable, isVoidType, unify

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - type
```
protected int type
```
  - provider
```
protected final PrologProvider provider
```
- Constructor Detail
  - AbstractTerm
```
protected AbstractTerm(int type,
                       PrologProvider provider)
```
- Method Detail
  - checkIndex
```
protected final void checkIndex(int index)
```
  - checkIndex
```
protected final void checkIndex(int index,
                                int max)
```
  - removeQuoted
```
protected final String removeQuoted(String functor)
```
  - toTerm
```
protected final <K extends PrologTerm> K toTerm(Object o,
                                                Class<K> from)
```
  - toTermArray
```
protected final <K extends PrologTerm> K[] toTermArray(Object[] os,
                                                       Class<K[]> from)
```
  - fromTerm
```
protected final <K> K fromTerm(PrologTerm term,
                               Class<K> to)
```
  - fromTermArray
```
protected final <K> K[] fromTermArray(PrologTerm[] terms,
                                      Class<K[]> to)
```
  - getLogger
```
protected final PrologLogger getLogger()
```
  - getArgument
```
public PrologTerm getArgument(int index)
```
    Description copied from interface: PrologTerm
    
    Term located at some given index position in the current term arguments if current term is a compound term. If the current term is not compound term an ArrayIndexOutOfBoundsException exception is raised.
    
    Specified by:
    
    getArgument in interface PrologTerm
    
    Parameters:
    
    index - position to retrieve the correspondent term.
    
    Returns:
    
    Term located at some given index position.
  - getIndicator
```
public final String getIndicator()
```
    Description copied from interface: PrologTerm
    
    Gets the term indicator represented by one string with the format functor/arity. More formally the indicator string is formed by the concatenation of PrologTerm.getFunctor() and PrologTerm.getArity() separated by slash.
    
    Specified by:
    
    getIndicator in interface PrologTerm
    
    Returns:
    
    term indicator
  - hasIndicator
```
public final boolean hasIndicator(String functor,
                                  int arity)
```
    Description copied from interface: PrologTerm
    
    True if term has an indicator with the format functor/arity that match with the given functor and arity.
    
    Specified by:
    
    hasIndicator in interface PrologTerm
    
    Parameters:
    
    functor - term functor
    
    arity - term arity
    
    Returns:
    
    True if term has an indicator functor/arity.
  - getTerm
```
public PrologTerm getTerm()
```
    Description copied from interface: PrologTerm
    
    Return current term instance if current term is not a variable or is a free variable term. If current term is a variable bound term then return the linked term hold by this variable after dereferencing.
    
    Specified by:
    
    getTerm in interface PrologTerm
    
    Returns:
    
    return a dereferencing term if current term is bound variable, current term in otherwise
  - getType
```
public final int getType()
```
    Description copied from interface: PrologTerm
    
    Get the term type.
    
    Specified by:
    
    getType in interface PrologTerm
    
    Returns:
    
    term type.
  - getProvider
```
public final PrologProvider getProvider()
```
    Description copied from interface: PrologTerm
    
    Prolog provider associated to the current term.
    
    Specified by:
    
    getProvider in interface PrologTerm
    
    Returns:
    
    Prolog provider associated to the current term.
  - cast
```
protected final <T extends PrologTerm> T cast(PrologTerm term,
                                              Class<T> type)
```
    Casts a PrologTerm to the class or interface represented by this Class object.
    
    Parameters:
    
    term - the object to be cast
    
    type - the class or interface to be casted
    
    Returns:
    
    the PrologTerm after casting, or null if term is null
    
    Throws:
    
    ClassCastException - if the object is not null and is not assignable to the type T.
    
    Since:
    
    1.1
  - cast
```
protected final <T extends PrologTerm> T cast(PrologTerm term)
```
    Casts a PrologTerm to the class or interface represented by this Class object.
    
    Parameters:
    
    term - the object to be cast
    
    Returns:
    
    the PrologTerm after casting, or null if term is null
    
    Throws:
    
    ClassCastException - if the object is not null and is not assignable to the type T.
    
    Since:
    
    1.1
  - cast
```
public final <T extends PrologTerm> T cast()
```
    Description copied from interface: PrologTerm
    
    Casts the current PrologTerm to the class or interface represented by this Class object.
    
    Specified by:
    
    cast in interface PrologTerm
    
    Returns:
    
    the PrologTerm after casting, or null if term is null
  - getObject
```
public Object getObject()
```
    Description copied from interface: PrologTerm
    
    For references terms return the referenced object.
    
    Specified by:
    
    getObject in interface PrologTerm
    
    Returns:
    
    the referenced object if the current term is a reference prolog term
  - isEntry
```
public final boolean isEntry()
```
    Description copied from interface: PrologTerm
    
    True if this Term is a Entry, false in other case
    
    Specified by:
    
    isEntry in interface PrologTerm
    
    Returns:
    
    whether this Term is a entry
  - isMap
```
public final boolean isMap()
```
    Description copied from interface: PrologTerm
    
    True if this Term is a Map, false in other case
    
    Specified by:
    
    isMap in interface PrologTerm
    
    Returns:
    
    whether this Term is a map
  - isField
```
public boolean isField()
```
    Description copied from interface: PrologTerm
    
    True if this Term is a Field, false in other case
    
    Specified by:
    
    isField in interface PrologTerm
    
    Returns:
    
    whether this Term is a field
  - isResult
```
public boolean isResult()
```
    Description copied from interface: PrologTerm
    
    True if this Term is a Result, false in other case
    
    Specified by:
    
    isResult in interface PrologTerm
    
    Returns:
    
    whether this Term is a result
  - isParameter
```
public boolean isParameter()
```
    Description copied from interface: PrologTerm
    
    True if this Term is a Parameter, false in other case
    
    Specified by:
    
    isParameter in interface PrologTerm
    
    Returns:
    
    whether this Term is a parameter
  - isMixin
```
public final boolean isMixin()
```
    Description copied from interface: PrologTerm
    
    True if this Term is a Mixin, false in other case
    
    Specified by:
    
    isMixin in interface PrologTerm
    
    Returns:
    
    whether this Term is a mixin
  - isClass
```
public final boolean isClass()
```
    Description copied from interface: PrologTerm
    
    True if this Term is a Class, false in other case
    
    Specified by:
    
    isClass in interface PrologTerm
    
    Returns:
    
    whether this Term is a class
  - isVariableBound
```
public boolean isVariableBound()
```
    Description copied from interface: PrologTerm
    
    True if this Term is a instanced variable, false in other case
    
    Specified by:
    
    isVariableBound in interface PrologTerm
    
    Returns:
    
    whether this Term is a instanced variable
  - isVariableNotBound
```
public boolean isVariableNotBound()
```
    Description copied from interface: PrologTerm
    
    True if this Term is a not instanced variable, false in other case
    
    Specified by:
    
    isVariableNotBound in interface PrologTerm
    
    Returns:
    
    whether this Term is a not instanced variable
  - 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
  - match
```
public final Map<String,PrologTerm> match(PrologTerm term)
```
    Match to other term returning list of substitutions.
    
    Specified by:
    
    match in interface PrologTerm
    
    Parameters:
    
    term - - term to match check
    
    Returns:
    
    list of substitutions.

Class AbstractTerm

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.prolobjectlink.prolog.PrologTerm

Methods inherited from interface java.lang.Comparable

Field Detail

type

provider

Constructor Detail

AbstractTerm

Method Detail

checkIndex

checkIndex

removeQuoted

toTerm

toTermArray

fromTerm

fromTermArray

getLogger

getArgument

getIndicator

hasIndicator

getTerm

getType

getProvider

cast

cast

cast

getObject

isEntry

isMap

isField

isResult

isParameter

isMixin

isClass

isVariableBound

isVariableNotBound

isClause

isTerm

match