Package ptolemy.actor.gt

Interface GTEntity

All Superinterfaces:

Nameable

All Known Implementing Classes:

AtomicActorMatcher, AttributeMatcher, CompositeActorMatcher, FSMMatcher, ModalModelMatcher, Pattern, Replacement, StateMatcher, TransitionMatcher

public interface GTEntity
extends Nameable

Common interface of the matchers in model transformations.

Since:

Ptolemy II 7.1

Version:

$Id$

Author:

Thomas Huining Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Yellow (tfeng)

Method Summary

Modifier and Type	Method	Description
GTIngredientsAttribute	getCriteriaAttribute()	Return the attribute that stores all the criteria for this matcher.
java.lang.String	getDefaultIconDescription()	Return a string that contains the SVG icon description ("<svg>...</svg>") for this matcher.
GTIngredientsAttribute	getOperationsAttribute()	Return the attribute that stores all the operations for this matcher.
PatternObjectAttribute	getPatternObjectAttribute()	Return the attribute that stores the name of the corresponding entity in the pattern of the same TransformationRule, if this entity is in the replacement, or null otherwise.
java.util.Set<java.lang.String>	labelSet()	Return the set of names of ingredients contained in this entity that can be resolved.
boolean	match(NamedObj object)	Test whether this GTEntity can match the given object.
void	updateAppearance(GTIngredientsAttribute attribute)	Update appearance of this entity.

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Method Detail

getCriteriaAttribute

GTIngredientsAttribute getCriteriaAttribute()

Return the attribute that stores all the criteria for this matcher.

Returns:

The attribute that stores all the criteria.

getDefaultIconDescription

java.lang.String getDefaultIconDescription()

Return a string that contains the SVG icon description ("<svg>...</svg>") for this matcher. This icon description is the default icon for the matcher, which may be changed by the criteria.

Returns:

The icon description.

getOperationsAttribute

GTIngredientsAttribute getOperationsAttribute()

Return the attribute that stores all the operations for this matcher.

Returns:

The attribute that stores all the operations.

getPatternObjectAttribute

PatternObjectAttribute getPatternObjectAttribute()

Return the attribute that stores the name of the corresponding entity in the pattern of the same TransformationRule, if this entity is in the replacement, or null otherwise.

Returns:

The attribute that stores the name of the corresponding entity.

See Also:

labelSet()

labelSet

java.util.Set<java.lang.String> labelSet()

Return the set of names of ingredients contained in this entity that can be resolved.

Returns:

The set of names.

match

boolean match(NamedObj object)

Test whether this GTEntity can match the given object. The matching is shallow in the sense that objects contained by this GTEntity need not match the corresponding objects in the given object for the return result to be true.

Parameters:

object - The NamedObj.

Returns:

Whether this GTEntity can match the given object.

updateAppearance

void updateAppearance(GTIngredientsAttribute attribute)

Update appearance of this entity.

Parameters:

attribute - The attribute containing ingredients of this entity.