com.holonplatform.vaadin7.components.builders.ItemDataSourceComponentBuilder Maven / Gradle / Ivy

/*
 * Copyright 2016-2017 Axioma srl.
 * 
 * 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.holonplatform.vaadin7.components.builders;

import com.holonplatform.vaadin7.data.ItemDataProvider;
import com.holonplatform.vaadin7.data.ItemDataSource;
import com.holonplatform.vaadin7.data.ItemIdentifierProvider;
import com.holonplatform.vaadin7.data.container.ItemAdapter;
import com.vaadin.ui.Component;

/**
 * Builder for components with {@link ItemDataSource} and item property configuration support.
 * 
 * @param  Item data type
 * @param  Concrete component type
 * @param  Concrete builder type
 *
 * @since 5.0.0
 */
public interface ItemDataSourceComponentBuilder>
		extends BaseItemDataSourceComponentBuilder, ComponentBuilder {

	/**
	 * Set the data source items data provider and the {@link ItemIdentifierProvider} to obtain item identifiers.
	 * @param dataProvider Items data provider (not null)
	 * @param itemIdentifierProvider Item identifier provider (not null)
	 * @return this
	 */
	B dataSource(ItemDataProvider dataProvider, ItemIdentifierProvider itemIdentifierProvider);

	/**
	 * Set the data source items data provider, using the item itself as item identifier.
	 * @param dataProvider Items data provider (not null)
	 * @return this
	 */
	default B dataSource(ItemDataProvider dataProvider) {
		return dataSource(dataProvider, ItemIdentifierProvider.identity());
	}

	/**
	 * Set the item adapter to use to convert data source items into container items and back.
	 * @param itemAdapter the item adapter (not null)
	 * @return this
	 */
	B itemAdapter(ItemAdapter itemAdapter);

}