Mercurial > lada > lada-server

annotate src/main/java/de/intevation/lada/model/query/QueryConfig.java @ 366:567ce7697fc7 0.5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Code documentation.
author Raimund Renkert <rrenkert@intevation.de>
date Tue, 10 Sep 2013 15:55:54 +0200
parents b196ef9d8645
children 183f8116d9a6
rev   line source
296
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
1 package de.intevation.lada.model.query;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
2
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
3 import java.util.List;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
4
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
5 import de.intevation.lada.model.LProbeInfo;
296
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
6
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
7 /**
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
8 * Container for SQL query configuration.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
9 *
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
10 * The server can filter {@link LProbeInfo} objects by configurable SQL queries
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
11 * as described in the project wiki (<link>https://bfs-intern.intevation.de/Server/Suche</link>).
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
12 * This container is used to store the config at runtime.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
13 *
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
14 * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
15 */
296
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
16 public class QueryConfig
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
17 {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
18 int id;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
19 String name;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
20 String description;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
21 String sql;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
22 List<QueryFilter> filters;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
23 List<ResultConfig> results;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
24
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
25 public QueryConfig()
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
26 {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
27 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
28
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
29 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
30 * @return the id
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
31 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
32 public int getId() {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
33 return id;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
34 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
35
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
36 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
37 * @param id the id to set
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
38 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
39 public void setId(int id) {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
40 this.id = id;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
41 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
42
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
43 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
44 * @return the name
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
45 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
46 public String getName() {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
47 return name;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
48 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
49
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
50 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
51 * @param name the name to set
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
52 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
53 public void setName(String name) {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
54 this.name = name;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
55 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
56
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
57 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
58 * @return the description
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
59 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
60 public String getDescription() {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
61 return description;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
62 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
63
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
64 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
65 * @param description the description to set
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
66 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
67 public void setDescription(String description) {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
68 this.description = description;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
69 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
70
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
71 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
72 * @return the sql
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
73 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
74 public String getSql() {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
75 return sql;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
76 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
77
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
78 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
79 * @param sql the sql to set
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
80 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
81 public void setSql(String sql) {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
82 this.sql = sql;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
83 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
84
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
85 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
86 * @return the filter
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
87 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
88 public List<QueryFilter> getFilters() {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
89 return filters;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
90 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
91
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
92 /**
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 296
diff changeset
93 * @param filters the filter to set
296
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
94 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
95 public void setFilters(List<QueryFilter> filters) {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
96 this.filters = filters;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
97 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
98
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
99 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
100 * @return the results
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
101 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
102 public List<ResultConfig> getResults() {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
103 return results;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
104 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
105
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
106 /**
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
107 * @param results the results to set
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
108 */
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
109 public void setResults(List<ResultConfig> results) {
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
110 this.results = results;
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
111 }
b196ef9d8645 New model classes for query configs.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
112 }
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)