org.clafer.ast

Class AstClafer

java.lang.Object

org.clafer.ast.AstClafer

All Implemented Interfaces:

AstVar

Direct Known Subclasses:

AstAbstractClafer, AstConcreteClafer, AstPrimClafer

public abstract class AstClafer
extends Object
implements AstVar

A Clafer in the model. A Clafer represents both the set and the type. A concrete is either abstract, concrete, or primitive.

Author:

jimmy

Field Summary

Fields

Modifier and Type	Field and Description
protected AstAbstractClafer	claferClafer

Method Summary

Methods

Modifier and Type	Method and Description
AstConcreteClafer	addChild(String name) Add a new concrete child under this Clafer.
AstConstraint	addConstraint(AstBoolExpr expr) Add a new constraint under this Clafer.
boolean	equals(Object obj)
AstClafer	extending(AstAbstractClafer superClafer) Set the supertype of this Clafer.
List<AstConcreteClafer>	getChildren() Returns this Clafer's concrete children
List<AstConstraint>	getConstraints() Returns this Clafer's constraints.
Card	getGroupCard() Returns this Clafer's group cardinality.
String	getName() Returns the name of the Clafer.
AstRef	getRef() Returns this Clafer's reference
AstAbstractClafer	getSuperClafer() Returns the supertype of this Clafer.
boolean	hasChildren() Checks if this Clafer has any concrete children.
boolean	hasConstraints() Checks if this Clafer has any constraints.
int	hashCode()
boolean	hasRef() Check if this Clafer references another Clafer.
boolean	hasSuperClafer() Check if this Clafer has a supertype.
AstClafer	refTo(AstClafer targetType) Set this Clafer's reference to target type.
AstClafer	refToUnique(AstClafer targetType) Set this Clafer's reference to target type along with a uniqueness constraint.
String	toString()
AstClafer	withGroupCard(Card groupCard) Set this Clafer's group cardinality.
AstClafer	withGroupCard(int low) Set this Clafer's low group cardinality and set the high group cardinality to unbounded.
AstClafer	withGroupCard(int low, int high) Set this Clafer's group cardinality.

Methods inherited from class java.lang.Object

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

Field Detail

claferClafer

protected final AstAbstractClafer claferClafer

Method Detail

getName

public String getName()

Returns the name of the Clafer.

Specified by:

getName in interface AstVar

Returns:

the name of the Clafer

hasSuperClafer

public boolean hasSuperClafer()

Check if this Clafer has a supertype. Every Clafer has a supertype except for the special Clafer at the root of the type hierarchy.

Returns:

true if and only if this Clafer has a supertype, false otherwise

getSuperClafer

public AstAbstractClafer getSuperClafer()

Returns the supertype of this Clafer.

Returns:

the supertype of this Clafer

extending

public AstClafer extending(AstAbstractClafer superClafer)

Set the supertype of this Clafer.

Parameters:

superClafer - the supertype

Returns:

this Clafer

hasRef

public boolean hasRef()

Check if this Clafer references another Clafer.

Returns:

true if and only if this Clafer references another Clafer, false otherwise

getRef

public AstRef getRef()

Returns this Clafer's reference

Returns:

this Clafer's reference

refTo

public AstClafer refTo(AstClafer targetType)

Set this Clafer's reference to target type.

Parameters:

targetType - the type to refer to

Returns:

this Clafer

refToUnique

public AstClafer refToUnique(AstClafer targetType)

Set this Clafer's reference to target type along with a uniqueness constraint.

Parameters:

targetType - the type to refer to

Returns:

this Clafer

getGroupCard

public Card getGroupCard()

Returns this Clafer's group cardinality.

Returns:

this Clafer's group cardinality

withGroupCard

public AstClafer withGroupCard(Card groupCard)

Set this Clafer's group cardinality.

Parameters:

groupCard - the group cardinality

Returns:

this Clafer

withGroupCard

public AstClafer withGroupCard(int low)

Set this Clafer's low group cardinality and set the high group cardinality to unbounded.

Parameters:

low - the low group cardinality

Returns:

this Clafer

withGroupCard

public AstClafer withGroupCard(int low,
                      int high)

Set this Clafer's group cardinality.

Parameters:

low - the low group cardinality

high - the high group cardinality

Returns:

this Clafer

hasChildren

public boolean hasChildren()

Checks if this Clafer has any concrete children.

Returns:

true if and only if this Clafer has children, false otherwise

getChildren

public List<AstConcreteClafer> getChildren()

Returns this Clafer's concrete children

Returns:

this Clafer's concrete children

addChild

public AstConcreteClafer addChild(String name)

Add a new concrete child under this Clafer.

Parameters:

name - the name of the child

Returns:

the new child

hasConstraints

public boolean hasConstraints()

Checks if this Clafer has any constraints.

Returns:

true if and only if this Clafer has constraints, false otherwise

getConstraints

public List<AstConstraint> getConstraints()

Returns this Clafer's constraints.

Returns:

this Clafer's constraints

addConstraint

public AstConstraint addConstraint(AstBoolExpr expr)

Add a new constraint under this Clafer.

Parameters:

expr - a tautology

Returns:

the constraint

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object