io.vertigo.dynamo.search.model.SearchIndex 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
The newest version!
/**
 * vertigo - simple java starter
 *
 * Copyright (C) 2013-2016, 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.model;

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.domain.util.DtObjectUtil;
import io.vertigo.dynamo.search.metamodel.SearchIndexDefinition;
import io.vertigo.lang.Assertion;

/**
 * Objet d'échange avec l'index.
 * Cet objet permet de
 *  - construire l'index de recherche
 *  - consulter le résultat d'une recherhe
 *
 *  Le DtObject d'index utilise
 *  - la propriété 'persistent' des fields pour savoir si le champs fait partit du résultat ou non
 *  - le domain et sa propriété indexType pour savoir si le champs est indéxé ou non
 *
 * @author dchallas
 * @param  keyConcept type
 * @param  Index type
 */
public final class SearchIndex {
	/** Définition de l'index. */
	private final SearchIndexDefinition indexDefinition;

	/** URI de l'objet indexé : par convention il s'agit de l'uri de K.*/
	private final URI uri;

	/** DtObject d'index. */
	private final I indexDtObject;

	/**
	 * Constructeur .
	 * @param indexDefinition definition de O, I
	 * @param uri URI de l'objet indexé
	 */
	private SearchIndex(final SearchIndexDefinition indexDefinition, final URI uri, final I indexDtObject) {
		Assertion.checkNotNull(uri);
		Assertion.checkNotNull(indexDefinition);
		Assertion.checkNotNull(indexDtObject);
		//On vérifie la consistance des données.
		Assertion.checkArgument(indexDefinition.getKeyConceptDtDefinition().equals(uri.getDefinition()), "Le type de l'URI de l'objet indexé  ({0}) ne correspond pas au KeyConcept de l'index ({1})", uri.toString(), indexDefinition.getKeyConceptDtDefinition().getName());
		Assertion.checkArgument(indexDefinition.getIndexDtDefinition().equals(DtObjectUtil.findDtDefinition(indexDtObject)), "Le type l'objet indexé ({1}) ne correspond pas à celui de l'index ({1})", DtObjectUtil.findDtDefinition(indexDtObject).getName(), indexDefinition.getIndexDtDefinition().getName());
		//-----
		this.uri = uri;
		this.indexDefinition = indexDefinition;
		this.indexDtObject = indexDtObject;
	}

	/**
	 * @return Définition de l'index.
	 */
	public SearchIndexDefinition getDefinition() {
		return indexDefinition;
	}

	/**
	 * Récupération de l'uri de la ressource indexée.
	 *  - Utilisé pour la récupération de highlight.
	 * @return URI de la ressource indexée.
	 */
	public URI getURI() {
		return uri;
	}

	/**
	 * Récupération de l'object contenant les champs à indexer.
	 * @return Objet contenant les champs à indexer
	 */
	public I getIndexDtObject() {
		Assertion.checkArgument(hasIndex(), "Index n'est pas dans l'état indexable.");
		//-----
		return indexDtObject;
	}

	/**
	 * @return Contient l'objet d'index
	 */
	private boolean hasIndex() {
		return indexDtObject != null;
	}

	/**
	 * Constructeur de l'Objet permettant de créer l'index.
	 * @param  Type de l'objet représentant l'index
	 * @param uri URI de l'objet indexé
	 * @param indexDefinition Définition de l'index de recherche.
	 * @param indexDto  DTO représentant l'index
	 * @return  Objet permettant de créer l'index
	 */
	public static  SearchIndex createIndex(final SearchIndexDefinition indexDefinition, final URI uri, final I indexDto) {
		return new SearchIndex<>(indexDefinition, uri, indexDto);
	}

}