lada/lada-server: src/main/java/de/intevation/lada/data/importer/LAFProducer.java comparison

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

Code documentation.

author	Raimund Renkert <rrenkert@intevation.de>
date	Tue, 10 Sep 2013 15:55:54 +0200
parents	d39d3886b97d
children	3d2c53a10ee6

comparison

equal deleted inserted replaced

-:fab80595ed55
+:567ce7697fc7
 package de.intevation.lada.data.importer;
 import java.util.ArrayList;
 import java.util.HashMap;
-import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
 import javax.inject.Inject;
 import javax.inject.Named;
-import de.intevation.lada.data.QueryBuilder;
 import de.intevation.lada.data.Repository;
 import de.intevation.lada.model.LKommentarM;
 import de.intevation.lada.model.LKommentarMId;
 import de.intevation.lada.model.LKommentarP;
 import de.intevation.lada.model.LMessung;
 import de.intevation.lada.model.LMessungId;
 import de.intevation.lada.model.LMesswert;
 import de.intevation.lada.model.LMesswertId;
 import de.intevation.lada.model.LOrt;
 import de.intevation.lada.model.LProbe;
-import de.intevation.lada.model.LProbe;
 import de.intevation.lada.model.LZusatzWert;
 import de.intevation.lada.model.LZusatzWertId;
 import de.intevation.lada.model.Ort;
-import de.intevation.lada.model.SProbenZusatz;
+/**
+* The LAFProducer creates entity objects form key-value pairs using the
+* AttributeMapper.
+*
+* @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
+*/
 @Named("lafproducer")
 public class LAFProducer
 implements Producer
 {
 private Map<String, List<ReportData>> errors;
 @Inject
 private AttributeMapper mapper;
+/**
+* Default contructor. Initializes the producer and reads the config file
+* using the systemproperty "de.intevation.lada.importconfig".
+*/
 public LAFProducer() {
 this.warnings = new HashMap<String, List<ReportData>>();
 this.errors = new HashMap<String, List<ReportData>>();
 this.probe = new LProbe();
 this.pKommentare = new ArrayList<LKommentarP>();
 probenFormat = format.getFormat("probe");
 messungFormat = format.getFormat("messung");
 ortFormat = format.getFormat("ort");
 }
+/**
+* Add data to the producer.
+* This triggers the producer to create a new object or add data to
+* existing objects.
+*
+* @param key       The key.
+* @param values    The value
+*/
 @Override
 public void addData(String key, Object values)
 throws LAFParserException {
 String lKey = key.toLowerCase();
 if(lKey.equals("probenkommentar")) {
 else if (isValidOrt(lKey, values.toString())) {
 this.ort = mapper.addAttribute(lKey, values, this.ort);
 }
 }
+/**
+* Check if the key is defined in the config file and validate the value
+* using the pattern defined for this key.
+*
+* @param key   The key.
+* @param value The value.
+* @return valid or not.
+*/
 private boolean isValidOrt(String key, String value) {
 for (EntryFormat ef: ortFormat) {
 if (ef.getKey().equals(key.toLowerCase())) {
 if (ef.getPattern().matcher(value).matches()) {
 return true;
 }
 }
 return false;
 }
+/**
+* Check if the key is defined in the config file and validate the value
+* using the pattern defined for this key.
+*
+* @param key   The key.
+* @param value The value.
+* @return valid or not.
+*/
 private boolean isValidMessung(String key, String value) {
 for (EntryFormat ef: messungFormat) {
 if (ef.getKey().equals(key.toLowerCase())) {
 if (ef.getPattern().matcher(value).matches()) {
 return true;
 }
 }
 return false;
 }
+/**
+* Check if the key is defined in the config file and validate the value
+* using the pattern defined for this key.
+*
+* @param key   The key.
+* @param value The value.
+* @return valid or not.
+*/
 private boolean isValidProbe(String key, String value) {
 for (EntryFormat ef: probenFormat) {
 if (ef.getKey().equals(key.toLowerCase())) {
 if (ef.getPattern().matcher(value).matches()) {
 return true;
 }
 }
 return false;
 }
+/**
+* @return the {@link LProbe} entity.
+*/
 @Override
 public LProbe getProbe() {
 return this.probe;
 }
+/**
+* @return List of {@link LMessung} entities.
+*/
 @Override
 public List<LMessung> getMessungen() {
 return this.messungen;
 }
+/**
+* @return List of {@link Ort} entities.
+*/
 @Override
 public List<Ort> getOrte() {
 return this.orte;
 }
+/**
+* @return List of {@link LOrt} entities.
+*/
 @Override
 public List<LOrt> getLOrte() {
 return this.lorte;
 }
+/**
+* @return List of {@link LKommentarP} entities.
+*/
 @Override
 public List<LKommentarP> getProbenKommentare() {
 return this.pKommentare;
 }
+/**
+* @return List of {@link LKommentarM} entities.
+*/
 @Override
 public List<LKommentarM> getMessungsKommentare() {
 return this.mKommentare;
 }
+/**
+* @return List of {@link LMesswert} entities.
+*/
 @Override
 public List<LMesswert> getMesswerte() {
 return this.messwerte;
 }
+/**
+* @return List of {@link LZusatzWert} entities.
+*/
 @Override
 public List<LZusatzWert> getZusatzwerte() {
 return this.zusatzwerte;
 }
+/**
+* Reset errors and warnings.
+*/
 @Override
 public void reset() {
 this.errors = new HashMap<String, List<ReportData>>();
 this.warnings = new HashMap<String, List<ReportData>>();
 this.probe = new LProbe();
 this.mKommentare = new ArrayList<LKommentarM>();
 this.pKommentare = new ArrayList<LKommentarP>();
 mapper.reset();
 }
+/**
+* Add the current {@link LMessung} entity to the List and create a new one.
+*/
 public void newMessung() {
 if (this.messung != null) {
 this.messungen.add(this.messung);
 }
 LMessungId id = new LMessungId();
 this.messung = new LMessung();
 this.messung.setProbeId(this.probe.getProbeId());
 this.messung.setId(id);
 }
+/**
+* Add the {@link Ort} and {@link LOrt} entities to the lists and create
+* a new {@link OrtCreator}.
+*/
 public void newOrt() {
 if (this.ort != null) {
 Ort o = this.ort.toOrt();
 if (o != null) {
 this.orte.add(o);
 @Override
 public void finishOrt() {
 if (orte.isEmpty()) {
 return;
 }
 }
 }

Mercurial > lada > lada-server

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