ptolemy.actor.lib
Class URLReader
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.Source
ptolemy.actor.lib.URLReader
- All Implemented Interfaces:
- ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.actor.Executable, ptolemy.kernel.util.Instantiable, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, java.io.Serializable, ptolemy.actor.TypedActor
- Direct Known Subclasses:
- DoubleReader, URLDirectoryReader
- public abstract class URLReader
- extends Source
This actor reads tokens from an URL, and output them. Each entry in
the file corresponds to one iteration. If there are multiple fires in
the iteration, the same token will be repeated. This actor has a
multiport, where each port corresponds to one column in the data file.
The file format at the URL is assumed as the following. A newline
character separates the rows, and a tab or a space character separates
the columns.
The sourceURL parameter should be set to the name of the
file, specified as a fully qualified URL. If the sourceURL
parameter is an empty string, then the System.in is used for input.
It is possible to load a file from the local file system by using the
prefix "file://" instead of "http://". Relative file paths are
allowed. To specify a file relative to the current directory, use
"../" or "./". For example, if the current directory contains a file
called "test.txt", then sourceURL should be set to
"file:./test.txt". If the parent directory contains a file called
"test.txt", then sourceURL should be set to
"file:../test.txt". To reference the file test.txt, located at
"/tmp/test.txt", sourceURL should be set to
"file:///tmp/test.txt" The default value is "file:///tmp/test.txt".
FIXME: The type of the output ports is set to Double for now.
It should read a line in the prefire() and refer the type
from there.
FIXME: URLReader should read in expressions and serialized tokens
- Since:
- Ptolemy II 2.0
- Version:
- $Id: URLReader.java,v 1.20 2004/04/13 05:12:30 cxh Exp $
- Author:
- Jie Liu
- See Also:
AudioReader,
Serialized Form
- Accepted Rating:
- Proposed Rating:
| Nested classes inherited from class ptolemy.kernel.Entity |
ptolemy.kernel.Entity.ContainedObjectsIterator |
|
Field Summary |
protected java.io.BufferedReader |
_reader
|
protected boolean |
_refreshFlag
|
protected java.lang.String |
_source
|
protected static java.io.BufferedReader |
_stdIn
|
ptolemy.data.expr.Parameter |
refresh
The flag that indicates whether to refresh between each reading.
|
ptolemy.data.expr.Parameter |
sourceURL
The URL of the file to read from. |
| Fields inherited from class ptolemy.actor.AtomicActor |
_stopRequested |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
| Fields inherited from interface ptolemy.actor.Executable |
COMPLETED, NOT_READY, STOP_ITERATING |
|
Constructor Summary |
URLReader(ptolemy.kernel.CompositeEntity container,
java.lang.String name)
Construct an actor with the given container and name. |
|
Method Summary |
protected void |
_setURLReader(java.io.BufferedReader reader)
Set the reader. |
void |
attributeChanged(ptolemy.kernel.util.Attribute attribute)
If the specified attribute is URL, then close
the current file (if there is one) and open the new one. |
void |
initialize()
Open the file at the URL, and set the width of the output. |
void |
wrapup()
Close the reader if there is one. |
| Methods inherited from class ptolemy.actor.lib.Source |
fire |
| Methods inherited from class ptolemy.actor.TypedAtomicActor |
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate |
| Methods inherited from class ptolemy.kernel.ComponentEntity |
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName |
| 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.InstantiableNamedObj |
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition |
| 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 |
| Methods inherited from interface ptolemy.actor.Actor |
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList |
| Methods inherited from interface ptolemy.actor.Executable |
iterate, postfire, prefire, preinitialize, stop, stopFire, terminate |
| Methods inherited from interface ptolemy.kernel.util.Derivable |
getDerivedLevel, getDerivedList, propagateValue |
| Methods inherited from interface ptolemy.kernel.util.Nameable |
description, getFullName, getName, getName |
sourceURL
public ptolemy.data.expr.Parameter sourceURL
- The URL of the file to read from. This parameter contains
a StringToken. By default, it contains an empty string, which
is interpreted to mean that input should be directed to the
standard input.
FIXME: Should this bring up a dialog box to type (or select) a URL?
refresh
public ptolemy.data.expr.Parameter refresh
- The flag that indicates whether to refresh between each reading.
This is a boolean, and defaults to false.
_reader
protected java.io.BufferedReader _reader
_stdIn
protected static java.io.BufferedReader _stdIn
_source
protected java.lang.String _source
_refreshFlag
protected boolean _refreshFlag
URLReader
public URLReader(ptolemy.kernel.CompositeEntity container,
java.lang.String name)
throws ptolemy.kernel.util.IllegalActionException,
ptolemy.kernel.util.NameDuplicationException
- Construct an actor with the given container and name.
- Parameters:
container - The container.name - The name of this actor.
- Throws:
ptolemy.kernel.util.IllegalActionException - If the actor cannot be contained
by the proposed container.
ptolemy.kernel.util.NameDuplicationException - If the container already has an
actor with this name.
attributeChanged
public void attributeChanged(ptolemy.kernel.util.Attribute attribute)
throws ptolemy.kernel.util.IllegalActionException
- If the specified attribute is URL, then close
the current file (if there is one) and open the new one.
- Parameters:
attribute - The attribute that has changed.
- Throws:
ptolemy.kernel.util.IllegalActionException - If the specified attribute
is URL and the file cannot be opened.
initialize
public void initialize()
throws ptolemy.kernel.util.IllegalActionException
- Open the file at the URL, and set the width of the output.
- Throws:
ptolemy.kernel.util.IllegalActionException - Not thrown in this base class
wrapup
public void wrapup()
throws ptolemy.kernel.util.IllegalActionException
- Close the reader if there is one.
- Throws:
ptolemy.kernel.util.IllegalActionException - If an IO error occurs.
_setURLReader
protected void _setURLReader(java.io.BufferedReader reader)
throws ptolemy.kernel.util.IllegalActionException
- Set the reader. If there was a previous reader, close it.
To set standard input, call this method with argument null.
- Parameters:
reader - The reader to read to.
- Throws:
ptolemy.kernel.util.IllegalActionException - If an IO error occurs.