com.ocs.dynamo.ui.composite.layout.FlexibleSearchLayout Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dynamo-frontend Show documentation
The newest version!
/*
   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 com.ocs.dynamo.ui.composite.layout;

import java.io.Serializable;
import java.util.HashSet;
import java.util.Set;

import com.ocs.dynamo.dao.FetchJoinInformation;
import com.ocs.dynamo.domain.AbstractEntity;
import com.ocs.dynamo.domain.model.AttributeModel;
import com.ocs.dynamo.domain.model.EntityModel;
import com.ocs.dynamo.filter.FlexibleFilterType;
import com.ocs.dynamo.service.BaseService;
import com.ocs.dynamo.ui.composite.form.AbstractModelBasedSearchForm;
import com.ocs.dynamo.ui.composite.form.ModelBasedFlexibleSearchForm;
import com.ocs.dynamo.ui.provider.QueryType;
import com.vaadin.flow.data.provider.SortOrder;

import lombok.Getter;

/**
 * A search layout that allows a user to dynamically add and remove search
 * criteria
 *
 * @author bas.rutten
 *
 * @param  type of the primary key of the entities to search for
 * @param   the entity to search for
 */
public class FlexibleSearchLayout>
		extends AbstractModelSearchLayout {

	private static final long serialVersionUID = -6179979286298244161L;

	/**
	 * Paths of the properties for which to offer only basic String filter
	 * functionality (equal, contains, and starts)
	 */
	@Getter
	private Set basicStringFilterProperties = new HashSet<>();

	/**
	 * Constructor
	 *
	 * @param service     the service used to retrieve the entities
	 * @param entityModel the entity model
	 * @param queryType   the query type
	 * @param formOptions the form options
	 * @param sortOrder   sort order
	 * @param joins       relations to fetch
	 */
	public FlexibleSearchLayout(BaseService service, EntityModel entityModel, QueryType queryType,
			FormOptions formOptions, SortOrder sortOrder, FetchJoinInformation... joins) {
		super(service, entityModel, queryType, formOptions, sortOrder, joins);
	}

	/**
	 * Adds a property to the set of properties for which only basic String filters
	 * will be supported
	 *
	 * @param property the property
	 */
	public void addBasicStringFilterProperty(String property) {
		basicStringFilterProperties.add(property);
	}

	@Override
	protected AbstractModelBasedSearchForm constructSearchForm() {
		ModelBasedFlexibleSearchForm searchForm = new ModelBasedFlexibleSearchForm(null, getEntityModel(),
				getFormOptions(), this.getDefaultFilters(), this.getFieldFilters());

		initSearchForm(searchForm);
		searchForm.setComponentContext(getComponentContext());
		searchForm.setBasicStringFilterProperties(basicStringFilterProperties);
		searchForm.build();

		for (AttributeModel am : getEntityModel().getRequiredForSearchingAttributeModels()) {
			searchForm.addFilter(am, searchForm.getDefaultFilterType(am), null, null);
		}

		return searchForm;
	}

	@Override
	public ModelBasedFlexibleSearchForm getSearchForm() {
		return (ModelBasedFlexibleSearchForm) super.getSearchForm();
	}

	/**
	 * Sets a predefined search value
	 *
	 * @param propertyId the property to search for
	 * @param value      the desired value
	 */
	@Override
	public void setSearchValue(String propertyId, Object value) {
		getSearchForm().addFilter(getEntityModel().getAttributeModel(propertyId), FlexibleFilterType.EQUALS, value,
				null);
	}

	/**
	 * Sets a certain search value (for a property with an upper and a lower bound)
	 *
	 * @param propertyId the property to search for
	 * @param value      the value of the lower bound
	 * @param auxValue   the value of the upper bound
	 */
	@Override
	public void setSearchValue(String propertyId, Object value, Object auxValue) {
		getSearchForm().addFilter(getEntityModel().getAttributeModel(propertyId), FlexibleFilterType.BETWEEN, value,
				auxValue);
	}
}