io.vertigo.studio.notebook.search.FacetedQuerySketch Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of vertigo-studio 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.studio.notebook.search;

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

import io.vertigo.core.lang.Assertion;
import io.vertigo.studio.notebook.AbstractSketch;
import io.vertigo.studio.notebook.SkecthPrefix;
import io.vertigo.studio.notebook.SketchKey;
import io.vertigo.studio.notebook.domain.DomainSketch;
import io.vertigo.studio.notebook.domain.DtSketch;

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

	private final DtSketch indexDtSketch;

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

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

	/** Query du listFilterBuilder. */
	private final String listFilterBuilderQuery;
	/** Query du geoSearchQuery. */
	private final Optional geoSearchQueryOpt;

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

	/**
	 * Constructor.
	 * @param name Nom de la definition
	 * @param indexDtSketch Sketch du DtIndex sur lequel s'applique cette recherche
	 * @param facetSketchs Liste des facettes
	 * @param criteriaDomain Criteria's domain
	 * @param listFilterBuilderClassName listFilterBuilderClass to use
	 * @param listFilterBuilderQuery listFilterBuilderQuery to use
	 */
	public FacetedQuerySketch(
			final String name,
			final DtSketch indexDtSketch,
			final List facetSketchs,
			final DomainSketch criteriaDomain,
			final String listFilterBuilderClassName,
			final String listFilterBuilderQuery,
			final Optional geoSearchQuery) {
		super(name);
		//---
		Assertion
				.check()
				.isNotNull(indexDtSketch)
				.isNotNull(facetSketchs)
				.isNotNull(criteriaDomain)
				.isNotBlank(listFilterBuilderClassName)
				.isNotNull(listFilterBuilderQuery)
				.isNotNull(geoSearchQuery);
		//---
		this.indexDtSketch = indexDtSketch;
		for (final FacetSketch facetSketch : facetSketchs) {
			facetSketches.put(facetSketch.getKey(), facetSketch);
		}
		this.criteriaDomain = criteriaDomain;
		this.listFilterBuilderClassName = listFilterBuilderClassName;
		this.listFilterBuilderQuery = listFilterBuilderQuery;
		geoSearchQueryOpt = geoSearchQuery;
	}

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

	/**
	 * Définition du dtIndex de cette recherche.
	 * @return Définition du keyConcept.
	 */
	public DtSketch getIndexDtSketch() {
		return indexDtSketch;
	}

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

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

	/**
	  * @return Class du ListFilterBuilder.
	 */
	public String getListFilterBuilderClassName() {
		return listFilterBuilderClassName;
	}

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

	/**
	 * @return if there is a geoSearchQuery.
	 */
	public String getGeoSearchQuery() {
		return geoSearchQueryOpt.get();
	}

	/**
	 * @return Query du geoSearch.
	 */
	public boolean hasGeoSearch() {
		return geoSearchQueryOpt.isPresent();
	}
}