jade.semantics.lang.sl.tools

Class MatchResult

java.lang.Object

jade.semantics.lang.sl.grammar.Node

jade.semantics.lang.sl.grammar.ListOfNodes

jade.semantics.lang.sl.tools.MatchResult

All Implemented Interfaces:

Comparable

public class MatchResult
extends ListOfNodes

This class holds the result of a matching operation.

Nested Class Summary

Nested classes/interfaces inherited from class jade.semantics.lang.sl.grammar.Node

Node.Operations

Field Summary

Fields inherited from class jade.semantics.lang.sl.grammar.ListOfNodes

_nodesList, ID

Fields inherited from class jade.semantics.lang.sl.grammar.Node

_nodes

Constructor Summary

Constructors

Constructor and Description
MatchResult()

Method Summary

Modifier and Type	Method and Description
void	completeClosure() Assigns the value of all occurrences of the meta-reference meta within exp with the value of meta
ContentExpression	contentExpression(String name) Return the content expression assigned to the named meta variable.
void	copyValueOf(Node n) This method replace the graph entirely with the other graph the root is n.
boolean	equals(Object object) This method return if the node equals another node.
Formula	formula(String name) Return the formula assigned to the named meta variable
Node	getClone() This method return a clone of the graph this node of which is the root.
ContentExpression	getContentExpression(String name) Return the content expression assigned to the named meta variable.
Formula	getFormula(String name) Return the formula assigned to the named meta variable
private Node	getMetaReference(String name)
Symbol	getSymbol(String name) Return the symbol assigned to the named meta variable.
Term	getTerm(String name) Return the term assigned to the named meta variable.
Variable	getVariable(String name) Return the variable assigned to the named meta variable.
MatchResult	intersect(MatchResult other)
MatchResult	join(MatchResult other)
(package private) String	nameOf(String name)
protected void	restore(int size) Restore a previous size of the MatchResult by removing the last elements until the size equals the one given as an argument.
boolean	set(String varName, Node value) This method returns true if a MetaVariable has the given varName in the given MatchResult and if it succeeds in giving it the given value.
Symbol	symbol(String name) Return the symbol assigned to the named meta variable.
Term	term(String name) Return the term assigned to the named meta variable.
String	toString() This method return a display of the matching result.
Variable	variable(String name) Return the variable assigned to the named meta variable.

Methods inherited from class jade.semantics.lang.sl.grammar.ListOfNodes

accept, add, add, addAll, addAll, addAll, asACollection, asAList, children, childrenAccept, childrenOfKind, contains, copyValueOf, dofind, dump, find, get, getClassID, getClone, getFirst, getLast, isEmpty, iterator, remove, remove, removeAll, replace, replaceAll, replaceAll, size, sort

Methods inherited from class jade.semantics.lang.sl.grammar.Node

addObserver, addOperations, childrenOfKind, childrenOfKind, compare, compareTo, find, find, find, find, getAttribute, getAttribute, getOperations, hasAttribute, hasAttribute, initNode, installOperations, notifyChanges, removeObserver, setAttribute, setAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchResult

public MatchResult()

Method Detail

getFormula

public Formula getFormula(String name)
                   throws SL.WrongTypeException

Return the formula assigned to the named meta variable

Parameters:

name - the name of the meta variable to get its value

Returns:

the formula which is the value of the meta variable named with the given name, or null if no formula is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

Throws:

SL.WrongTypeException - Thrown if the value of the variable is not a formula

formula

public Formula formula(String name)

Return the formula assigned to the named meta variable

Parameters:

name - the name of the meta variable to get its value

Returns:

the formula which is the value of the meta variable named with the given name, or null if no formula is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

getTerm

public Term getTerm(String name)
             throws SL.WrongTypeException

Return the term assigned to the named meta variable.

Parameters:

name - the name of the meta variable to get its value

Returns:

the term which is the value of the meta variable named with the given name, or null if no term is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

Throws:

SL.WrongTypeException - Thrown if the value of the variable is not a term.

term

public Term term(String name)

Return the term assigned to the named meta variable.

Parameters:

name - the name of the meta variable to get its value

Returns:

the term which is the value of the meta variable named with the given name, or null if no term is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

getVariable

public Variable getVariable(String name)
                     throws SL.WrongTypeException

Return the variable assigned to the named meta variable.

Parameters:

name - the name of the meta variable to get its value

Returns:

the variable which is the value of the meta variable named with the given name, or null if no variable is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

Throws:

SL.WrongTypeException - Thrown if the value of the variable is not a variable.

variable

public Variable variable(String name)

Return the variable assigned to the named meta variable.

Parameters:

name - the name of the meta variable to get its value

Returns:

the variable which is the value of the meta variable named with the given name, or null if no variable is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

getSymbol

public Symbol getSymbol(String name)
                 throws SL.WrongTypeException

Return the symbol assigned to the named meta variable.

Parameters:

name - the name of the meta variable to get its value

Returns:

the symbol which is the value of the meta variable named with the given name, or null if no symbol is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

Throws:

SL.WrongTypeException - Thrown if the value of the variable is not a symbol.

symbol

public Symbol symbol(String name)

Return the symbol assigned to the named meta variable.

Parameters:

name - the name of the meta variable to get its value

Returns:

the symbol which is the value of the meta variable named with the given name, or null if no symbol is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

getContentExpression

public ContentExpression getContentExpression(String name)
                                       throws SL.WrongTypeException

Return the content expression assigned to the named meta variable.

Parameters:

name - the name of the meta variable to get its value

Returns:

the content expression which is the value of the meta variable named with the given name, or null if no content expression is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

Throws:

SL.WrongTypeException - Thrown if the value of the variable is not a content expression.

contentExpression

public ContentExpression contentExpression(String name)

Return the content expression assigned to the named meta variable.

Parameters:

name - the name of the meta variable to get its value

Returns:

the content expression which is the value of the meta variable named with the given name, or null if no content expression is assigned to this meta variable, meaning the last matching operation has failed, or no matching operation has been performed on this pattern.

toString

public String toString()

This method return a display of the matching result.

Overrides:

toString in class ListOfNodes

Returns:

the image string of the list.

equals

public boolean equals(Object object)

Description copied from class: Node

This method return if the node equals another node.

Overrides:

equals in class Node

Parameters:

object - The match result object to compare with

Returns:

true is this match result object equals the one given as an argument. "Equal" means that the 2 objects holds the same meta variables (name and value) regardless their rank in the list.

intersect

public MatchResult intersect(MatchResult other)

Parameters:

other - the other match result to compute the intersection between

Returns:

the intersection between this match result and the one given as an argument or null if the 2 match results are incompatible, i.e., they hold the same variable with different values.

join

public MatchResult join(MatchResult other)

Parameters:

other - the other match result to join with

Returns:

the union between this match result and the one given as an argument or null if the 2 match results are incompatible, i.e., they hold the same variable with different values.

getClone

public Node getClone()

Description copied from class: Node

This method return a clone of the graph this node of which is the root.

Overrides:

getClone in class Node

Returns:

a new recreated graph.

copyValueOf

public void copyValueOf(Node n)

Description copied from class: Node

This method replace the graph entirely with the other graph the root is n.

Overrides:

copyValueOf in class Node

Parameters:

n - the root node of the new graph.

completeClosure

public void completeClosure()
                     throws SL.WrongTypeException

Assigns the value of all occurrences of the meta-reference meta within exp with the value of meta

Throws:

SL.WrongTypeException

set

public boolean set(String varName,
                   Node value)

This method returns true if a MetaVariable has the given varName in the given MatchResult and if it succeeds in giving it the given value.

Parameters:

varName - the name of a metavariable

value - the value of the metavariable

Returns:

true if a MetaVariable has the given varName in the given MatchResult and if it succeeds in giving it the given value, false if not.

restore

protected void restore(int size)

Restore a previous size of the MatchResult by removing the last elements until the size equals the one given as an argument.

Parameters:

size -

nameOf

String nameOf(String name)

getMetaReference

private Node getMetaReference(String name)