com.holonplatform.vaadin7.data.ItemDataProvider 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.data;

import java.util.function.Function;

import com.holonplatform.core.datastore.DataTarget;
import com.holonplatform.core.datastore.Datastore;
import com.holonplatform.core.exceptions.DataAccessException;
import com.holonplatform.core.property.PropertyBox;
import com.holonplatform.core.property.PropertySet;
import com.holonplatform.vaadin7.internal.data.DatastoreItemDataProvider;
import com.holonplatform.vaadin7.internal.data.DefaultItemDataProvider;
import com.holonplatform.vaadin7.internal.data.ItemDataProviderWrapper;

/**
 * Iterface to load items data from a data source.
 * 
 * @param  Item data type
 * 
 * @since 5.0.0
 */
public interface ItemDataProvider extends ItemSetCounter, ItemSetLoader, ItemRefresher {

	/*
	 * (non-Javadoc)
	 * @see com.holonplatform.vaadin.data.ItemRefresher#refresh(java.lang.Object)
	 */
	@Override
	default ITEM refresh(ITEM item) throws UnsupportedOperationException, DataAccessException {
		throw new UnsupportedOperationException();
	}

	/**
	 * Create an {@link ItemDataProvider} using given operations.
	 * @param  Item data type
	 * @param counter Items counter (not null)
	 * @param loader Items loader (not null)
	 * @return A new {@link ItemDataProvider} instance
	 */
	static  ItemDataProvider create(ItemSetCounter counter, ItemSetLoader loader) {
		return new DefaultItemDataProvider<>(counter, loader);
	}

	/**
	 * Create an {@link ItemDataProvider} using given operations.
	 * @param  Item data type
	 * @param counter Items counter (not null)
	 * @param loader Items loader (not null)
	 * @param refresher Item refresher
	 * @return A new {@link ItemDataProvider} instance
	 */
	static  ItemDataProvider create(ItemSetCounter counter, ItemSetLoader loader,
			ItemRefresher refresher) {
		return new DefaultItemDataProvider<>(counter, loader, refresher);
	}

	/**
	 * Construct a {@link ItemDataProvider} using a {@link Datastore}.
	 * @param datastore Datastore to use (not null)
	 * @param target Data target (not null)
	 * @param propertySet Property set to load
	 * @return A new {@link ItemDataProvider} instance
	 */
	static ItemDataProvider create(Datastore datastore, DataTarget target, PropertySet propertySet) {
		return new DatastoreItemDataProvider(datastore, target, propertySet);
	}

	/**
	 * Create a new {@link ItemDataProvider} which wraps a concrete data provider and converts items into a different
	 * type using a converter function.
	 * @param  Item type
	 * @param  Conversion type
	 * @param provider Concrete data privider (not null)
	 * @param converter Converter function (not null)
	 * @return the data provider wrapper
	 */
	static  ItemDataProvider convert(ItemDataProvider provider, Function converter) {
		return new ItemDataProviderWrapper<>(provider, converter);
	}

}