src/main/java/org/apache/pirk/schema/query/filter/DataFilter.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.pirk.schema.query.filter;

import java.io.Serializable;

import org.apache.hadoop.io.MapWritable;
import org.apache.pirk.schema.data.DataSchema;

/**
 * Interface to filter data elements as they are read in for processing
 * <p>
 * All custom filters must implement this interface
 */
public interface DataFilter extends Serializable
{
  /**
   * Filter the data element
   * <p>
   * Returns true if we are to filter out the element, false otherwise
   */
  boolean filterDataElement(MapWritable dataElement, DataSchema dSchema);

}