org.gridkit.coherence.search.IndexEngineConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of search-common Show documentation
The newest version!
/**
 * Copyright 2011 Alexey Ragozin
 *
 * 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 org.gridkit.coherence.search;

/**
 * API to configure options of Coherence indexing engine.
 * @author Alexey Ragozin ([email protected])
 */
public interface IndexEngineConfig {
	
	/**
	 * @return max queue size for asynchronous index updates. 0 - updates are synchronous.
	 */
	public int getIndexUpdateQueueSizeLimit();
	
	/**
	 * Sets asynchronous update queue size limit. 0 - updates are synchronous.
	 * @param queueSize
	 */
	public void setIndexUpdateQueueSizeLimit(int queueSize);
	
	/**
	 * Max delay in ms before update will be applied to index if asynchronous updates are enables.
	 */
	public int getIndexUpdateDelay();

	/**
	 * Sets Max delay in ms before update will be applied to index if asynchronous updates are enables. 
	 * @param indexUpdateDelay
	 */
	public void setIndexUpdateDelay(int indexUpdateDelay);
	
	/**
	 * Search engine can maintain separate standard index based of same
	 * extractor. This index is available for common Coherence filters
	 * and can be used to retrieve original values on updates.
	 * @return true if attribute index enabled 
	 */
	public boolean isAttributeIndexEnabled();

	/**
	 * Set attributeIndex option. Seee {@link #isAttributeIndexEnabled()}
	 */
	public void setAttributeIndexEnabled(boolean enabled);
	
	/**
	 * Up on updates or deletes search engine may put some effort to retrieve value of attribute before update.
	 * If particular index does not need this, option can be turned off to save some processing.
	 * @return true original value will be retrieved
	 */
	public boolean isOldValueOnUpdateEnabled();
	
	/**
	 * Set oldValueOnUpdate option. See {@link #isOldValueOnUpdateEnabled()}
	 */
	public void setOldValueOnUpdateEnabled(boolean enabled);
	
}