tom.engine.adt.il.types.derivtree
Class derivrule

java.lang.Object
  extended by tom.engine.adt.il.IlAbstractType
      extended by tom.engine.adt.il.types.DerivTree
          extended by tom.engine.adt.il.types.derivtree.derivrule
All Implemented Interfaces:
Comparable, shared.SharedObject, shared.SharedObjectWithID, Visitable

public final class derivrule
extends DerivTree
implements Visitable


Field Summary
 
Fields inherited from class tom.engine.adt.il.types.DerivTree
idConv
 
Fields inherited from class tom.engine.adt.il.IlAbstractType
atermFactory, factory
 
Method Summary
 int compareTo(Object o)
          Compares two terms.
 int compareToLPO(Object o)
          Compares two terms.
 shared.SharedObject duplicate()
          Copy the object and returns the copy
 boolean equivalent(shared.SharedObject obj)
          Checks if a SharedObject is equivalent to the current object
static DerivTree fromTerm(aterm.ATerm trm, ATermConverter atConv)
          Apply a conversion on the ATerm contained in the String and returns a tom.engine.adt.il.types.DerivTree from it
 Visitable getChildAt(int index)
          Returns the child at the specified index
 int getChildCount()
          Returns the number of childs of the term
 Visitable[] getChildren()
          Returns the whole children of the term
 Seq getCond()
          Returns the attribute tom.engine.adt.il.types.Seq
 String getName()
          Returns the attribute String
 Deriv getPost()
          Returns the attribute tom.engine.adt.il.types.Deriv
 DerivTree getPre()
          Returns the attribute tom.engine.adt.il.types.DerivTree
 int hashCode()
          Returns hashCode
protected  int hashFunction()
          Compute a hashcode for this term.
 boolean isderivrule()
          Returns true if the term is rooted by the symbol derivrule
static derivrule make(String _Name, Deriv _Post, DerivTree _Pre, Seq _Cond)
          Constructor that builds a term rooted by derivrule
 Visitable setChildAt(int index, Visitable v)
          Set the child at the specified index
 Visitable setChildren(Visitable[] childs)
          Set children to the term
 DerivTree setCond(Seq set_arg)
          Sets and returns the attribute tom.engine.adt.il.types.DerivTree
 DerivTree setName(String set_arg)
          Sets and returns the attribute tom.engine.adt.il.types.DerivTree
 DerivTree setPost(Deriv set_arg)
          Sets and returns the attribute tom.engine.adt.il.types.DerivTree
 DerivTree setPre(DerivTree set_arg)
          Sets and returns the attribute tom.engine.adt.il.types.DerivTree
 String symbolName()
          Returns the name of the symbol
 aterm.ATerm toATerm()
          Returns an ATerm representation of this term.
 void toStringBuilder(StringBuilder buffer)
          Appends a string representation of this term to the buffer given as argument.
 
Methods inherited from class tom.engine.adt.il.types.DerivTree
fromStream, fromStream, fromString, fromString, fromTerm, getPre2, isderivrule2, isendderiv, length, reverse, setPre2
 
Methods inherited from class tom.engine.adt.il.IlAbstractType
convertATermToBoolean, convertATermToChar, convertATermToDouble, convertATermToFloat, convertATermToInt, convertATermToLong, convertATermToString, getUniqueIdentifier, setUniqueIdentifier, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

make

public static derivrule make(String _Name,
                             Deriv _Post,
                             DerivTree _Pre,
                             Seq _Cond)
Constructor that builds a term rooted by derivrule

Returns:
a term rooted by derivrule

symbolName

public String symbolName()
Returns the name of the symbol

Specified by:
symbolName in class IlAbstractType
Returns:
the name of the symbol

duplicate

public shared.SharedObject duplicate()
Copy the object and returns the copy

Specified by:
duplicate in interface shared.SharedObject
Returns:
a clone of the SharedObject

toStringBuilder

public void toStringBuilder(StringBuilder buffer)
Appends a string representation of this term to the buffer given as argument.

Specified by:
toStringBuilder in class IlAbstractType
Parameters:
buffer - the buffer to which a string represention of this term is appended.

compareToLPO

public int compareToLPO(Object o)
Compares two terms. This functions implements a total lexicographic path ordering.

Specified by:
compareToLPO in class IlAbstractType
Parameters:
o - object to which this term is compared
Returns:
a negative integer, zero, or a positive integer as this term is less than, equal to, or greater than the argument
Throws:
ClassCastException - in case of invalid arguments
RuntimeException - if unable to compare childs

compareTo

public int compareTo(Object o)
Compares two terms. This functions implements a total order.

Specified by:
compareTo in interface Comparable
Specified by:
compareTo in class IlAbstractType
Parameters:
o - object to which this term is compared
Returns:
a negative integer, zero, or a positive integer as this term is less than, equal to, or greater than the argument
Throws:
ClassCastException - in case of invalid arguments
RuntimeException - if unable to compare childs

hashCode

public final int hashCode()
Returns hashCode

Specified by:
hashCode in interface shared.SharedObject
Overrides:
hashCode in class Object
Returns:
hashCode

equivalent

public final boolean equivalent(shared.SharedObject obj)
Checks if a SharedObject is equivalent to the current object

Specified by:
equivalent in interface shared.SharedObject
Parameters:
obj - SharedObject to test
Returns:
true if obj is a derivrule and its members are equal, else false

isderivrule

public boolean isderivrule()
Returns true if the term is rooted by the symbol derivrule

Overrides:
isderivrule in class DerivTree
Returns:
true, because this is rooted by derivrule

getName

public String getName()
Returns the attribute String

Overrides:
getName in class DerivTree
Returns:
the attribute String

setName

public DerivTree setName(String set_arg)
Sets and returns the attribute tom.engine.adt.il.types.DerivTree

Overrides:
setName in class DerivTree
Parameters:
set_arg - the argument to set
Returns:
the attribute String which just has been set

getPost

public Deriv getPost()
Returns the attribute tom.engine.adt.il.types.Deriv

Overrides:
getPost in class DerivTree
Returns:
the attribute tom.engine.adt.il.types.Deriv

setPost

public DerivTree setPost(Deriv set_arg)
Sets and returns the attribute tom.engine.adt.il.types.DerivTree

Overrides:
setPost in class DerivTree
Parameters:
set_arg - the argument to set
Returns:
the attribute tom.engine.adt.il.types.Deriv which just has been set

getPre

public DerivTree getPre()
Returns the attribute tom.engine.adt.il.types.DerivTree

Overrides:
getPre in class DerivTree
Returns:
the attribute tom.engine.adt.il.types.DerivTree

setPre

public DerivTree setPre(DerivTree set_arg)
Sets and returns the attribute tom.engine.adt.il.types.DerivTree

Overrides:
setPre in class DerivTree
Parameters:
set_arg - the argument to set
Returns:
the attribute tom.engine.adt.il.types.DerivTree which just has been set

getCond

public Seq getCond()
Returns the attribute tom.engine.adt.il.types.Seq

Overrides:
getCond in class DerivTree
Returns:
the attribute tom.engine.adt.il.types.Seq

setCond

public DerivTree setCond(Seq set_arg)
Sets and returns the attribute tom.engine.adt.il.types.DerivTree

Overrides:
setCond in class DerivTree
Parameters:
set_arg - the argument to set
Returns:
the attribute tom.engine.adt.il.types.Seq which just has been set

toATerm

public aterm.ATerm toATerm()
Returns an ATerm representation of this term.

Overrides:
toATerm in class DerivTree
Returns:
an ATerm representation of this term.

fromTerm

public static DerivTree fromTerm(aterm.ATerm trm,
                                 ATermConverter atConv)
Apply a conversion on the ATerm contained in the String and returns a tom.engine.adt.il.types.DerivTree from it

Parameters:
trm - ATerm to convert into a Gom term
atConv - ATerm Converter used to convert the ATerm
Returns:
the Gom term

getChildCount

public int getChildCount()
Returns the number of childs of the term

Specified by:
getChildCount in interface Visitable
Returns:
the number of childs of the term

getChildAt

public Visitable getChildAt(int index)
Returns the child at the specified index

Specified by:
getChildAt in interface Visitable
Parameters:
index - index of the child to return; must be nonnegative and less than the childCount
Returns:
the child at the specified index
Throws:
IndexOutOfBoundsException - if the index out of range

setChildAt

public Visitable setChildAt(int index,
                            Visitable v)
Set the child at the specified index

Specified by:
setChildAt in interface Visitable
Parameters:
index - index of the child to set; must be nonnegative and less than the childCount
v - child to set at the specified index
Returns:
the child which was just set
Throws:
IndexOutOfBoundsException - if the index out of range

setChildren

public Visitable setChildren(Visitable[] childs)
Set children to the term

Specified by:
setChildren in interface Visitable
Parameters:
childs - array of children to set
Returns:
an array of children which just were set
Throws:
IndexOutOfBoundsException - if length of "childs" is different than 4

getChildren

public Visitable[] getChildren()
Returns the whole children of the term

Specified by:
getChildren in interface Visitable
Returns:
the children of the term

hashFunction

protected int hashFunction()
Compute a hashcode for this term. (for internal use)

Returns:
a hash value