net.sf.ehcache.search.aggregator.AggregatorInstance Maven / Gradle / Ivy

Go to download
/**
 *  Copyright Terracotta, Inc.
 *
 *  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 net.sf.ehcache.search.aggregator;

import net.sf.ehcache.search.Attribute;

/**
 * An AggregatorInstance takes input objects and computes an aggregate function from them.
 *
 * @author Greg Luck
 * @param 
 *            the runtime type of aggregation result
 */
public interface AggregatorInstance {

    /**
     * Add the given value to the aggregator function
     *
     * @param input a single input value
     * @throws AggregatorException if the function cannot be computed, possibly due to unsupported types
     */
    void accept(Object input) throws AggregatorException;

    /**
     * Retrieve the final result
     *
     * @return aggregate result
     */
    Object aggregateResult();

    /**
     * Get the attribute to pass to aggregator
     *
     * @return attribute to aggregate (null if no attribute is applicable to function)
     */
    Attribute getAttribute();

    /**
     * Create a clone of this aggregator, detaching from its result
     * @return
     */
    AggregatorInstance createClone();
}