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.contentapp;
35
36 import java.util.HashMap;
37 import java.util.Map;
38
39 /**
40 * Generic definition of a data filter. Allows to configure
41 * filters by single properties, by item path and also by
42 * a full text search statement.
43 *
44 * @param <DS> datasource definition type.
45 */
46 public class DataFilter<DS> {
47
48 private final Map<String, Object> propertyFilters = new HashMap<>();
49
50 private DS dataSourceDefinition;
51
52 private String pathFilter = "";
53
54 private String fullTextSearchStatement = "";
55
56 private FilteringMode filteringMode = FilteringMode.OFF;
57
58 private Object value;
59
60 public void filter(String property, Object value) {
61 this.propertyFilters.put(property, value);
62 }
63
64 public void setFullTextSearchStatement(String fullTextSearchStatement) {
65 this.fullTextSearchStatement = fullTextSearchStatement;
66 }
67
68 public String getFullTextSearchStatement() {
69 return fullTextSearchStatement;
70 }
71
72 public Map<String, Object> getPropertyFilters() {
73 return propertyFilters;
74 }
75
76 public String getPathFilter() {
77 return pathFilter;
78 }
79
80 public void setPathFilter(String pathFilter) {
81 this.pathFilter = pathFilter;
82 }
83
84 public DS getDataSourceDefinition() {
85 return dataSourceDefinition;
86 }
87
88 public void setDataSourceDefinition(DS dataSourceDefinition) {
89 this.dataSourceDefinition = dataSourceDefinition;
90 }
91
92 public void setFilteringMode(FilteringMode filteringMode) {
93 this.filteringMode = filteringMode;
94 }
95
96 public FilteringMode getFilteringMode() {
97 return filteringMode;
98 }
99
100 public void setValue(Object value) {
101 this.value = value;
102 }
103
104 /**
105 * @return value typically coming from a component, e.g. a search term in order to filter a combo box
106 */
107 public Object getValue() {
108 return value;
109 }
110 }