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