com.threewks.thundr.search.TextSearchService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of thundr-gae Show documentation
A thundr module enabling thundr for use on GAE (Google App Engine)
There is a newer version: 3.0.0
/*
 * This file is a component of thundr, a software library from 3wks.
 * Read more: http://3wks.github.io/thundr/
 * Copyright (C) 2015 3wks, 
 *
 * 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 com.threewks.thundr.search;

import java.util.Collection;

import com.threewks.thundr.search.gae.GaeSearchService;

/**
 * The {@link TextSearchService} provides a java class based abstraction over a document search service.
 * Implementations of this service use {@link SearchId} and {@link SearchIndex} annotations to determine
 * what fields of the target object to index. If you need to provide an external id, rather than
 * relying on internal object data use the {@link IdTextSearchService} instead.
 * 
 * @see GaeSearchService
 */
public interface TextSearchService {

	/**
	 * Index the given object using the fields annotated with {@link SearchId} and {@link SearchIndex}, replacing
	 * any previously indexed data
	 * 
	 * @param object the object to index.
	 * @return an asynchronous result wrapper. Call {@link IndexOperation#complete()} to complete the operation.
	 */
	public IndexOperation index(T object);

	/**
	 * Index the given objects using the fields annotated with {@link SearchId} and {@link SearchIndex}.
	 * 
	 * @param objects
	 * @return an asynchronous result wrapper. Call {@link IndexOperation#complete()} to complete the operation.
	 */
	public IndexOperation index(Collection objects);

	/**
	 * Remove the object with the given id from the index
	 * 
	 * @param id
	 * @return an asynchronous result wrapper. Call {@link IndexOperation#complete()} to complete the operation.
	 */
	public IndexOperation removeById(K id);

	/**
	 * Remove the given object from the index
	 * 
	 * @param object
	 * @return an asynchronous result wrapper. Call {@link IndexOperation#complete()} to complete the operation.
	 */
	public IndexOperation remove(T object);

	/**
	 * Remove the objects with the given ids from the index.
	 * 
	 * @param ids
	 * @return an asynchronous result wrapper. Call {@link IndexOperation#complete()} to complete the operation.
	 */
	public IndexOperation removeById(Iterable ids);

	/**
	 * Remove the given objects from the index
	 * 
	 * @param objects
	 * @return an asynchronous result wrapper. Call {@link IndexOperation#complete()} to complete the operation.
	 */
	public IndexOperation remove(Iterable objects);

	/**
	 * Remove all objects from the index.
	 * 
	 * @return the number of objects removed from the index.
	 */
	public int removeAll();

	/**
	 * Create a {@link Search} for the given type. This will return an object which provides a fluent
	 * interface for customising a search
	 * 
	 * @return a {@link Search} that can be used to search.
	 */
	public Search search();
}