ptolemy.data.ontologies

Class ExceptionAnalyzer

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

ptolemy.data.ontologies.ExceptionAnalyzer

All Implemented Interfaces:

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

public class ExceptionAnalyzer
extends Attribute
implements ExceptionSubscriber

An attribute that analyzes a model in the event of an exception. To be used with ExceptionManager.

Since:

Ptolemy II 10.0

Version:

$Id: ExceptionAnalyzer.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Elizabeth Latronico

Accepted Rating:

Red (beth)

Proposed Rating:

Red (beth)

Nested Class Summary

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

NamedObj.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
StringParameter	statusMessage A status message reflecting the success or failure of actions taken upon occurrence of an exception.

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
ExceptionAnalyzer(NamedObj container, java.lang.String name) Construct an attribute with the given name contained by the specified entity.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone(Workspace workspace) Clone the actor into the specified workspace.
boolean	exceptionHandled(boolean succesful, java.lang.String message) Nothing to do after exception is handled.
boolean	exceptionOccurred(java.lang.String policy, java.lang.Throwable exception) Handle an exception according to the specified policy: analyze: Determine the source actor(s) and annotate output ports with error constraints.

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, 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

Field Detail

statusMessage

public StringParameter statusMessage

A status message reflecting the success or failure of actions taken upon occurrence of an exception. Implemented as a public parameter so the message can be displayed in the icon.

Constructor Detail

ExceptionAnalyzer

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

Construct an attribute with the given name contained by the specified entity. The container argument must not be null, or a NullPointerException will be thrown. This attribute will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace.

Parameters:

container - The container.

name - The name of this attribute.

Throws:

IllegalActionException - If the attribute is not of an acceptable class for the container, or if the name contains a period.

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

Method Detail

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone the actor into the specified workspace.

Overrides:

clone in class Attribute

Parameters:

workspace - The workspace for the new object.

Returns:

A new actor.

Throws:

java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

exceptionOccurred

public boolean exceptionOccurred(java.lang.String policy,
                                 java.lang.Throwable exception)

Handle an exception according to the specified policy: analyze: Determine the source actor(s) and annotate output ports with error constraints. others: Delegate to parent class

Specified by:

exceptionOccurred in interface ExceptionSubscriber

Parameters:

policy - The policy

exception - The exception that occurred

Returns:

true if the solver completed successfully.

exceptionHandled

public boolean exceptionHandled(boolean succesful,
                                java.lang.String message)

Nothing to do after exception is handled. return true always, since there is nothing to do after handling

Specified by:

exceptionHandled in interface ExceptionSubscriber

Parameters:

succesful - True if the exception was successfully handled; false otherwise

message - A status message from the exception handler

Returns:

True if the subscriber successfully processed the information; false otherwise (for example, an ExceptionEmailer that fails to send an email)