com.datatorrent.lib.algo.AllAfterMatchMap Maven / Gradle / Ivy

Go to download
/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.Map;

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

import com.datatorrent.lib.util.BaseMatchOperator;

/**
 * This operator takes Maps, whose values are numbers, as input tuples. 
 * It then performs a numeric comparison on the values corresponding to one of the keys in the input tuple maps. 
 * All tuples processed by the operator before the first successful comparison are not output by the operator,
 * all tuples processed by the operator after and including a successful comparison are output by the operator.
 *
 * 
 * A compare metric is done on input tuple based on the property "key",
 * "value", and "cmp" type. All tuples are emitted (inclusive) once a match is made.
 * The comparison is done by getting double value from the Number.
 * This module is a pass through

 * 

 *  StateFull : Yes,  Count is aggregated over application window(s). 

 *  Partitions : No,  will yield wrong result. 

 * 

 * 

 * Ports:

 * data: expects Map<K,V extends Number>

 * allafter: emits Map<K,V extends Number> if compare function
 * returns true

 * 

 * Properties:

 * key: The key on which compare is done

 * value: The value to compare with

 * cmp: The compare function. Supported values are "lte", "lt", "eq",
 * "neq", "gt", "gte". Default is "eq"

 * 

 * Specific compile time checks:

 * Key must be non empty

 * Value must be able to convert to a "double"

 * Compare string, if specified, must be one of "lte", "lt", "eq", "neq", "gt",
 * "gte"

 * Specific run time checks: None

 * 

 * 
 *
 * @displayName Emit All After Match (Number)
 * @category Rules and Alerts
 * @tags filter, compare, numeric, key value
 *
 * @since 0.3.2
 */
@OperatorAnnotation(partitionable = false)
public class AllAfterMatchMap extends
    BaseMatchOperator
{
  /**
   * The input port on which tuples are received.
   */
  public final transient DefaultInputPort> data = new DefaultInputPort>()
  {
    /**
     * Process HashMap and emit all tuples at and after match
     */
    @Override
    public void process(Map tuple)
    {
      if (doemit) {
        allafter.emit(cloneTuple(tuple));
        return;
      }
      V v = tuple.get(getKey());
      if (v == null) { // error tuple
        return;
      }
      if (compareValue(v.doubleValue())) {
        doemit = true;
        allafter.emit(cloneTuple(tuple));
      }
    }
  };

  /**
   * The output port on which all tuples after a match are emitted.
   */
  public final transient DefaultOutputPort> allafter = new DefaultOutputPort>();
  boolean doemit = false;

  /**
   * Resets the matched variable
   *
   * @param windowId
   */
  @Override
  public void beginWindow(long windowId)
  {
    doemit = false;
  }
}