ptolemy.actor.gt
Interface GTEntity

All Superinterfaces:

Nameable

All Known Implementing Classes:

AtomicActorMatcher, CompositeActorMatcher, FSMMatcher, Pattern, Replacement

public interface GTEntity
extends Nameable

Common interface of the matchers in model transformations.

Since:

Ptolemy II 6.1

Version:

$Id: GTEntity.java,v 1.10.4.3 2008/03/25 22:12:09 cxh Exp $

Author:

Thomas Huining Feng

Accepted Rating:

Red (tfeng)

Proposed Rating:

Red (tfeng)

Method Summary

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>...
Token	getIngredientToken(java.lang.String name) Return a token that contains an ingredient with the given name contained by this entity, or null if the ingredient cannot be resolved.
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.
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.

getIngredientToken

Token getIngredientToken(java.lang.String name)

Return a token that contains an ingredient with the given name contained by this entity, or null if the ingredient cannot be resolved.

Parameters:

name - The name of the ingredient.

Returns:

The token containing the ingredient object.

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 stires 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.

See Also:

getIngredientToken(String)

updateAppearance

void updateAppearance(GTIngredientsAttribute attribute)

Update appearance of this entity.

Parameters:

attribute - The attribute containing ingredients of this entity.