/* An actor that converts an appropriate string token to key and value tokens.
Copyright (c) 2006-2009 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the above
copyright notice and the following two paragraphs appear in all copies
of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.actor.ptalon.lib;
import ptolemy.actor.TypedAtomicActor;
import ptolemy.actor.TypedIOPort;
import ptolemy.data.StringToken;
import ptolemy.data.type.BaseType;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
import ptolemy.kernel.util.Workspace;
//////////////////////////////////////////////////////////////////////////
//// StringToKeyValue
/**
This actor converts each pair of input string tokens to a key and
value string token.
@author Adam Cataldo
@version $Id$
@since Ptolemy II 6.1
@Pt.ProposedRating Red (cxh)
@Pt.AcceptedRating Red (cxh)
*/
public class StringToKeyValue extends TypedAtomicActor {
/** 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 StringToKeyValue(CompositeEntity container, String name)
throws NameDuplicationException, IllegalActionException {
super(container, name);
input = new TypedIOPort(this, "input");
input.setInput(true);
input.setTypeEquals(BaseType.STRING);
key = new TypedIOPort(this, "key");
key.setOutput(true);
key.setTypeEquals(BaseType.STRING);
value = new TypedIOPort(this, "value");
value.setOutput(true);
value.setTypeEquals(BaseType.STRING);
}
///////////////////////////////////////////////////////////////////
//// ports and parameters ////
/** The input port.
*
*/
public TypedIOPort input;
/** The key output port.
*
*/
public TypedIOPort key;
/** The value output port.
*
*/
public TypedIOPort value;
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Clone the actor into the specified workspace.
* @param workspace The workspace into which the object is cloned.
* @return A new actor.
* @exception CloneNotSupportedException If a derived class contains
* an attribute that cannot be cloned.
*/
public Object clone(Workspace workspace) throws CloneNotSupportedException {
StringToKeyValue newObject = (StringToKeyValue) super.clone(workspace);
return newObject;
}
/** Read exactly one token from the input and output an array
* version of the token.
* @exception IllegalActionException If there is no director.
*/
public void fire() throws IllegalActionException {
super.fire();
String keyString = ((StringToken) input.get(0)).stringValue();
String valueString = ((StringToken) input.get(0)).stringValue();
if (keyString.equals("EOF") && valueString.equals("EOF")) {
return;
}
StringToken keyToken = new StringToken(keyString);
StringToken valueToken = new StringToken(valueString);
key.send(0, keyToken);
value.send(0, valueToken);
}
/** Return false if the input port has no token, otherwise return
* what the superclass returns (presumably true).
* @exception IllegalActionException If there is no director.
*/
public boolean prefire() throws IllegalActionException {
if (!input.hasToken(0, 2)) {
return false;
}
return super.prefire();
}
}