ptolemy.actor.lib.io
Class LineWriter
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.io.LineWriter
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
- Direct Known Subclasses:
- ExpressionWriter
- public class LineWriter
- extends Sink
This actor reads string-valued input tokens and writes them,
one line at a time, to a specified file. It does not
include any enclosing quotation marks in the output.
If you need the enclosing quotation marks, use ExpressionWriter.
The file is specified by the fileName attribute
using any form acceptable to FileParameter.
If the append attribute has value true,
then the file will be appended to. If it has value false,
then if the file exists, the user will be queried for permission
to overwrite, and if granted, the file will be overwritten.
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 2.2
- Version:
- $Id: LineWriter.java,v 1.17 2004/04/13 03:07:12 cxh Exp $
- Author:
- Edward A. Lee
- See Also:
FileParameter,
ExpressionWriter,
Serialized Form
- Accepted Rating:
- Proposed Rating:
| Fields inherited from class ptolemy.actor.lib.Sink |
input |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Constructor Summary |
LineWriter(CompositeEntity container,
java.lang.String name)
Construct an actor with the given container and name. |
|
Method Summary |
protected void |
_writeToken(Token token)
Write the specified token to the current writer.
|
void |
attributeChanged(Attribute attribute)
If the specified attribute is fileName and there is an
open file being written, then close that file. |
java.lang.Object |
clone(Workspace workspace)
Clone the actor into the specified workspace. |
boolean |
postfire()
Read an input string token and write it to the file.
|
void |
wrapup()
Close the writer if there is one. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, connectionsChanged, fire, getDirector, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate |
| Methods inherited from class ptolemy.kernel.Entity |
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables |
| Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
append
public Parameter append
- If true, then append to the specified file. If false
(the default), then overwrite any preexisting file after asking
the user for permission.
fileName
public FileParameter fileName
- The file name to which to write. This is a string with
any form accepted by FileParameter. The default value is
"System.out".
- 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.
_writer
protected java.io.PrintWriter _writer
- The current writer.
LineWriter
public LineWriter(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.
attributeChanged
public void attributeChanged(Attribute attribute)
throws IllegalActionException
- If the specified attribute is fileName and there is an
open file being written, then close that file. The new file will
be opened or created when it is next written to.
- Overrides:
attributeChanged in class NamedObj
- Parameters:
attribute - The attribute that has changed.
- Throws:
IllegalActionException - If the specified attribute
is fileName and the previously
opened file cannot be closed.
clone
public java.lang.Object clone(Workspace workspace)
throws java.lang.CloneNotSupportedException
- Clone the actor into the specified workspace.
- Overrides:
clone in class AtomicActor
- Parameters:
workspace - The workspace for the cloned object.
- Returns:
- A new actor.
- Throws:
java.lang.CloneNotSupportedException - If a derived class contains
an attribute that cannot be cloned.
postfire
public boolean postfire()
throws IllegalActionException
- Read an input string token and write it to the file.
If there is no input, do nothing.
If the file is not open for writing then open it. If the file
does not exist, then create it. If the file already exists,
then query the user for overwrite, unless the append
parameter has value true.
- Specified by:
postfire in interface Executable- Overrides:
postfire in class AtomicActor
- Returns:
- True if execution can continue into the next iteration.
- Throws:
IllegalActionException - If the file cannot be opened
or created, or if the user refuses to overwrite an existing file.
wrapup
public void wrapup()
throws IllegalActionException
- Close the writer if there is one.
- Specified by:
wrapup in interface Executable- Overrides:
wrapup in class AtomicActor
- Throws:
IllegalActionException - If an IO error occurs.
_writeToken
protected void _writeToken(Token token)
- Write the specified token to the current writer.
This is protected so that derived classes can modify the
format in which the token is written.
- Parameters:
token - The token to write.