ptolemy.actor.lib.jai
Class JAIWriter
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.actor.lib.Sink
ptolemy.actor.lib.jai.JAIWriter
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
- Direct Known Subclasses:
- JAIBMPWriter, JAIJPEGWriter, JAIPNGWriter, JAIPNMWriter, JAITIFFWriter
public abstract class JAIWriter
- extends Sink
An abstract class that provides support for writing JAIImages
Write a javax.media.jai.RenderedOp to a specified JPEG file.
Derived classes should have a postfire() method that
creates a new _imageEncodeParameters, performs any setup
on _imageEncodeParameters and then calls super.postfire()
The file is specified by the fileName attribute
using any form acceptable to FileParameter.
If the confirmOverwrite parameter has value false,
then this actor will overwrite the specified file if it exists
without asking. If true (the default), then if the file
exists, then this actor will ask for confirmation before overwriting.
- Since:
- Ptolemy II 4.0
- Version:
- $Id: JAIWriter.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Christopher Hylands Brooks, James Yeh
- See Also:
FileParameter
,
Serialized Form
- Accepted Rating:
- Proposed Rating:
Field Summary |
protected boolean |
_alreadyReadImageToken
Set to true if the input was read in by the derived class. |
protected javax.media.jai.RenderedOp |
_image
The image that was optionally read in by the derived class. |
protected com.sun.media.jai.codec.ImageEncodeParam |
_imageEncodeParam
The encoder parameters. |
protected java.lang.String |
_imageEncoderName
The name of the encoder in a format suitable for
com.sun.media.jai.codec.ImageCodec, for example "BMP", or "JPG". |
protected JAIImageToken |
_jaiImageToken
The JAIImageToken that was optionally read in by the derived class. |
Parameter |
confirmOverwrite
If false, then overwrite the specified file if it exists
without asking. |
FileParameter |
fileName
The file name to which to write. |
Fields inherited from class ptolemy.actor.lib.Sink |
input |
Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
Constructor Summary |
JAIWriter(CompositeEntity container,
java.lang.String name)
Construct an actor with the given container and name. |
Method Summary |
boolean |
postfire()
Read an input JAIImageToken and write it to the file. |
Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, fire, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup |
Methods inherited from class ptolemy.kernel.ComponentEntity |
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName |
Methods inherited from class ptolemy.kernel.Entity |
_description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName |
Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
fileName
public FileParameter fileName
- The file name to which to write. This is a string with
any form accepted by FileParameter.
- See Also:
FileParameter
confirmOverwrite
public Parameter confirmOverwrite
- If false, then overwrite the specified file if it exists
without asking. If true (the default), then if the file
exists, ask for confirmation before overwriting.
_alreadyReadImageToken
protected boolean _alreadyReadImageToken
- Set to true if the input was read in by the derived class.
Certain derived classes want to read in the JAIImageToken so
they can adjust the output format accordingly. These actors
read the input, set the value of _jaiImageToken and _image set
_alreadyReadImageToken to true and then call super.postfire(),
which acts accordingly.
- See Also:
_jaiImageToken
,
JAIPNGWriter
_image
protected javax.media.jai.RenderedOp _image
- The image that was optionally read in by the derived class.
- See Also:
_alreadyReadImageToken
_imageEncoderName
protected java.lang.String _imageEncoderName
- The name of the encoder in a format suitable for
com.sun.media.jai.codec.ImageCodec, for example "BMP", or "JPG".
_imageEncodeParam
protected com.sun.media.jai.codec.ImageEncodeParam _imageEncodeParam
- The encoder parameters. Derived classes usually instantiate
a format specific subclass of ImageEncodeParam and then
set _imageEncodeParam to the format specific instance and
then call super.postfire().
_jaiImageToken
protected JAIImageToken _jaiImageToken
- The JAIImageToken that was optionally read in by the derived class.
- See Also:
_alreadyReadImageToken
JAIWriter
public JAIWriter(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Construct an actor with the given container and name.
- Parameters:
container
- The container.name
- The name of this actor.
- Throws:
IllegalActionException
- If the actor cannot be contained
by the proposed container.
NameDuplicationException
- If the container already has an
actor with this name.
postfire
public boolean postfire()
throws IllegalActionException
- Read an input JAIImageToken and write it to the file.
If the file does not exist then create it. If the file
already exists, then query the user for overwrite.
- Specified by:
postfire
in interface Executable
- Overrides:
postfire
in class AtomicActor
- Returns:
- True if the execution can continue.
- Throws:
IllegalActionException
- If the file cannot be opened
or created, if the user refuses to overwrite an existing file,
of if the image in unable to be encoded.