com.holonplatform.vaadin.internal.data.DefaultDatastoreDataProvider Maven / Gradle / Ivy
/*
* Copyright 2000-2017 Holon TDCN.
*
* 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.vaadin.internal.data;
import java.util.LinkedList;
import java.util.List;
import java.util.Optional;
import java.util.stream.Stream;
import com.holonplatform.core.ParameterSet;
import com.holonplatform.core.Path;
import com.holonplatform.core.datastore.DataTarget;
import com.holonplatform.core.datastore.Datastore;
import com.holonplatform.core.internal.utils.ObjectUtils;
import com.holonplatform.core.property.Property;
import com.holonplatform.core.property.PropertyBox;
import com.holonplatform.core.property.PropertySet;
import com.holonplatform.core.query.QueryConfigurationProvider;
import com.holonplatform.core.query.QueryFilter;
import com.holonplatform.core.query.QuerySort;
import com.holonplatform.core.query.QuerySort.SortDirection;
import com.holonplatform.vaadin.data.DatastoreDataProvider;
import com.holonplatform.vaadin.data.ItemIdentifierProvider;
import com.vaadin.data.provider.AbstractBackEndDataProvider;
import com.vaadin.data.provider.Query;
import com.vaadin.data.provider.QuerySortOrder;
import com.vaadin.shared.Registration;
/**
* Default {@link DatastoreDataProvider} implementation.
*
* @since 5.0.0
*/
public class DefaultDatastoreDataProvider extends AbstractBackEndDataProvider
implements DatastoreDataProvider {
private static final long serialVersionUID = -6164535815798337361L;
/**
* Datastore
*/
private Datastore datastore;
/**
* Data target
*/
private DataTarget target;
/**
* Item identifier
*/
private ItemIdentifierProvider itemIdentifier;
/**
* Property set provider
*/
private PropertySet propertySet;
/**
* Query configuration providers
*/
private List queryConfigurationProviders = new LinkedList<>();
/**
* Default constructor.
*/
protected DefaultDatastoreDataProvider() {
super();
}
/**
* Constructor.
* @param datastore Datastore (not null)
* @param target Data target (not null)
* @param propertySet Projection (not null)
*/
public DefaultDatastoreDataProvider(Datastore datastore, DataTarget target, PropertySet propertySet) {
super();
ObjectUtils.argumentNotNull(datastore, "Datastore must be not null");
ObjectUtils.argumentNotNull(target, "DataTarget must be not null");
ObjectUtils.argumentNotNull(propertySet, "PropertySet must be not null");
this.datastore = datastore;
this.target = target;
this.propertySet = propertySet;
}
/**
* Get the {@link Datastore} to use to perform count and load operations.
* @return the datastore
*/
protected Datastore getDatastore() {
if (datastore == null) {
throw new IllegalStateException("Missing Datastore in DatastoreDataProvider");
}
return datastore;
}
/**
* Get the data target to use.
* @return the data target
*/
protected DataTarget getTarget() {
if (datastore == null) {
throw new IllegalStateException("Missing DataTarget in DatastoreDataProvider");
}
return target;
}
/**
* Get the item identifier provider.
* @return the optional item identifier provider
*/
protected Optional> getItemIdentifier() {
return Optional.ofNullable(itemIdentifier);
}
/**
* Get the query projection.
* @return the query projection property set
*/
protected PropertySet getPropertySet() {
if (propertySet == null) {
throw new IllegalStateException("Missing PropertySet in DatastoreDataProvider");
}
return propertySet;
}
/*
* (non-Javadoc)
* @see com.vaadin.data.provider.DataProvider#isInMemory()
*/
@Override
public boolean isInMemory() {
return false;
}
/**
* Set the datastore to use.
* @param datastore the datastore to set
*/
public void setDatastore(Datastore datastore) {
this.datastore = datastore;
}
/**
* Set the data target.
* @param target the target to set
*/
public void setTarget(DataTarget target) {
this.target = target;
}
/**
* Set the item identifier provider.
* @param itemIdentifier the item identifier provider to set
*/
public void setItemIdentifier(ItemIdentifierProvider itemIdentifier) {
this.itemIdentifier = itemIdentifier;
}
/**
* Set the property set to use as query projection.
* @param propertySet the propertySet to set
*/
public void setPropertySet(PropertySet propertySet) {
this.propertySet = propertySet;
}
/*
* (non-Javadoc)
* @see
* com.holonplatform.vaadin.data.DatastoreDataProvider#addQueryConfigurationProvider(com.holonplatform.core.query.
* QueryConfigurationProvider)
*/
@Override
public Registration addQueryConfigurationProvider(QueryConfigurationProvider queryConfigurationProvider) {
ObjectUtils.argumentNotNull(queryConfigurationProvider, "QueryConfigurationProvider must be not null");
queryConfigurationProviders.add(queryConfigurationProvider);
return () -> queryConfigurationProviders.remove(queryConfigurationProvider);
}
/*
* (non-Javadoc)
* @see com.vaadin.data.provider.AbstractBackEndDataProvider#sizeInBackEnd(com.vaadin.data.provider.Query)
*/
@Override
protected int sizeInBackEnd(Query query) {
return Long.valueOf(buildQuery(query, false).count()).intValue();
}
/*
* (non-Javadoc)
* @see com.vaadin.data.provider.AbstractBackEndDataProvider#fetchFromBackEnd(com.vaadin.data.provider.Query)
*/
@Override
protected Stream fetchFromBackEnd(Query query) {
return buildQuery(query, true).stream(getPropertySet());
}
/*
* (non-Javadoc)
* @see com.vaadin.data.provider.DataProvider#getId(java.lang.Object)
*/
@Override
public Object getId(PropertyBox item) {
if (getItemIdentifier().isPresent()) {
return getItemIdentifier().get().getItemId(item);
}
return super.getId(item);
}
/**
* Build a {@link Query} using the Datastore and configuring query filters and sorts.
* @param query Query
* @param withSorts Whether to apply sorts, if any, to query
* @return Query instance
*/
protected com.holonplatform.core.query.Query buildQuery(Query query, boolean withSorts) {
com.holonplatform.core.query.Query q = getDatastore().query();
// target
q.target(getTarget());
// filters
final List filters = new LinkedList<>();
query.getFilter().ifPresent(f -> filters.add(f));
queryConfigurationProviders.forEach(p -> {
QueryFilter qf = p.getQueryFilter();
if (qf != null) {
filters.add(qf);
}
});
QueryFilter.allOf(filters).ifPresent(f -> q.filter(f));
// sorts
if (withSorts) {
final List sorts = new LinkedList<>();
List orders = query.getSortOrders();
if (orders != null && !orders.isEmpty()) {
orders.forEach(o -> sorts.add(fromOrder(getPropertySet(), o)));
}
queryConfigurationProviders.forEach(p -> {
QuerySort qs = p.getQuerySort();
if (qs != null) {
sorts.add(qs);
}
});
if (!sorts.isEmpty()) {
if (sorts.size() == 1) {
q.sort(sorts.get(0));
} else {
q.sort(QuerySort.of(sorts));
}
}
}
// parameters
queryConfigurationProviders.forEach(p -> {
ParameterSet parameters = p.getQueryParameters();
if (parameters != null) {
parameters.forEachParameter((n, v) -> q.parameter(n, v));
}
});
// paging
if (query.getLimit() < Integer.MAX_VALUE) {
q.limit(query.getLimit());
q.offset(query.getOffset());
}
return q;
}
private static QuerySort fromOrder(PropertySet set, QuerySortOrder order) {
Path path = getPathByName(set, order.getSorted()).orElseThrow(() -> new IllegalArgumentException(
"No property of the set matches with sort name: " + order.getSorted()));
SortDirection direction = (order.getDirection() != null
&& order.getDirection() == com.vaadin.shared.data.sort.SortDirection.DESCENDING)
? SortDirection.DESCENDING
: SortDirection.ASCENDING;
return QuerySort.of(path, direction);
}
@SuppressWarnings({ "unchecked", "rawtypes" })
private static Optional> getPathByName(PropertySet set, String propertyName) {
if (set != null && propertyName != null) {
return set.stream().filter(p -> Path.class.isAssignableFrom(p.getClass()))
.filter(p -> propertyName.equals(((Path) p).getName())).findFirst();
}
return Optional.empty();
}
/**
* Default {@link Builder} implementation.
*/
public static class DefaultBuilder implements Builder {
private final DefaultDatastoreDataProvider instance = new DefaultDatastoreDataProvider();
private final List> properties = new LinkedList<>();
/*
* (non-Javadoc)
* @see com.holonplatform.vaadin.data.DatastoreDataProvider.Builder#datastore(com.holonplatform.core.datastore.
* Datastore)
*/
@Override
public Builder datastore(Datastore datastore) {
ObjectUtils.argumentNotNull(datastore, "Datastore must be not null");
instance.setDatastore(datastore);
return this;
}
/*
* (non-Javadoc)
* @see com.holonplatform.vaadin.data.DatastoreDataProvider.Builder#target(com.holonplatform.core.datastore.
* DataTarget)
*/
@Override
public Builder target(DataTarget target) {
ObjectUtils.argumentNotNull(target, "DataTarget must be not null");
instance.setTarget(target);
return this;
}
/*
* (non-Javadoc)
* @see
* com.holonplatform.vaadin.data.DatastoreDataProvider.Builder#itemIdentifier(com.holonplatform.core.property.
* Property)
*/
@Override
public Builder itemIdentifier(Property identifierProperty) {
ObjectUtils.argumentNotNull(identifierProperty, "Identifier property must be not null");
instance.setItemIdentifier(new PropertyItemIdentifier<>(identifierProperty));
return this;
}
/*
* (non-Javadoc)
* @see
* com.holonplatform.vaadin.data.DatastoreDataProvider.Builder#itemIdentifierProvider(com.holonplatform.vaadin.
* data.ItemIdentifierProvider)
*/
@Override
public Builder itemIdentifierProvider(ItemIdentifierProvider itemIdentifierProvider) {
instance.setItemIdentifier(itemIdentifierProvider);
return this;
}
/*
* (non-Javadoc)
* @see com.holonplatform.vaadin.data.DatastoreDataProvider.Builder#withProperties(java.lang.Iterable)
*/
@SuppressWarnings("rawtypes")
@Override
public Builder withProperties(Iterable
properties) {
ObjectUtils.argumentNotNull(properties, "Properties must be not null");
properties.forEach(p -> this.properties.add(p));
return this;
}
/*
* (non-Javadoc)
* @see
* com.holonplatform.vaadin.data.DatastoreDataProvider.Builder#withQueryConfigurationProvider(com.holonplatform.
* core.query.QueryConfigurationProvider)
*/
@Override
public Builder withQueryConfigurationProvider(QueryConfigurationProvider queryConfigurationProvider) {
ObjectUtils.argumentNotNull(queryConfigurationProvider, "QueryConfigurationProvider must be not null");
instance.addQueryConfigurationProvider(queryConfigurationProvider);
return this;
}
/*
* (non-Javadoc)
* @see com.holonplatform.vaadin.data.DatastoreDataProvider.Builder#build()
*/
@Override
public DatastoreDataProvider build() {
instance.setPropertySet(PropertySet.of(this.properties));
return instance;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy