Mercurial > lada > lada-server

annotate src/main/java/de/intevation/lada/data/importer/EntryFormat.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 821557a17e5e
children 183f8116d9a6
rev   line source
310
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
1 package de.intevation.lada.data.importer;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
2
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
3 import java.util.regex.Pattern;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
4
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
5 /**
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
6 * An EntryFormat describes the internal structure of LAF-based key-value pairs.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
7 * The pattern is a regular expression used to match the value in the LAF
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
8 * importer.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
9 * The entry formats are defined in a config file
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
10 * (see wiki-doc: https://bfs-intern.intevation.de/Server/Importer).
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
11 * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
12 */
310
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
13 public class EntryFormat
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
14 {
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
15 private String key;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
16 private Pattern pattern;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
17 private Object defaultValue;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
18
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
19 /**
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
20 * Default constructor to create a new EntryFormat object.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
21 */
310
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
22 public EntryFormat() {
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
23 }
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
24
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
25 /**
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
26 * @return the key.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
27 */
310
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
28 public String getKey() {
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
29 return key;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
30 }
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
31
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
32 /**
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
33 * @param key The key to set.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
34 */
310
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
35 public void setKey(String key) {
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
36 this.key = key;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
37 }
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
38
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
39 /**
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
40 * @return the pattern
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
41 */
310
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
42 public Pattern getPattern() {
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
43 return pattern;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
44 }
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
45
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
46 /**
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
47 * @param pattern The pattern to set.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
48 */
310
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
49 public void setPattern(Pattern pattern) {
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
50 this.pattern = pattern;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
51 }
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
52
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
53 /**
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
54 * @return the default value.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
55 */
310
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
56 public Object getDefaultValue() {
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
57 return defaultValue;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
58 }
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
59
366
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
60 /**
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
61 * @param defaultValue the default value to set.
567ce7697fc7 Code documentation.
Raimund Renkert <rrenkert@intevation.de>
parents: 310
diff changeset
62 */
310
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
63 public void setDefaultValue(Object defaultValue) {
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
64 this.defaultValue = defaultValue;
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
65 }
821557a17e5e First version of the LAF importer.
Raimund Renkert <rrenkert@intevation.de>
parents:
diff changeset
66 }
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)