com.ocs.dynamo.ui.container.ServiceContainer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dynamo-frontend Show documentation
There is a newer version: 3.0.1
/*
   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.container;

import java.io.Serializable;

import org.vaadin.addons.lazyquerycontainer.LazyQueryContainer;

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.EditableType;
import com.ocs.dynamo.domain.model.EntityModel;
import com.ocs.dynamo.service.BaseService;
import com.ocs.dynamo.ui.Searchable;
import com.vaadin.data.sort.SortOrder;
import com.vaadin.shared.data.sort.SortDirection;

/**
 * A Vaadin query container that supports lazy loading and gets its data by
 * calling a service
 * 
 * @author bas.rutten
 * @param 
 *            type of the entity
 * @param 
 *            type of the primary key of the entity
 */
public class ServiceContainer> extends LazyQueryContainer
		implements Searchable {

	private static final long serialVersionUID = 2605988307857731787L;

	/**
	 * Constructor
	 * 
	 * @param service
	 * @param model
	 * @param compositeItems
	 * @param batchSize
	 * @param queryType
	 * @param joins
	 */
	public ServiceContainer(BaseService service, EntityModel model, boolean compositeItems, int batchSize,
			QueryType queryType, FetchJoinInformation... joins) {
		super(new ServiceQueryDefinition<>(service, compositeItems, batchSize, model, queryType, joins),
				new ServiceQueryFactory());
		addContainerProperties(model);
	}

	/**
	 * Constructor
	 * 
	 * @param service
	 *            service used to query the database
	 * @param entityModel
	 *            the entity model used to convert the filters
	 * @param batchSize
	 *            batch size
	 * @param queryType
	 *            query type
	 * @param joins
	 *            optional joins
	 */
	public ServiceContainer(BaseService service, EntityModel entityModel, int batchSize, QueryType queryType,
			FetchJoinInformation... joins) {
		super(new ServiceQueryDefinition<>(service, true, batchSize, entityModel, queryType, joins),
				new ServiceQueryFactory());

	}

	/**
	 * Adds properties based on an EntityModel
	 * 
	 * @param model
	 */
	public void addContainerProperties(EntityModel model) {
		for (AttributeModel attributeModel : model.getAttributeModels()) {
			if (attributeModel.isVisibleInTable()) {
				addContainerProperty(attributeModel.getName(), attributeModel.getType(),
						attributeModel.getDefaultValue(),
						EditableType.READ_ONLY.equals(attributeModel.getEditableType()), attributeModel.isSortable());
			}
		}
	}

	/**
	 * Adds a single property based on an attribute model
	 * 
	 * @param attributeModel
	 */
	public void addContainerProperty(AttributeModel attributeModel) {
		addContainerProperty(attributeModel.getPath(), attributeModel.getType(), attributeModel.getDefaultValue(),
				EditableType.READ_ONLY.equals(attributeModel.getEditableType()), attributeModel.isSortable());
	}

	@SuppressWarnings("unchecked")
	public BaseService getService() {
		if (getQueryView() != null && getQueryView().getQueryDefinition() instanceof ServiceQueryDefinition) {
			return ((ServiceQueryDefinition) getQueryView().getQueryDefinition()).getService();
		}
		return null;
	}

	@Override
	public void search(Filter filter) {
		// warning: do not use "removeAllContainerFilters" here since this will
		// trigger an unnecessary refresh
		getQueryView().removeFilters();

		// likewise, don't call "addContainerfilter" here since it will also
		// trigger this refresh
		if (filter != null) {
			getQueryView().addFilter(filter);
		}
		refresh();
	}

	/**
	 * Perofmrs a sorting operation
	 * 
	 * @param sortOrder
	 *            the desired sort order
	 */
	public void sort(SortOrder... sortOrder) {
		if (sortOrder != null && sortOrder.length > 0) {
			Object[] pIds = new Object[sortOrder.length];
			boolean[] sos = new boolean[sortOrder.length];
			int i = 0;
			for (SortOrder so : sortOrder) {
				pIds[i] = so.getPropertyId();
				sos[i++] = SortDirection.ASCENDING == so.getDirection();
			}
			sort(pIds, sos);
		}
	}
}