001/*
002 * Copyright (c) 2005-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.resurgence.actor;
031
032import ptolemy.actor.TypedAtomicActor;
033import ptolemy.actor.TypedIOPort;
034import ptolemy.data.StringToken;
035import ptolemy.data.expr.Parameter;
036import ptolemy.data.type.BaseType;
037import ptolemy.kernel.CompositeEntity;
038import ptolemy.kernel.util.IllegalActionException;
039import ptolemy.kernel.util.NameDuplicationException;
040
041//////////////////////////////////////////////////////////////////////////
042//// StringAccumulator
043
044/**
045 * This actor reads several strings and writes them into one string. The
046 * characters separating the entries can be specified as parameter.
047 * 
048 * @author Wibke Sudholt, University and ETH Zurich, November 2004
049 * @version $Id: StringAccumulator.java 24234 2010-05-06 05:21:26Z welker $
050 */
051public class StringAccumulator extends TypedAtomicActor {
052
053        /**
054         * Construct a StringAccumulator with the given container and name.
055         * 
056         * @param container
057         *            The container.
058         * @param name
059         *            The name of this actor.
060         * @exception IllegalActionException
061         *                If the entity cannot be contained by the proposed
062         *                container.
063         * @exception NameDuplicationException
064         *                If the container already has an actor with this name.
065         */
066        public StringAccumulator(CompositeEntity container, String name)
067                        throws NameDuplicationException, IllegalActionException {
068                super(container, name);
069
070                parts = new TypedIOPort(this, "parts", true, false);
071                parts.setTypeEquals(BaseType.STRING);
072                parts.setMultiport(true);
073
074                whole = new TypedIOPort(this, "whole", false, true);
075                whole.setTypeEquals(BaseType.STRING);
076
077                separator = new Parameter(this, "Substring separator", new StringToken(
078                                ""));
079        }
080
081        // /////////////////////////////////////////////////////////////////
082        // // ports and parameters ////
083
084        /**
085         * The input port, which contains the substrings.
086         */
087        public TypedIOPort parts = null;
088        /**
089         * The output port, which contains the full string.
090         */
091        public TypedIOPort whole = null;
092        /**
093         * The parameter, which specifies the substring separator.
094         */
095        public Parameter separator = null;
096
097        // /////////////////////////////////////////////////////////////////
098        // // public methods ////
099
100        /**
101         * Take the partial strings and print out the whole string.
102         * 
103         * @exception IllegalActionException
104         *                If there's no director.
105         */
106        public void fire() throws IllegalActionException {
107                super.fire();
108                _string = "";
109                _spacer = ((StringToken) separator.getToken()).stringValue();
110                for (int i = 0; i < parts.getWidth(); i++) {
111                        if (parts.hasToken(i)) {
112                                if (_string.length() == 0) {
113                                        _string = ((StringToken) parts.get(i)).stringValue();
114                                } else {
115                                        _string = _string + _spacer
116                                                        + ((StringToken) parts.get(i)).stringValue();
117                                }
118                        }
119                }
120                whole.send(0, new StringToken(_string));
121        }
122
123        // /////////////////////////////////////////////////////////////////
124        // // protected members ////
125
126        // /////////////////////////////////////////////////////////////////
127        // // private methods ////
128
129        // /////////////////////////////////////////////////////////////////
130        // // private members ////
131
132        private String _string;
133        private String _spacer;
134}