001/* An actor for the CoGroup DDP pattern.
002 * 
003 * Copyright (c) 2011-2012 The Regents of the University of California.
004 * All rights reserved.
005 *
006 * '$Author: crawl $'
007 * '$Date: 2012-04-13 17:45:44 +0000 (Fri, 13 Apr 2012) $' 
008 * '$Revision: 29710 $'
009 * 
010 * Permission is hereby granted, without written agreement and without
011 * license or royalty fees, to use, copy, modify, and distribute this
012 * software and its documentation for any purpose, provided that the above
013 * copyright notice and the following two paragraphs appear in all copies
014 * of this software.
015 *
016 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
017 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
018 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
019 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
020 * SUCH DAMAGE.
021 *
022 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
023 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
024 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
025 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
026 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
027 * ENHANCEMENTS, OR MODIFICATIONS.
028 *
029 */
030package org.kepler.ddp.actor.pattern;
031
032import ptolemy.kernel.CompositeEntity;
033import ptolemy.kernel.util.IllegalActionException;
034import ptolemy.kernel.util.NameDuplicationException;
035import ptolemy.kernel.util.Workspace;
036
037/** An actor for the CoGroup DDP pattern. This actor reads two
038 *  input data sets of key-value pairs. The sub-workflow in 
039 *  this actor needs to be completed by reading data 
040 *  from the output ports of the CoGroupInput actor and sending
041 *  key-value pairs (an array of <key, value> records) to the 
042 *  CoGroupOutput actor. For each key that is present in either 
043 *  input data set (including when the key is present in only one
044 *  input), the sub-workflow is executed once with the key and
045 *  associated values. 
046 * 
047 *  @author Daniel Crawl
048 *  @version $Id: CoGroup.java 29710 2012-04-13 17:45:44Z crawl $
049 */
050public class CoGroup extends DualInputPatternActor {
051
052    /** Construct a new CoGroup in a workspace. */
053    public CoGroup(Workspace workspace) {
054        super(workspace);
055    }
056
057    /** Construct a new CoGroup in a container with a given name. */
058    public CoGroup(CompositeEntity container, String name)
059            throws IllegalActionException, NameDuplicationException {
060        super(container, name);
061    }
062
063}