edu.illinois.cs.cogcomp.lbjava.IR

Class ConstraintDeclaration

java.lang.Object

edu.illinois.cs.cogcomp.lbjava.IR.ASTNode

edu.illinois.cs.cogcomp.lbjava.IR.Declaration

edu.illinois.cs.cogcomp.lbjava.IR.ConstraintDeclaration

All Implemented Interfaces:

CodeGenerator

public class ConstraintDeclaration
extends Declaration
implements CodeGenerator

Represents the declaration of a constraint. Constraints declared in an LBJava source file are mainly used to constrain inferences, but they may also be used exactly as if they were a classifier with return type discrete{false, true}.

Author:

Nick Rizzolo

Field Summary

Fields

Modifier and Type	Field and Description
Argument	argument (¬ø) The input specification of the constraint.
Block	body (¬ø) Statements making up the body of the constraint.

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.IR.Declaration

comment, name

Fields inherited from class edu.illinois.cs.cogcomp.lbjava.IR.ASTNode

byteOffset, line, nodeID, symbolTable

Constructor Summary

Constructors

Constructor and Description
ConstraintDeclaration(String c, int line, int byteOffset, Name n, Argument a, Block b) Full constructor.
ConstraintDeclaration(TokenValue t, TokenValue i, Argument a, Block b) Parser's constructor.

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates a new object with the same primitive data, and recursively creates new member data objects as well.
int	getLine() Returns the line number on which this AST node is found in the source (starting from line 0).
String	getName() Returns the name of the ConstraintDeclaration.
Type	getType() Returns the type of the declaration.
ASTNodeIterator	iterator() Returns an iterator used to successively access the children of this node.
void	runPass(Pass pass) Ensures that the correct run() method is called for this type of node.
StringBuffer	shallow() Returns a shallow textual representation of this AST node.
void	write(StringBuffer buffer) Writes a string representation of this ASTNode to the specified buffer.

Methods inherited from class edu.illinois.cs.cogcomp.lbjava.IR.ASTNode

toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

argument

public Argument argument

(¬ø) The input specification of the constraint.

body

public Block body

(¬ø) Statements making up the body of the constraint.

Constructor Detail

ConstraintDeclaration

public ConstraintDeclaration(String c,
                             int line,
                             int byteOffset,
                             Name n,
                             Argument a,
                             Block b)

Full constructor.

Parameters:

c - A Javadoc comment associated with the declaration.

line - The line on which the source code represented by this node is found.

byteOffset - The byte offset from the beginning of the source file at which the source code represented by this node is found.

n - The constraint's name.

a - The input specification of the constraint.

b - The code block representing the constraint.

ConstraintDeclaration

public ConstraintDeclaration(TokenValue t,
                             TokenValue i,
                             Argument a,
                             Block b)

Parser's constructor. Line and byte offset information is taken from the first token.

Parameters:

t - The first token indicates line and byte offset information.

i - The identifier token representing the constraint's name.

a - The input specification of the constraint.

b - The code block representing the constraint.

Method Detail

getType

public Type getType()

Returns the type of the declaration.

Specified by:

getType in class Declaration

Returns:

The type of the declaration.

getName

public String getName()

Returns the name of the ConstraintDeclaration.

Specified by:

getName in interface CodeGenerator

getLine

public int getLine()

Returns the line number on which this AST node is found in the source (starting from line 0). This method exists to fulfull the implementation of CodeGenerator.

Specified by:

getLine in interface CodeGenerator

See Also:

CodeGenerator

shallow

public StringBuffer shallow()

Returns a shallow textual representation of this AST node.

Specified by:

shallow in interface CodeGenerator

iterator

public ASTNodeIterator iterator()

Returns an iterator used to successively access the children of this node.

Overrides:

iterator in class Declaration

Returns:

An iterator used to successively access the children of this node.

clone

public Object clone()

Creates a new object with the same primitive data, and recursively creates new member data objects as well.

Overrides:

clone in class ASTNode

Returns:

The clone node.

runPass

public void runPass(Pass pass)

Ensures that the correct run() method is called for this type of node.

Specified by:

runPass in class ASTNode

Parameters:

pass - The pass whose run() method should be called.

write

public void write(StringBuffer buffer)

Writes a string representation of this ASTNode to the specified buffer. The representation written is parsable by the LBJava compiler, but not very readable.

Specified by:

write in class ASTNode

Parameters:

buffer - The buffer to write to.