Pruner.java

/**
 * Copyright (c) 2015 Lemur Consulting Ltd.
 * <p/>
 * 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
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * 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 uk.co.flax.biosolr.pruning;

import java.util.Collection;

import uk.co.flax.biosolr.TreeFacetField;

/**
 * A Pruner defines how a facet tree structure should be pruned
 * in order to return the most relevant information.
 *
 * @author mlp
 */
public interface Pruner {
	
	/**
	 * Prune the incoming collection of {@link TreeFacetField} items.
	 * @param unprunedTrees the unpruned facet fields.
	 * @return the pruned collection.
	 */
	public Collection<TreeFacetField> prune(Collection<TreeFacetField> unprunedTrees);

}