org.kepler.objectmanager.data

Class DataSourceControllerFactory

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.kernel.util.SingletonAttribute

ptolemy.vergil.basic.NodeControllerFactory

org.kepler.objectmanager.data.DataSourceControllerFactory

All Implemented Interfaces:

java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable, Singleton

public class DataSourceControllerFactory
extends NodeControllerFactory

This is attribute that produces a custom node controller for Data Sources. This class produces a node controller that is customized in order to add the "Get metadata" menu. To use this class, just insert it as an attribute inside any Ptolemy II object, and then right clicking on the icon for that object will result in the use of the controller specified here. The instance by convention will be named "_controllerFactory", but the only reason to enforce this is that only the first such controller factory found as an attribute will be used. It is a singleton, so placing it any container will replace any previous controller factory with the same name.

Since:

Ptolemy II 4.0

Author:

Matthew Jones

Pt.AcceptedRating:

Red (mbj)

Pt.ProposedRating:

Red (mbj)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

Constructors

Constructor and Description
DataSourceControllerFactory(NamedObj container, java.lang.String name) Construct a new factory with the given container and name.

Method Summary

Modifier and Type	Method and Description
NamedObjController	create(diva.graph.GraphController controller) Return a new node controller.

Methods inherited from class ptolemy.kernel.util.SingletonAttribute

setContainer

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setName, updateContent

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceControllerFactory

public DataSourceControllerFactory(NamedObj container,
                                   java.lang.String name)
                            throws NameDuplicationException,
                                   IllegalActionException

Construct a new factory with the given container and name.

Parameters:

container - The container.

name - The name.

Throws:

IllegalActionException - If the factory cannot be contained by the proposed container.

NameDuplicationException - If the container already has an attribute with this name.

Method Detail

create

public NamedObjController create(diva.graph.GraphController controller)

Return a new node controller. This class returns an instance of DataSourceInstanceController which customizes the "Get metadata" menu to support documentation for the data sources.

Overrides:

create in class NodeControllerFactory

Parameters:

controller - The associated graph controller.

Returns:

A new node controller.