View Javadoc
1   /**
2    * This file Copyright (c) 2018 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.ui.datasource.jcr;
35  
36  import info.magnolia.ui.contentapp.preview.JcrPreviewDefinition;
37  import info.magnolia.ui.datasource.BaseDatasourceDefinition;
38  import info.magnolia.ui.datasource.DatasourceType;
39  
40  import java.util.HashSet;
41  import java.util.List;
42  import java.util.Set;
43  
44  import javax.jcr.Item;
45  
46  import org.apache.commons.lang3.StringUtils;
47  
48  import lombok.Getter;
49  import lombok.Setter;
50  
51  /**
52   * Definition of a JCR-based datasource.
53   */
54  @Setter
55  @Getter
56  @DatasourceType("jcrDatasource")
57  public class JcrDatasourceDefinition extends BaseDatasourceDefinition {
58  
59      private String name = "jcr";
60      private String rootPath = "/";
61      private String workspace;
62      private boolean includeProperties;
63      private Set<String> allowedNodeTypes = new HashSet<>();
64      private String describeByProperty;
65      private JcrPreviewDefinition previewDefinition;
66  
67      /**
68       * @return list of properties to order by the data source bound to this definition. If none if specified and {@link #getDescribeByProperty()}
69       * is set, defaults to the latter.
70       */
71      @Override
72      public List<String> getSortByProperties() {
73          if (isSortable() && super.getSortByProperties().isEmpty() && StringUtils.isNotBlank(describeByProperty)) {
74              super.getSortByProperties().add(describeByProperty);
75          }
76          return super.getSortByProperties();
77      }
78  
79      @Override
80      public Class<?> getEntityType() {
81          return Item.class;
82      }
83  }