io.vertigo.dynamo.search.SearchManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertigo-dynamo-api Show documentation
There is a newer version: 2.1.0
/**
 * vertigo - simple java starter
 *
 * Copyright (C) 2013, KleeGroup, [email protected] (http://www.kleegroup.com)
 * KleeGroup, Centre d'affaire la Boursidiere - BP 159 - 92357 Le Plessis Robinson Cedex - France
 *
 * 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 io.vertigo.dynamo.search;

import io.vertigo.dynamo.collections.ListFilter;
import io.vertigo.dynamo.collections.model.FacetedQueryResult;
import io.vertigo.dynamo.domain.metamodel.DtDefinition;
import io.vertigo.dynamo.domain.model.DtListState;
import io.vertigo.dynamo.domain.model.DtObject;
import io.vertigo.dynamo.domain.model.KeyConcept;
import io.vertigo.dynamo.domain.model.URI;
import io.vertigo.dynamo.search.metamodel.SearchIndexDefinition;
import io.vertigo.dynamo.search.model.SearchIndex;
import io.vertigo.dynamo.search.model.SearchQuery;
import io.vertigo.lang.Manager;

import java.util.Collection;
import java.util.List;
import java.util.concurrent.Future;

/**
 * Gestionnaire des indexes de recherche.
 *
 * @author dchallas, npiedeloup
 */
public interface SearchManager extends Manager {

	/**
	 * Find IndexDefinition for a keyConcept. It must be one and only one IndexDefinition.
	 * @param keyConceptClass keyConcept class
	 * @return SearchIndexDefinition for this keyConcept (not null)
	 */
	//TODO si par DtDefinition comment s'assurer que c'est un keyConcept ?
	SearchIndexDefinition findIndexDefinitionByKeyConcept(Class keyConceptClass);

	/**
	 * Check if a keyConcept have an IndexDefinition.
	 * @param keyConceptDefinition KeyConcept definition
	 * @return if there is a IndexDefinition for this keyConcept
	 */
	boolean hasIndexDefinitionByKeyConcept(DtDefinition keyConceptDefinition);

	/**
	 * Mark an uri list as dirty. Index of these elements will be reindexed.
	 * Reindexation isn't synchrone, strategy is dependant of plugin's parameters.
	 * @param keyConceptUris Uri of keyConcept marked as dirty.
	 */
	void markAsDirty(List> keyConceptUris);

	/**
	 * Launch a complete reindexation of an index.
	 * @param indexDefinition Type de l'index
	 * @return Future of number elements indexed
	 */
	Future reindexAll(SearchIndexDefinition indexDefinition);

	/**
	 * Ajout de plusieurs ressources à l'index.
	 * Si les éléments étaient déjà dans l'index ils sont remplacés.
	 * @param  Type de l'objet représentant l'index
	 * @param  Type du keyConcept métier indexé
	 * @param indexDefinition Type de l'index
	 * @param indexCollection Liste des objets à pousser dans l'index
	 */
	 void putAll(SearchIndexDefinition indexDefinition, Collection> indexCollection);

	/**
	 * Ajout d'une ressource à l'index.
	 * Si l'élément était déjà dans l'index il est remplacé.
	 * @param  Type de l'objet représentant l'index
	 * @param  Type du keyConcept métier indexé
	 * @param indexDefinition Type de l'index
	 * @param index Objet à pousser dans l'index
	 */
	 void put(SearchIndexDefinition indexDefinition, SearchIndex index);

	/**
	 * Récupération du résultat issu d'une requête.
	 * @param searchQuery critères initiaux
	 * @param indexDefinition Type de l'index
	 * @param listState Etat de la liste (tri et pagination)
	 * @return Résultat correspondant à la requête
	 * @param  Type de l'objet resultant de la recherche
	 */
	 FacetedQueryResult loadList(SearchIndexDefinition indexDefinition, final SearchQuery searchQuery, final DtListState listState);

	/**
	 * @param indexDefinition  Type de l'index
	 * @return Nombre de document indexés
	 */
	long count(SearchIndexDefinition indexDefinition);

	/**
	 * Suppression d'une ressource de l'index.
	 * @param  Type du keyConcept métier indexé
	 * @param indexDefinition Type de l'index
	 * @param uri URI de la ressource à supprimer
	 */
	 void remove(SearchIndexDefinition indexDefinition, final URI uri);

	/**
	 * Suppression des données correspondant à un filtre.
	 * @param indexDefinition Type de l'index
	 * @param listFilter Filtre des éléments à supprimer
	 */
	void removeAll(SearchIndexDefinition indexDefinition, final ListFilter listFilter);

}