View Javadoc
1   /**
2    * This file Copyright (c) 2019 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.dam.app.data;
35  
36  import info.magnolia.dam.api.AssetProvider;
37  import info.magnolia.dam.api.AssetProviderRegistry;
38  import info.magnolia.dam.api.AssetQuery;
39  import info.magnolia.dam.api.Item;
40  import info.magnolia.ui.filter.DataFilter;
41  
42  import java.util.Iterator;
43  import java.util.Optional;
44  import java.util.Spliterators;
45  import java.util.stream.Stream;
46  import java.util.stream.StreamSupport;
47  
48  import com.vaadin.data.provider.Query;
49  
50  /**
51   * Asset data provider.
52   */
53  public interface AssetDataProvider {
54  
55      String MIME_TYPE = "mimeType";
56      String PATH = "path";
57      String ASSET_PROVIDER = "assetProvider";
58  
59      default Stream<AssetProvider> getProviders(Query<Item, DataFilter> query, AssetProviderRegistry assetProviderRegistry) {
60          return getStream(assetProviderRegistry.getAllProviders())
61                  .filter(assetProvider -> getFilter(query, ASSET_PROVIDER).map(o -> o == assetProvider).orElse(true));
62  
63      }
64  
65      default AssetQuery.Builder getAssetQueryBuilder(Query<Item, DataFilter> query) {
66          final AssetQuery.Builder builder = new AssetQuery.Builder();
67  
68          query.getFilter()
69                  .map(DataFilter::getPropertyFilters)
70                  .ifPresent(stringObjectMap -> stringObjectMap.forEach((propertyName, propertyValue) -> {
71                      switch (propertyName) {
72                      case MIME_TYPE:
73                          builder.withExtension(String.valueOf(propertyValue));
74                          break;
75                      case ASSET_PROVIDER: //resolved in info.magnolia.dam.app.data.AssetDataProvider.getProviders
76                      case PATH: //resolved in info.magnolia.dam.app.data.AssetListDataProvider.fetchFromBackEnd
77                          break;
78                      default:
79                          if (!"".equals(propertyValue)) { //empty text field filter
80                              builder.withProperty(propertyName, propertyValue);
81                          }
82                      }
83                  }));
84  
85          return builder;
86      }
87  
88      default Optional<Object> getFilter(Query<Item, DataFilter> query, String key) {
89          return query.getFilter()
90                  .map(DataFilter::getPropertyFilters)
91                  .map(stringObjectMap -> stringObjectMap.get(key));
92      }
93  
94      default <T> Stream<T> getStream(Iterator<T> iterator) {
95          return StreamSupport.stream(Spliterators.spliteratorUnknownSize(iterator, 0), false);
96      }
97  }