io.vertigo.dynamo.store.criteria.GroupCriteria 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.store.criteria;

import io.vertigo.dynamo.domain.model.DtObject;
import io.vertigo.lang.Assertion;

import java.util.ArrayList;
import java.util.List;

/**
 * Groupement de Critères de type union, intersection et exclusion de groupe.
 * TODO : vérifier la profondeur des groupes et mettre une limite (genre 3)
 * @author npiedeloup
 * @param  Type de l'objet
 */
public final class GroupCriteria implements Criteria {
	private static final long serialVersionUID = -5842091616664522090L;

	/**
	 * Type de jointure.
	 */
	public enum JoinType {
		/**
		 * Union.
		 */
		UNION,
		/**
		 * Intersection.
		 */
		INTERSECT,
		/**
		 * Exclusion : on aura le premier groupe moins les autres.
		 */
		EXCLUDE
	}

	private final GroupCriteria firstGroupCriteria;//Pour l'exclude (on prend forcément un group, pour simplifier l'API)

	private final List> filterCriterias = new ArrayList<>();
	private final List> groupCriterias = new ArrayList<>();
	private final JoinType joinType;

	/**
	 * Constructeur de groupe.
	 * @param joinType type de jointure des éléments du groupe
	 */
	public GroupCriteria(final JoinType joinType) {
		Assertion.checkNotNull(joinType);
		Assertion.checkArgument(JoinType.EXCLUDE != joinType, "Pour l'exclusion, vous devez précisier le premier group, ou filter dans le constructeur");
		//-----
		this.joinType = joinType;
		firstGroupCriteria = null;
	}

	/**
	 * Constructeur de groupe !! uniquement pour l'EXCLUDE !!
	 * @param joinType type de jointure des éléments du groupe (EXCLUDE uniquement)
	 * @param firstGroup Premier group
	 */
	public GroupCriteria(final JoinType joinType, final GroupCriteria firstGroup) {
		Assertion.checkNotNull(joinType);
		Assertion.checkNotNull(firstGroup);
		Assertion.checkArgument(JoinType.EXCLUDE == joinType, "Préciser le group dans le constructeur, n'est permis que pour l'EXCLUDE");
		//-----
		this.joinType = joinType;
		firstGroupCriteria = firstGroup;
	}

	/**
	 * @param group GroupCriteria à ajouter
	 */
	public void add(final GroupCriteria group) {
		Assertion.checkNotNull(group);
		//-----
		groupCriterias.add(group);
	}

	/**
	 * Ajout un BooleanCriteria en intersection.
	 * @param filterCriteria FilterCriteria filtre à ajouter
	 */
	public void add(final FilterCriteria filterCriteria) {
		Assertion.checkNotNull(filterCriteria);
		//-----
		filterCriterias.add(filterCriteria);
	}

	/**
	 * @return Type de jointure (UNION, INTERSEC, EXCLUDE)
	 */
	public JoinType getJoinType() {
		return joinType;
	}

	/**
	* Critère de recherche de type filtre.
	* @return Liste des filtres.
	*/
	public List> getFilterCriterias() {
		return filterCriterias;
	}

	/**
	* Critère de prefix par champs.
	* @return Map des prefixes existant.
	*/
	public List> getGroupCriterias() {
		return groupCriterias;
	}

	/**
	 * Uniquement pour l'EXCLUDE
	 * Retourne le groupe définissant l'ensemble de départ pour les exclusions.
	 * @return Premier groupe avec lequel sera fait les EXCLUDE
	 */
	public GroupCriteria getFirstGroup() {
		Assertion.checkArgument(JoinType.EXCLUDE == joinType, "La notion de premier groupe n'est définit que pour l'EXCLUDE");
		//-----
		return firstGroupCriteria;
	}

	/**
	 * @return Si le group est vide
	 */
	public boolean isEmpty() {
		return groupCriterias.isEmpty() && filterCriterias.isEmpty() && firstGroupCriteria == null;
	}

	/** {@inheritDoc} */
	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + filterCriterias.hashCode();
		result = prime * result + ((firstGroupCriteria == null) ? 0 : firstGroupCriteria.hashCode()); //seul attribut nullable
		result = prime * result + groupCriterias.hashCode();
		result = prime * result + joinType.hashCode();
		return result;
	}

	/** {@inheritDoc} */
	@Override
	public boolean equals(final Object obj) {
		//equals overrided just because hashCode is.
		return super.equals(obj);
	}

}