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

comparison src/main/java/de/intevation/lada/data/importer/LAFWriter.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	bc6d0785986f

comparison

equal deleted inserted replaced

-:fab80595ed55
+:567ce7697fc7
 import de.intevation.lada.model.LProbe;
 import de.intevation.lada.model.Ort;
 import de.intevation.lada.validation.ValidationException;
 import de.intevation.lada.validation.Validator;
+/**
+* Writer to persist new entities in the database.
+*
+* @author <a href="mailto:rrenkert@intevation.de">Raimund Renkert</a>
+*/
 @Named("lafwriter")
 public class LAFWriter
 implements Writer
 {
 @Inject
 private Repository messwertRepository;
 private List<ReportData> errors;
 private List<ReportData> warnings;
+/**
+* Default constructor.
+*/
 public LAFWriter() {
 errors = new ArrayList<ReportData>();
 warnings = new ArrayList<ReportData>();
 }
+/**
+* Write a new {@link LProbe} object to the database using
+* authorization and validation.
+*
+* @param auth      The authentication information.
+* @param probe     The new {@link LProbe} object.
+* @return success
+*/
 @Override
 public boolean writeProbe(AuthenticationResponse auth, LProbe probe) {
 if (!authorized(probe, auth)) {
 errors.add(new ReportData("auth", "not authorized", 699));
 return false;
 }
 persist(probe);
 return true;
 }
+/**
+* Write new {@link LMessung} objects to the database using
+* authorization and validation.
+*
+* @param auth      The authentication information.
+* @param messungen The new {@link LMessung} objects.
+* @return success
+*/
 @Override
 public boolean writeMessungen(
 AuthenticationResponse auth,
 List<LMessung> messungen
 ) {
 }
 return true;
 }
+/**
+* Write new {@link Ort} objects to the database.
+*
+* @param auth      The authentication information.
+* @param orte      List of {@link Ort} objects.
+* @return success
+*/
 @Override
 public boolean writeOrte(AuthenticationResponse auth, List<Ort> orte) {
 for (Ort ort :orte) {
 ortRepository.create(ort);
 }
 return true;
 }
+/**
+* Write new {@link LOrt} objects to the database using validation.
+*
+* @param auth  The authentication information.
+* @param orte  List of {@link LOrt} objects.
+* @return success
+*/
 @Override
 public boolean writeLOrte(AuthenticationResponse auth, List<LOrt> orte) {
 for(LOrt ort: orte) {
 try {
 Map<String, Integer> warn =
 }
 }
 return true;
 }
+/**
+* Write new {@link LKommentarP} objects to the database.
+*
+* @param auth          The authentication information.
+* @param kommentare    List of {@link LKommentarP} objects.
+* @return success
+*/
 @Override
 public boolean writeProbenKommentare(
 AuthenticationResponse auth,
 List<LKommentarP> kommentare
 ) {
 pKommentarRepository.create(kommentar);
 }
 return true;
 }
+/**
+* Write new {@link LKommentarM} objects to the database.
+*
+* @param auth          The authentication information.
+* @param kommentare    List of {@link LKommentarM} objects.
+* @return success
+*/
 @Override
 public boolean writeMessungKommentare(
 AuthenticationResponse auth,
 List<LKommentarM> kommentare
 ) {
 mKommentarRepository.create(kommentar);
 }
 return true;
 }
+/**
+* Write new {@link LMesswert} objects to the database using validation.
+*
+* @param auth      The authentication information.
+* @param werte     List of {@link LMesswert} objects.
+* @return success
+*/
 @Override
 public boolean writeMesswerte(
 AuthenticationResponse auth,
 List<LMesswert> werte
 ) {
 }
 }
 return false;
 }
+/**
+* Persist a {@link LProbe} object.
+*
+* @param probe The {@link LProbe} object.
+*/
 @TransactionAttribute(TransactionAttributeType.REQUIRED)
 private void persist(LProbe probe) {
 String queryColumns = "insert into l_probe (probe_id, ba_id, test," +
 " datenbasis_id, netzbetreiber_id, mst_id, probenart_id, umw_id";
 String queryParameter = " values (:probe_id, :ba_id, :test," +
 insert.setParameter("solldatum_ende", probe.getSolldatumEnde());
 }
 insert.executeUpdate();
 }
+/**
+* Check if the user given in the authentication information is authorized
+* to access the {@link LProbe} object.
+*
+* @param probe The {@link LProbe} object.
+* @param auth  The authentication information.
+* @return access
+*/
 private boolean authorized(LProbe probe, AuthenticationResponse auth) {
 if (auth.getNetzbetreiber().contains(probe.getNetzbetreiberId()) &&
 auth.getMst().contains(probe.getMstId())) {
 return true;
 }
 */
 public List<ReportData> getWarnings() {
 return warnings;
 }
+/**
+* Reset the errors and warnings.
+*/
 public void reset() {
 this.warnings = new ArrayList<ReportData>();
 this.errors = new ArrayList<ReportData>();
 }
 }

Mercurial > lada > lada-server

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