library/src/main/java/com/datatorrent/lib/algo/UniqueValueKeyVal.java

/*
 * Copyright (c) 2013 DataTorrent, Inc. ALL Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.datatorrent.lib.algo;

import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;

import com.datatorrent.api.DefaultInputPort;
import com.datatorrent.api.DefaultOutputPort;
import com.datatorrent.api.Operator.Unifier;
import com.datatorrent.api.annotation.OperatorAnnotation;

import com.datatorrent.lib.util.BaseKeyOperator;
import com.datatorrent.lib.util.KeyValPair;

/**
 * This operator counts the number of unique values corresponding to a key within a window. 
 * At the end of each window each key/unique count pair is emitted.
 * <p>
 * Count unique occurrences of vals for every key within a window, and emits Key,Integer pairs tuple.
 * </p>
 * <p>
 * This is an end of window operator. It uses sticky key partition and default unifier<br>
 * <br>
 * <b>StateFull : Yes, </b> Tuple are aggregated across application window(s). <br>
 * <b>Partitions : Yes, </b> Unique key/value are unified at output port. <br>
 * <br>
 * <b>Ports</b>:<br>
 * <b>data</b>: expects KeyValPair&lt;K,V&gt;<br>
 * <b>count</b>: emits KeyValPair&lt;K,Integer&gt;<br>
 * <br>
 * </p>
 *
 * @displayName Count Unique Values Per Key
 * @category Algorithmic
 * @tags count, key value
 *
 * @since 0.3.2
 */
@OperatorAnnotation(partitionable = true)
public class UniqueValueKeyVal<K> extends BaseKeyOperator<K> implements  Unifier<KeyValPair<K, Integer>>
{
  /**
   * The input port which receives key value pairs.
   */
  public final transient DefaultInputPort<KeyValPair<K,?>> data = new DefaultInputPort<KeyValPair<K,?>>()
  {
    /**
     * Reference counts tuples
     */
    @Override
    public void process(KeyValPair<K,?> tuple)
    {
      HashSet<Object> vals = map.get(tuple.getKey());
      if (vals == null) {
        vals = new HashSet<Object>();
        map.put(cloneKey(tuple.getKey()), vals);
      }
      vals.add(tuple.getValue());
    }
  };
  /**
   * The output port which emits key/unique value count pairs.
   */
  public final transient DefaultOutputPort<KeyValPair<K,Integer>> count = new DefaultOutputPort<KeyValPair<K,Integer>>();

  /**
   * Bucket counting mechanism.
   */
  protected HashMap<K, HashSet<Object>> map = new HashMap<K, HashSet<Object>>();


  /**
   * Emits key,Integer pairs
   */
  @SuppressWarnings({ "unchecked", "rawtypes" })
  @Override
  public void endWindow()
  {
    for (Map.Entry<K,HashSet<Object>> e: map.entrySet()) {
      count.emit(new KeyValPair(e.getKey(), e.getValue().size()));
    }
    clearCache();
  }

  public void clearCache()
  {
    map.clear();
  }

  @Override
  public void process(KeyValPair<K, Integer> tuple)
  {
    HashSet<Object> vals = map.get(tuple.getKey());
    if (vals == null) {
      vals = new HashSet<Object>();
      map.put(cloneKey(tuple.getKey()), vals);
    }
    vals.add(tuple.getValue());
  }
}