heron/api/src/java/org/apache/heron/streamlet/impl/operators/FilterOperator.java

/**
 * 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 org.apache.heron.streamlet.impl.operators;

import org.apache.heron.api.tuple.Tuple;
import org.apache.heron.api.tuple.Values;
import org.apache.heron.streamlet.SerializablePredicate;

/**
 * FilterOperator implements the  functionality of the filter operation
 * It takes in a filterFunction predicate as the input.
 * For every tuple that it encounters, the filter function is run
 * and the tuple is re-emitted if the predicate evaluates to true
 */
public class FilterOperator<R> extends StreamletOperator<R, R> {
  private static final long serialVersionUID = -4748646871471052706L;
  private SerializablePredicate<? super R> filterFn;

  public FilterOperator(SerializablePredicate<? super R> filterFn) {
    this.filterFn = filterFn;
  }

  @SuppressWarnings("unchecked")
  @Override
  public void execute(Tuple tuple) {
    R obj = (R) tuple.getValue(0);
    if (filterFn.test(obj)) {
      collector.emit(new Values(obj));
    }
    collector.ack(tuple);
  }
}