This actor reads record-valued input tokens and writes them, one line at a time, to a specified file, as comma-separated list (or separated by some other delimiter given by the separator parameter). The first line contains the names of the fields of the input record, separated by the same delimiter.
The file is specified by the fileName attribute using any form acceptable to {@link 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.
@see FileParameter @see ExpressionWriter @author Edward A. Lee @version $Id: CSVWriter.java 70398 2014-10-22 23:44:32Z cxh $ @since Ptolemy II 10.0 @Pt.ProposedRating Yellow (eal) @Pt.AcceptedRating Red (cxh) */ public class CSVWriter extends LineWriter { /** Construct an actor with the given container and name. * @param container The container. * @param name The name of this actor. * @exception IllegalActionException If the actor cannot be contained * by the proposed container. * @exception NameDuplicationException If the container already has an * actor with this name. */ public CSVWriter(CompositeEntity container, String name) throws IllegalActionException, NameDuplicationException { super(container, name); separator = new StringParameter(this, "separator"); separator.setExpression("comma"); separator.addChoice("comma"); separator.addChoice("tab"); separator.addChoice("semicolon"); // Clear type constraint set by base class. input.setTypeEquals(BaseType.UNKNOWN); // Force the input type to be a record. input.setTypeAtMost(RecordType.EMPTY_RECORD); _attachText("_iconDescription", "\n"); } /////////////////////////////////////////////////////////////////// //// ports and parameters //// /** A specification of the separator between items in the table. * The default is "comma", which results in assuming that fields * are separated by commas. If the value is changed to "tab", then * a tab separator will be used. If the value is "semicolon", then * a semicolon separator will be used. If the value is anything * else, then the value of the parameter, whatever it is, will * be the separator. */ public StringParameter separator; /////////////////////////////////////////////////////////////////// //// public methods //// /** If the specified attribute is separator then set a local * variable with the value of the separator. * @param attribute The attribute that has changed. * @exception IllegalActionException If the specified attribute * is fileOrURL and the file cannot be opened, or the previously * opened file cannot be closed; or if the attribute is * numberOfLinesToSkip and its value is negative. */ @Override public void attributeChanged(Attribute attribute) throws IllegalActionException { if (attribute == separator) { _delimiter = separator.stringValue(); if (_delimiter.equals("comma")) { _delimiter = ","; } else if (_delimiter.equals("tab")) { _delimiter = "\t"; } else if (_delimiter.equals("semicolon")) { _delimiter = ";"; } else { _delimiter = separator.stringValue(); } } else { super.attributeChanged(attribute); } } /** Clone the actor into the specified workspace. This calls the * base class and then sets the type constraints on the input. * @param workspace The workspace for the new object. * @return A new actor. * @exception CloneNotSupportedException If a derived class contains * an attribute that cannot be cloned. */ @Override public Object clone(Workspace workspace) throws CloneNotSupportedException { CSVWriter newObject = (CSVWriter) super.clone(workspace); newObject.input.setTypeEquals(BaseType.UNKNOWN); newObject.input.setTypeAtMost(RecordType.EMPTY_RECORD); return newObject; } /** Initialize this actor. Derived classes override this method * to perform actions that should occur once at the beginning of * an execution, but after type resolution. Derived classes can * produce output data and schedule events. * @exception IllegalActionException If a derived class throws it. */ @Override public void initialize() throws IllegalActionException { super.initialize(); _firstFiring = true; } /////////////////////////////////////////////////////////////////// //// protected methods //// /** Write the specified token to the current writer. * The token argument is required to be a record token. * @param token The token to write. * @exception IllegalActionException Not thrown in this base class. */ @Override protected void _writeToken(Token token) throws IllegalActionException { RecordToken record = (RecordToken) token; String eol = "\n"; Token eolToken = endOfLineCharacter.getToken(); if (eolToken != null) { eol = ((StringToken) eolToken).stringValue(); } if (_firstFiring) { // Write the first line, which is determined by the input. // Note that we get the labelSet from the record, which // may be ordered if this is an OrderedToken. // We used to read the RecordType labelSet, which is wrong: //RecordType inputType = (RecordType) input.getType(); //_fieldNames = inputType.labelSet(); _fieldNames = record.labelSet(); boolean first = true; for (String field : _fieldNames) { if (!first) { _writer.print(_delimiter); } first = false; _writer.print(field); } _writer.print(eol); _firstFiring = false; } boolean first = true; for (String field : _fieldNames) { if (!first) { _writer.print(_delimiter); } first = false; _writer.print(record.get(field)); } _writer.print(eol); if (_flushValue) { _writer.flush(); } } /////////////////////////////////////////////////////////////////// //// private members //// /** The delimiter. */ private String _delimiter = ","; /** Field names determined from input data type. */ private Set