/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat, Inc. and/or its affiliates or third-party contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors. All third-party contributions are
* distributed under license by Red Hat, Inc.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package org.hibernate.search.filter;
import java.util.Properties;
import org.apache.lucene.search.Filter;
/**
* Defines the caching filter strategy
* implementations of getCachedFilter and addCachedFilter must be thread-safe
*
* @author Emmanuel Bernard
*/
public interface FilterCachingStrategy {
/**
* initialize the strategy from the properties
* The Properties must not be changed
*/
void initialize(Properties properties);
/**
* Retrieve the cached filter for a given key or null if not cached
*/
Filter getCachedFilter(FilterKey key);
/**
* Propose a candidate filter for caching
*/
void addCachedFilter(FilterKey key, Filter filter);
}