Struct (HyperGraphDB Prolog 1.3-SNAPSHOT API)

java.lang.Object
- alice.tuprolog.Term
- - alice.tuprolog.Struct

All Implemented Interfaces:

Serializable
```
public class Struct
extends Term
```
Struct class represents both compound prolog term and atom term (considered as 0-arity compound).

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static Struct EMPTY_LIST
- Fields inherited from class alice.tuprolog.Term
  FALSE, TRUE

Fields
Modifier and Type	Field and Description
`static Struct`	`EMPTY_LIST`

Constructor Summary

Constructors
Constructor and Description
`Struct()` Builds a structure representing an empty list
`Struct(String f)` Builds a Struct representing an atom
`Struct(String name_, int arity_)`
`Struct(String f, Term at0)` Builds a compound, with one argument
`Struct(String f, Term[] argList)` Builds a compound, with an array of arguments
`Struct(String f, Term at0, Term at1)` Builds a compound, with two arguments
`Struct(String f, Term at0, Term at1, Term at2)` Builds a compound, with three arguments
`Struct(String f, Term at0, Term at1, Term at2, Term at3)` Builds a compound, with four arguments
`Struct(String f, Term at0, Term at1, Term at2, Term at3, Term at4)` Builds a compound, with five arguments
`Struct(String f, Term at0, Term at1, Term at2, Term at3, Term at4, Term at5)` Builds a compound, with six arguments
`Struct(String f, Term at0, Term at1, Term at2, Term at3, Term at4, Term at5, Term at6)` Builds a compound, with seven arguments
`Struct(Term[] argList)` Builds a list specifying the elements
`Struct(Term h, Term t)` Builds a list providing head and tail

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`append(Term t)` Appends an element to this structure supposed to be a list
`Term`	`copy(AbstractMap vMap, AbstractMap substMap)` Gets a copy of this structure
`Term`	`copy(AbstractMap vMap, int idExecCtx)` Gets a copy of this structure
`void`	`free()` dummy method
`Term`	`getArg(int index)` Gets the i-th element of this structure No bound check is done
`Struct`	`getArg(String name)` Gets an argument inside this structure, given its name
`int`	`getArity()` Gets the number of elements of this structure
`String`	`getName()` Gets the functor name of this structure
`String`	`getPredicateIndicator()`
`PrimitiveInfo`	`getPrimitive()` Get primitive behaviour associated at structure
`Term`	`getTerm()` Gets the actual term referred by this Term.
`Term`	`getTerm(int index)` Gets the i-th element of this structure No bound check is done.
`boolean`	`isAtom()` is this term a prolog (alphanumeric) atom?
`boolean`	`isAtomic()` is this term a constant prolog term?
`boolean`	`isClause()` Check is this struct is clause or directive
`boolean`	`isCompound()` is this term a prolog compound term?
`boolean`	`isEmptyList()` Is this structure an empty list?
`boolean`	`isEqual(Prolog mediator, Term t)` Test if a term is equal to other
`boolean`	`isGreater(Prolog mediator, Term t)` Test if a term is greater than other
`boolean`	`isGround()` is this term a ground term?
`boolean`	`isList()` is this term a prolog list?
`boolean`	`isNumber()` is this term a prolog numeric term?
`boolean`	`isPrimitive()` Check if this term is a primitive struct
`boolean`	`isStruct()` is this term a struct
`boolean`	`isVar()` is this term a variable
`Term`	`iteratedGoalTerm()` The iterated-goal term G of a term T is a term defined recursively as follows: if T unifies with ^(_, Goal) then G is the iterated-goal term of Goal else G is T
`Term`	`listHead()` Gets the head of this structure, which is supposed to be a list.
`Iterator`	`listIterator()` Gets an iterator on the elements of this structure, which is supposed to be a list.
`int`	`listSize()` Gets the number of elements of this structure, which is supposed to be a list.
`Struct`	`listTail()` Gets the tail of this structure, which is supposed to be a list.
`long`	`resolveTerm(long count)` resolve term
`String`	`toString()` Gets the string representation of this structure Specific representations are provided for lists and atoms.
`boolean`	`unify(Prolog mediator, List vl1, List vl2, Term t)` Try to unify two terms

Methods inherited from class alice.tuprolog.Term
copyGoal, copyResult, createTerm, createTerm, equals, getIterator, match, parse, parse, resolveTerm, unify

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

- Field Detail
  - EMPTY_LIST
```
public static final Struct EMPTY_LIST
```
- Constructor Detail
  - Struct
```
public Struct(String f)
```
    Builds a Struct representing an atom
  - Struct
```
public Struct(String f,
      Term at0)
```
    Builds a compound, with one argument
  - Struct
```
public Struct(String f,
      Term at0,
      Term at1)
```
    Builds a compound, with two arguments
  - Struct
```
public Struct(String f,
      Term at0,
      Term at1,
      Term at2)
```
    Builds a compound, with three arguments
  - Struct
```
public Struct(String f,
      Term at0,
      Term at1,
      Term at2,
      Term at3)
```
    Builds a compound, with four arguments
  - Struct
```
public Struct(String f,
      Term at0,
      Term at1,
      Term at2,
      Term at3,
      Term at4)
```
    Builds a compound, with five arguments
  - Struct
```
public Struct(String f,
      Term at0,
      Term at1,
      Term at2,
      Term at3,
      Term at4,
      Term at5)
```
    Builds a compound, with six arguments
  - Struct
```
public Struct(String f,
      Term at0,
      Term at1,
      Term at2,
      Term at3,
      Term at4,
      Term at5,
      Term at6)
```
    Builds a compound, with seven arguments
  - Struct
```
public Struct(String f,
      Term[] argList)
```
    Builds a compound, with an array of arguments
  - Struct
```
public Struct()
```
    Builds a structure representing an empty list
  - Struct
```
public Struct(Term h,
      Term t)
```
    Builds a list providing head and tail
  - Struct
```
public Struct(Term[] argList)
```
    Builds a list specifying the elements
  - Struct
```
public Struct(String name_,
      int arity_)
```
- Method Detail
  - getPredicateIndicator
```
public String getPredicateIndicator()
```
  - getArity
```
public int getArity()
```
    Gets the number of elements of this structure
  - getName
```
public String getName()
```
    Gets the functor name of this structure
  - getArg
```
public Term getArg(int index)
```
    Gets the i-th element of this structure No bound check is done
  - getTerm
```
public Term getTerm(int index)
```
    Gets the i-th element of this structure No bound check is done. It is equivalent to getArg(index).getTerm()
  - isNumber
```
public boolean isNumber()
```
    is this term a prolog numeric term?
    
    Specified by:
    
    isNumber in class Term
  - isStruct
```
public boolean isStruct()
```
    is this term a struct
    
    Specified by:
    
    isStruct in class Term
  - isVar
```
public boolean isVar()
```
    is this term a variable
    
    Specified by:
    
    isVar in class Term
  - isAtomic
```
public boolean isAtomic()
```
    Description copied from class: Term
    
    is this term a constant prolog term?
    
    Specified by:
    
    isAtomic in class Term
  - isCompound
```
public boolean isCompound()
```
    Description copied from class: Term
    
    is this term a prolog compound term?
    
    Specified by:
    
    isCompound in class Term
  - isAtom
```
public boolean isAtom()
```
    Description copied from class: Term
    
    is this term a prolog (alphanumeric) atom?
    
    Specified by:
    
    isAtom in class Term
  - isList
```
public boolean isList()
```
    Description copied from class: Term
    
    is this term a prolog list?
    
    Specified by:
    
    isList in class Term
  - isGround
```
public boolean isGround()
```
    Description copied from class: Term
    
    is this term a ground term?
    
    Specified by:
    
    isGround in class Term
  - isClause
```
public boolean isClause()
```
    Check is this struct is clause or directive
  - getTerm
```
public Term getTerm()
```
    Description copied from class: Term
    
    Gets the actual term referred by this Term. if the Term is a bound variable, the method gets the Term linked to the variable
    
    Specified by:
    
    getTerm in class Term
  - getArg
```
public Struct getArg(String name)
```
    Gets an argument inside this structure, given its name
    
    Parameters:
    name - name of the structure
    
    Returns:
    the argument or null if not found
  - isGreater
```
public boolean isGreater(Prolog mediator,
                Term t)
```
    Test if a term is greater than other
    
    Specified by:
    
    isGreater in class Term
    
    Parameters:
    mediator - TODO
  - isEqual
```
public boolean isEqual(Prolog mediator,
              Term t)
```
    Test if a term is equal to other
    
    Specified by:
    
    isEqual in class Term
    
    Parameters:
    mediator - TODO
  - copy
```
public Term copy(AbstractMap vMap,
        int idExecCtx)
```
    Gets a copy of this structure
    
    Specified by:
    
    copy in class Term
    
    Parameters:
    vMap - is needed for register occurence of same variables
    idExecCtx - Execution Context identifier
  - copy
```
public Term copy(AbstractMap vMap,
        AbstractMap substMap)
```
    Gets a copy of this structure
    
    Specified by:
    
    copy in class Term
    
    Parameters:
    vMap - is needed for register occurence of same variables
  - resolveTerm
```
public long resolveTerm(long count)
```
    resolve term
    
    Specified by:
    
    resolveTerm in class Term
    
    Parameters:
    count - new starting time count for resolving process
    
    Returns:
    the new time count, after resolving process
  - isEmptyList
```
public boolean isEmptyList()
```
    Is this structure an empty list?
    
    Specified by:
    
    isEmptyList in class Term
  - listHead
```
public Term listHead()
```
    Gets the head of this structure, which is supposed to be a list.
    Gets the head of this structure, which is supposed to be a list. If the callee structure is not a list, throws an UnsupportedOperationException
  - listTail
```
public Struct listTail()
```
    Gets the tail of this structure, which is supposed to be a list.
    Gets the tail of this structure, which is supposed to be a list. If the callee structure is not a list, throws an UnsupportedOperationException
  - listSize
```
public int listSize()
```
    Gets the number of elements of this structure, which is supposed to be a list.
    Gets the number of elements of this structure, which is supposed to be a list. If the callee structure is not a list, throws an UnsupportedOperationException
  - listIterator
```
public Iterator listIterator()
```
    Gets an iterator on the elements of this structure, which is supposed to be a list.
    Gets an iterator on the elements of this structure, which is supposed to be a list. If the callee structure is not a list, throws an UnsupportedOperationException
  - append
```
public void append(Term t)
```
    Appends an element to this structure supposed to be a list
  - unify
```
public boolean unify(Prolog mediator,
            List vl1,
            List vl2,
            Term t)
```
    Try to unify two terms
    
    Specified by:
    
    unify in class Term
    
    Parameters:
    t - the term to unify
    vl1 - list of variables unified
    vl2 - list of variables unified
    mediator - TODO
    
    Returns:
    true if the term is unifiable with this one
  - free
```
public void free()
```
    dummy method
    
    Specified by:
    
    free in class Term
  - getPrimitive
```
public PrimitiveInfo getPrimitive()
```
    Get primitive behaviour associated at structure
  - isPrimitive
```
public boolean isPrimitive()
```
    Check if this term is a primitive struct
  - toString
```
public String toString()
```
    Gets the string representation of this structure Specific representations are provided for lists and atoms. Names starting with upper case letter are enclosed in apices.
    
    Overrides:
    
    toString in class Object
  - iteratedGoalTerm
```
public Term iteratedGoalTerm()
```
    Description copied from class: Term
    The iterated-goal term G of a term T is a term defined recursively as follows:
    - if T unifies with ^(_, Goal) then G is the iterated-goal term of Goal
    - else G is T
    Overrides:
    
    iteratedGoalTerm in class Term

Class Struct

Field Summary

Fields inherited from class alice.tuprolog.Term

Constructor Summary

Method Summary

Methods inherited from class alice.tuprolog.Term

Methods inherited from class java.lang.Object

Field Detail

EMPTY_LIST

Constructor Detail

Struct

Struct

Struct

Struct

Struct

Struct

Struct

Struct

Struct

Struct

Struct

Struct

Struct

Method Detail

getPredicateIndicator

getArity

getName

getArg

getTerm

isNumber

isStruct

isVar

isAtomic

isCompound

isAtom

isList

isGround

isClause

getTerm

getArg

isGreater

isEqual

copy

copy

resolveTerm

isEmptyList

listHead

listTail

listSize

listIterator

append

unify

free

getPrimitive

isPrimitive

toString

iteratedGoalTerm