diff src/main/java/de/intevation/lada/data/importer/EntryFormat.java @ 366:567ce7697fc7 0.5

Code documentation.
author Raimund Renkert <rrenkert@intevation.de>
date Tue, 10 Sep 2013 15:55:54 +0200
parents 821557a17e5e
children 183f8116d9a6
line wrap: on
line diff
--- a/src/main/java/de/intevation/lada/data/importer/EntryFormat.java	Tue Sep 10 10:17:32 2013 +0200
+++ b/src/main/java/de/intevation/lada/data/importer/EntryFormat.java	Tue Sep 10 15:55:54 2013 +0200
@@ -2,36 +2,64 @@
 
 import java.util.regex.Pattern;
 
-
+/**
+ * An EntryFormat describes the internal structure of LAF-based key-value pairs.
+ * The pattern is a regular expression used to match the value in the LAF
+ * importer.
+ * The entry formats are defined in a config file
+ * (see wiki-doc: https://bfs-intern.intevation.de/Server/Importer).
+ * @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
+ */
 public class EntryFormat
 {
     private String key;
     private Pattern pattern;
     private Object defaultValue;
 
+    /**
+     * Default constructor to create a new EntryFormat object.
+     */
     public EntryFormat() {
     }
 
+    /**
+     * @return the key.
+     */
     public String getKey() {
         return key;
     }
 
+    /**
+     * @param key The key to set.
+     */
     public void setKey(String key) {
         this.key = key;
     }
 
+    /**
+     * @return the pattern
+     */
     public Pattern getPattern() {
         return pattern;
     }
 
+    /**
+     * @param pattern The pattern to set.
+     */
     public void setPattern(Pattern pattern) {
         this.pattern = pattern;
     }
 
+    /**
+     * @return the default value.
+     */
     public Object getDefaultValue() {
         return defaultValue;
     }
 
+    /**
+     * @param defaultValue the default value to set.
+     */
     public void setDefaultValue(Object defaultValue) {
         this.defaultValue = defaultValue;
     }
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)