io.vertigo.datafactory.collections.definitions.FacetedQueryDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vertigo-datafactory Show documentation
The newest version!
/*
 * vertigo - application development platform
 *
 * Copyright (C) 2013-2024, Vertigo.io, [email protected]
 *
 * 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.datafactory.collections.definitions;

import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import io.vertigo.core.lang.Assertion;
import io.vertigo.core.node.definition.AbstractDefinition;
import io.vertigo.core.node.definition.DefinitionPrefix;
import io.vertigo.datamodel.smarttype.definitions.SmartTypeDefinition;

/**
 * Définition des requêtes d'accès à l'index de recherche.
 *
 * les requêtes sont facettées.
 *
 * @author pchretien
 */
@DefinitionPrefix(FacetedQueryDefinition.PREFIX)
public final class FacetedQueryDefinition extends AbstractDefinition {
	public static final String PREFIX = "Qry";

	/** Liste indexée des facettes.*/
	private final Map facetDefinitions = new LinkedHashMap<>();

	/** Domain du criteria. */
	private final SmartTypeDefinition criteriaDomain;

	/** Query du listFilterBuilder. */
	private final String listFilterBuilderQuery;

	/** Query du geoSearchQuery. */
	private final String geoSearchQuery;

	/**
	 * Moyen de créer le ListFilter à partir du Criteria.
	 */
	private final Class listFilterBuilderClass;

	/**
	 * Constructor.
	 * @param name Nom de la definition
	 * @param keyConceptDtDefinition Definition du keyConcept sur lequel s'applique cette recherche
	 * @param facetDefinitions Liste des facettes
	 * @param criteriaSmartType Criteria's smartType
	 * @param listFilterBuilderClass listFilterBuilderClass to use
	 * @param listFilterBuilderQuery listFilterBuilderQuery to use
	 * @param myGeoSearchQuery geo query
	 */
	public FacetedQueryDefinition(
			final String name,
			final List facetDefinitions,
			final SmartTypeDefinition criteriaSmartType,
			final Class listFilterBuilderClass,
			final String listFilterBuilderQuery,
			final String geoSearchQuery) {
		super(name);
		//---
		Assertion.check()
				.isNotNull(facetDefinitions)
				.isNotNull(criteriaSmartType)
				.isNotNull(listFilterBuilderClass)
				.isNotNull(listFilterBuilderQuery);
		//Assertion.check().notNull(geoSearchQuery);
		//-----
		for (final FacetDefinition facetDefinition : facetDefinitions) {
			this.facetDefinitions.put(facetDefinition.getName(), facetDefinition);
		}
		criteriaDomain = criteriaSmartType;
		this.listFilterBuilderClass = listFilterBuilderClass;
		this.listFilterBuilderQuery = listFilterBuilderQuery;
		this.geoSearchQuery = geoSearchQuery;
	}

	/**
	 * Retourne la facette identifié par son nom.
	 *
	 * @param facetName Nom de la facette recherché.
	 * @return Définition de la facette.
	 */
	public FacetDefinition getFacetDefinition(final String facetName) {
		Assertion.check().isNotBlank(facetName);
		//-----
		final FacetDefinition facetDefinition = facetDefinitions.get(facetName);
		//-----
		Assertion.check().isNotNull(facetDefinition, "Aucune Définition de facette trouvée pour {0}", facetName);
		return facetDefinition;
	}

	/**
	 * @return Liste des facettes portées par l'index.
	 */
	public Collection getFacetDefinitions() {
		return Collections.unmodifiableCollection(facetDefinitions.values());
	}

	/**
	 * @return Domain du criteria.
	 */
	public SmartTypeDefinition getCriteriaDomain() {
		return criteriaDomain;
	}

	/**
	  * @return Class du ListFilterBuilder.
	 */
	public Class getListFilterBuilderClass() {
		return listFilterBuilderClass;
	}

	/**
	 * @return Query du ListFilterBuilder.
	 */
	public String getListFilterBuilderQuery() {
		return listFilterBuilderQuery;
	}

	/**
	 * @return Query du geoSearchQuery.
	 */
	public String getGeoSearchQuery() {
		return geoSearchQuery;
	}
}