/*
* 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.geode.cache.lucene;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import org.apache.lucene.analysis.Analyzer;
import org.apache.geode.annotations.Experimental;
/**
* An lucene index is built over the data stored in a GemFire Region.
* <p>
* An index is specified using a index name, field names, region name.
* <p>
* The index name and region name together uniquely identifies the lucene index.
* <p>
*
*/
@Experimental
public interface LuceneIndex {
/**
* @return the index name of this index
*/
public String getName();
/**
* @return the region name for this index
*/
public String getRegionPath();
/**
* @return the indexed field names in a Set
*/
public String[] getFieldNames();
/**
* @return the field to analyzer map
*/
public Map<String, Analyzer> getFieldAnalyzers();
/*
* wait until the current entries in cache are indexed
*
* @param timeout max wait time
*
* @param unit granularity of the timeout
*
* @return if entries are flushed within timeout
*/
public boolean waitUntilFlushed(long timeout, TimeUnit unit) throws InterruptedException;
}