org.jpc.term

Class Var

java.lang.Object

org.jpc.term.Term

org.jpc.term.AbstractVar

org.jpc.term.Var

public final class Var
extends AbstractVar

A class reifying a logic variable Disclaimer: Some methods were inspired or taken from the JPL library

Author:

scastro

Field Summary

Fields

Modifier and Type	Field and Description
static Var	ANONYMOUS_VAR
protected String	name

Constructor Summary

Constructors

Constructor and Description
Var()
Var(String name)

Method Summary

Modifier and Type	Method and Description
static List<Var>	asVariables(Iterable<String> variablesNames)
String	getName() returns the lexical id of this Variable
int	hashCode()
boolean	isAnonymous()
static boolean	isUnderscoreVariableName(String variableName)
static boolean	isValidVariableName(String variableName) Wether a logic variable has a valid id
Term	preCompile(Environment env)
Term	prepareForFrame(Environment env)
Term	prepareForQuery(Environment env)
boolean	termEquals(Term term) Test if this object is equivalent to the term representation of the object sent as parameter This is not testing for equality in a mathematical sense, for example: 'new Variable("_").equals(new Variable("_"))' is false, since both the receiver and the arguments are anonymous variables, not the same variable.
void	unify(Term term)

Methods inherited from class org.jpc.term.AbstractVar

accept, basicRead, equals, getVariableNames, hasFunctor, isGround, toEscapedString, toString, toString

Methods inherited from class org.jpc.term.Term

arg, arity, asList, basicIsList, canUnify, changeVariablesNames, compile, compile, compile, compile, compileAndUnify, compileAndUnifyVars, getArgs, getNamedVariables, getNamedVariablesNames, getNonUnderscoreVariableNames, getNonUnderscoreVariables, getVariableNames, getVariables, hasFunctor, hasFunctor, hasFunctor, hasFunctor, hasVariable, isHilog, isList, listLength, prepareForFrame, prepareForQuery, read, read, replaceVariables, resolveBindings, termEquals, termExpansion, toEscapedString, toEscapedString, unifyAndBind, varBindings

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ANONYMOUS_VAR

public static final Var ANONYMOUS_VAR

name

protected final String name

Constructor Detail

Var

public Var()

Var

public Var(String name)

Method Detail

isUnderscoreVariableName

public static boolean isUnderscoreVariableName(String variableName)

asVariables

public static List<Var> asVariables(Iterable<String> variablesNames)

isValidVariableName

public static boolean isValidVariableName(String variableName)

Wether a logic variable has a valid id

Parameters:

variableName - the id of the variable

Returns:

wether a logic variable has a valid id

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in class AbstractVar

getName

public final String getName()

returns the lexical id of this Variable

Specified by:

getName in class AbstractVar

Returns:

the lexical id of this Variable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

termEquals

public boolean termEquals(Term term)

Description copied from class: Term

Test if this object is equivalent to the term representation of the object sent as parameter This is not testing for equality in a mathematical sense, for example: 'new Variable("_").equals(new Variable("_"))' is false, since both the receiver and the arguments are anonymous variables, not the same variable. But: 'new Variable("_").termEquals(new Variable("_"))' is true, since they both have the same term representation

Overrides:

termEquals in class Term

Returns:

unify

public void unify(Term term)

Overrides:

unify in class Term

preCompile

public Term preCompile(Environment env)

Specified by:

preCompile in class Term

prepareForQuery

public Term prepareForQuery(Environment env)

Specified by:

prepareForQuery in class Term

prepareForFrame

public Term prepareForFrame(Environment env)

Specified by:

prepareForFrame in class Term