aterm

Interface ATerm

All Superinterfaces:

Identifiable, jjtraveler.Visitable

All Known Subinterfaces:

AFun, ATermAppl, ATermBlob, ATermInt, ATermList, ATermLong, ATermPlaceholder, ATermReal

All Known Implementing Classes:

AFunImpl, ATermApplImpl, ATermBlobImpl, ATermImpl, ATermIntImpl, ATermListImpl, ATermLongImpl, ATermPlaceholderImpl, ATermRealImpl

public interface ATerm
extends Visitable, Identifiable

This is the base interface for all ATerm interfaces, which will ultimately be implemented by two separate ATerm Factories (a native and a pure one).

Author:

Hayco de Jong (jong@cwi.nl), Pieter Olivier (olivierp@cwi.nl)

Field Summary

Fields

Modifier and Type	Field and Description
static int	AFUN A term of type AFUN (function symbol)
static int	APPL A term of type APPL (function application)
static int	BLOB A term of type BLOB (Binary Large OBject)
static int	INT A term of type INT
static int	LIST A term of type LIST
static int	LONG A term of type LONG
static int	PLACEHOLDER A term of type PLACEHOLDER
static int	REAL A term of type REAL

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks equality of this term against any java object.
ATerm	getAnnotation(ATerm label) Gets a annotation associated with specific label from this term.
ATermList	getAnnotations() Gets all annotations of this term.
ATermFactory	getFactory() Retrieves the factory responsible for creating this ATerm.
int	getType() Gets the type of this term.
boolean	hasAnnotations()
int	hashCode() Gets a hashcode value of this term.
boolean	isEqual(ATerm term) Checks equality of this term against another term.
ATerm	make(List<Object> args) Create a new term based on this term as a pattern and a list of arguments.
List<Object>	match(ATerm pattern) Matches this term against a term pattern.
List<Object>	match(String pattern) Matches this term against a String pattern.
ATerm	removeAnnotation(ATerm label) Removes a specific annotation from this term.
ATerm	removeAnnotations() Removes all annotations of this term.
ATerm	setAnnotation(ATerm label, ATerm anno) Sets annotation of this term with given label.
ATerm	setAnnotations(ATermList annos) Sets all annotations of this term.
String	toString() Gets a string representation of this term.
void	writeToSharedTextFile(OutputStream stream) Write a term to a shared text file/stream.
void	writeToTextFile(OutputStream stream) Write a term to a text file/stream.

Methods inherited from interface aterm.Visitable

accept

Methods inherited from interface jjtraveler.Visitable

getChildAt, getChildCount, setChildAt

Methods inherited from interface aterm.Identifiable

getUniqueIdentifier

Field Detail

INT

static final int INT

A term of type INT

See Also:

Constant Field Values

REAL

static final int REAL

A term of type REAL

See Also:

Constant Field Values

APPL

static final int APPL

A term of type APPL (function application)

See Also:

Constant Field Values

LIST

static final int LIST

A term of type LIST

See Also:

Constant Field Values

PLACEHOLDER

static final int PLACEHOLDER

A term of type PLACEHOLDER

See Also:

Constant Field Values

BLOB

static final int BLOB

A term of type BLOB (Binary Large OBject)

See Also:

Constant Field Values

AFUN

static final int AFUN

A term of type AFUN (function symbol)

See Also:

Constant Field Values

LONG

static final int LONG

A term of type LONG

See Also:

Constant Field Values

Method Detail

getType

int getType()

Gets the type of this term.

Returns:

the type of this ATerm.

See Also:

INT, REAL, APPL, LIST, PLACEHOLDER, BLOB, AFUN, LONG

hashCode

int hashCode()

Gets a hashcode value of this term.

Overrides:

hashCode in class Object

Returns:

the hashcode of this term.

match

List<Object> match(String pattern)

Matches this term against a String pattern. The pattern is parsed into a term, which this term is then matched against.

Parameters:

pattern - the string pattern to match this term against.

Returns:

a list containing the subterms matching the placeholders if the match succeeds, or null if the match fails.

Throws:

ParseError - if pattern cannot be parsed into a term.

See Also:

match(ATerm)

match

List<Object> match(ATerm pattern)

Matches this term against a term pattern. A list containing the subterms matching the placeholders in the pattern is built as this term is matched against the pattern.

Parameters:

pattern - The term pattern to match this term against.

Returns:

a list containing the subterms matching the placeholders if the match succeeds, or null if the match fails.

hasAnnotations

boolean hasAnnotations()

getAnnotation

ATerm getAnnotation(ATerm label)

Gets a annotation associated with specific label from this term.

Parameters:

label - the label of the desired annotation.

Returns:

the annotation associated with label, or null if annotation with specified label does not exist.

See Also:

setAnnotation(aterm.ATerm, aterm.ATerm)

setAnnotation

ATerm setAnnotation(ATerm label,
                  ATerm anno)

Sets annotation of this term with given label. If no annotation with this label exists, a new annotation is created, otherwise the existing annotation is updated.

Parameters:

label - the label of the annotation.

anno - the annotation itself.

Returns:

a new version of this term with the requested annotation.

See Also:

getAnnotation(aterm.ATerm)

removeAnnotation

ATerm removeAnnotation(ATerm label)

Removes a specific annotation from this term.

Parameters:

label - the label of the annotation to be removed.

Returns:

a new version of this term without the annotation.

See Also:

setAnnotation(aterm.ATerm, aterm.ATerm)

getAnnotations

ATermList getAnnotations()

Gets all annotations of this term.

Returns:

all annotations of this term

See Also:

setAnnotations(aterm.ATermList)

setAnnotations

ATerm setAnnotations(ATermList annos)

Sets all annotations of this term.

Parameters:

annos - the annotations to set.

Returns:

a new version of this term with the requested annotations.

See Also:

getAnnotations()

removeAnnotations

ATerm removeAnnotations()

Removes all annotations of this term.

Returns:

a new version of this term without annotations.

See Also:

setAnnotations(aterm.ATermList)

isEqual

boolean isEqual(ATerm term)

Checks equality of this term against another term. This method exists to keep a tight relation to the C-library. Experienced Java programmers might feel more comfortable using the equals(java.lang.Object) method.

Parameters:

term - the term to check for equality.

Returns:

true iff terms are equal (including any annotations they might have!), false otherwise.

See Also:

equals(Object)

equals

boolean equals(Object obj)

Checks equality of this term against any java object. Note that for two terms to be equal, any annotations they might have must be equal as well.

Overrides:

equals in class Object

Parameters:

obj - the object to check for equality.

Returns:

true iff term equals obj (including annotations).

See Also:

isEqual(aterm.ATerm)

writeToTextFile

void writeToTextFile(OutputStream stream)
                     throws IOException

Write a term to a text file/stream.

Parameters:

stream - the stream to write to

Throws:

IOException

writeToSharedTextFile

void writeToSharedTextFile(OutputStream stream)
                           throws IOException

Write a term to a shared text file/stream. An efficient shared ASCII representation of this term is written to the stream.

Parameters:

stream - the stream to write this term to

Throws:

IOException

make

ATerm make(List<Object> args)

Create a new term based on this term as a pattern and a list of arguments.

Parameters:

args - the list of arguments used to fill up holes in the pattern

Returns:

the constructed aterm

getFactory

ATermFactory getFactory()

Retrieves the factory responsible for creating this ATerm.

Returns:

the factory that created this ATerm object.

toString

String toString()

Gets a string representation of this term.

Overrides:

toString in class Object

Returns:

a string representation of this term.