ptdb.gui

Class DBReferenceActorInteractionAddon

java.lang.Object

ptdb.gui.DBReferenceActorInteractionAddon

All Implemented Interfaces:

ActorInteractionAddon

public class DBReferenceActorInteractionAddon
extends java.lang.Object
implements ActorInteractionAddon

Implementation of interface for interaction with actors. This implementation defines how to interact with database reference actors. In this case, the behavior of the "Open Actor" and "Open Instance" dropdown options are defined to warn the user that changes will not be persistent unless the reference model is opened from the database. To use this class, it must be defined as the value of a _actorInteractionAddon parameter in the Configuration.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Lyle Holsinger

Pt.AcceptedRating:

red (lholsing)

Pt.ProposedRating:

red (lholsing)

Constructor Summary

Constructors

Constructor and Description
DBReferenceActorInteractionAddon()

Method Summary

Modifier and Type	Method and Description
ActorController	getControllerInstance(GraphController controller) Get an instance of a DBActorController to be used for control of database reference actors.
ActorController	getControllerInstance(GraphController controller, boolean fullAccess) Get an instance of a DBActorController to be used for control of database reference actors.
boolean	isActorOfInterestForAddonController(NamedObj actor) Determine of a given actor is a database reference actor.
boolean	isActorOfInterestForLookInside(NamedObj actor) Determine of a given actor is a database reference actor.
boolean	isActorOfInterestForOpenInstance(NamedObj actor) Determine of a given actor is a database reference actor.
void	lookInsideAction(FigureAction figureAction, NamedObj actor) Show a dialog box warning the user that changes will not be propagated to the database reference model.
void	openInstanceAction(FigureAction figureAction, NamedObj actor) Show a dialog box warning the user that changes will not be propagated to the database reference model.

Methods inherited from class java.lang.Object

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

Constructor Detail

DBReferenceActorInteractionAddon

public DBReferenceActorInteractionAddon()

Method Detail

isActorOfInterestForLookInside

public boolean isActorOfInterestForLookInside(NamedObj actor)

Determine of a given actor is a database reference actor.

Specified by:

isActorOfInterestForLookInside in interface ActorInteractionAddon

Parameters:

actor - The actor of interest.

Returns:

True if the actor is a database reference actor, False otherwise.

lookInsideAction

public void lookInsideAction(FigureAction figureAction,
                             NamedObj actor)
                      throws IllegalActionException,
                             NameDuplicationException

Show a dialog box warning the user that changes will not be propagated to the database reference model.

Specified by:

lookInsideAction in interface ActorInteractionAddon

Parameters:

figureAction - The FigureAction from which the call is being made.

actor - The actor being opened.

Throws:

IllegalActionException - If the container is incompatible with this attribute.

NameDuplicationException - If the name coincides with an attribute already in the container.

getControllerInstance

public ActorController getControllerInstance(GraphController controller,
                                             boolean fullAccess)

Get an instance of a DBActorController to be used for control of database reference actors.

Specified by:

getControllerInstance in interface ActorInteractionAddon

Parameters:

controller - The associated graph controller.

fullAccess - Indication if the controller should be instantiated with Full access.

Returns:

An new instance a DBActorController.

getControllerInstance

public ActorController getControllerInstance(GraphController controller)

Get an instance of a DBActorController to be used for control of database reference actors. This assumes full access.

Specified by:

getControllerInstance in interface ActorInteractionAddon

Parameters:

controller - The associated graph controller.

Returns:

An instance of the appropriate controller.

isActorOfInterestForOpenInstance

public boolean isActorOfInterestForOpenInstance(NamedObj actor)

Determine of a given actor is a database reference actor.

Specified by:

isActorOfInterestForOpenInstance in interface ActorInteractionAddon

Parameters:

actor - The actor of interest.

Returns:

True if the actor is a database reference actor, False otherwise.

openInstanceAction

public void openInstanceAction(FigureAction figureAction,
                               NamedObj actor)
                        throws IllegalActionException,
                               NameDuplicationException

Show a dialog box warning the user that changes will not be propagated to the database reference model.

Specified by:

openInstanceAction in interface ActorInteractionAddon

Parameters:

figureAction - The FigureAction from which the call is being made.

actor - The actor being opened.

Throws:

IllegalActionException - If the container is incompatible with this attribute.

NameDuplicationException - If the name coincides with an attribute already in the container.

isActorOfInterestForAddonController

public boolean isActorOfInterestForAddonController(NamedObj actor)

Determine of a given actor is a database reference actor.

Specified by:

isActorOfInterestForAddonController in interface ActorInteractionAddon

Parameters:

actor - The actor of interest.

Returns:

True if the actor is a database reference actor, False otherwise.