lada/lada-server: src/main/java/de/intevation/lada/factory/ProbeFactory.java comparison

comparison src/main/java/de/intevation/lada/factory/ProbeFactory.java @ 711:3ec358698b4d

Code style and documentation.

author	Raimund Renkert <raimund.renkert@intevation.de>
date	Wed, 22 Jul 2015 16:03:03 +0200
parents	e502e1af6256
children	d8e421d9d7ec

comparison

equal deleted inserted replaced

-:2ae27dde4823
+:3ec358698b4d
 createProben(interval, messprogramm, proben);
 }
 return proben;
 }
+/**
+* Create LProbe objects using the interval and messprogramm details.
+*
+* @param   interval        The time interval for probe objects.
+* @param   messprogramm    The messprogramm containing details.
+* @param   proben          An (empty) list for probe objects filled by this
+*                          method
+* @return
+*/
 private void createProben(
 Date[] interval,
 Messprogramm messprogramm,
 List<LProbe> proben
 ) {
 int intervalDays = parseInterval(messprogramm.getProbenintervall());
 int teilStart = messprogramm.getTeilintervallVon() + startDay;
 int teilEnd = messprogramm.getTeilintervallBis() + startDay;
 int offset = messprogramm.getIntervallOffset() == null ? 0 : messprogramm.getIntervallOffset();
-for (;
+for (;teilStart >= startDay + offset && teilEnd <= endDay + offset;) {
-teilStart >= startDay + offset && teilEnd <= endDay + offset;) {
 start.add(Calendar.DATE, teilStart - startDay + offset);
 Date startDate = start.getTime();
 end.add(Calendar.DATE, teilEnd - endDay + offset);
 Date endDate = end.getTime();
 LProbe probe = createObjects(messprogramm, startDate, endDate);
 start.setTime(interval[0]);
 }
 return;
 }
+/**
+* Create a single probe object.
+*
+* @param   messprogramm    The messprogramm containing probe details
+* @param   startDate       The date for 'solldatumbeginn'
+* @param   endDate         The date for 'solldatumende'
+*
+* @return The new probe object.
+*/
 private LProbe createObjects(
 Messprogramm messprogramm,
 Date startDate,
 Date endDate
 ) {
 probe =
 (LProbe)repository.getById(LProbe.class, probe.getId(), "land").getData();
 return probe;
 }
+/**
+* Determine the interval for probe generation using a start date, end date
+* and the messprogramm.
+*
+* @param   start   Calendar object defining the start of the first interval
+* @param   end     Calendar object defining the end of the last interval.
+* @param   messprogramm    The messprogramm
+*
+* @return An array of start/end pairs.
+*/
 private Date[][] calculateIntervals(
 Calendar start,
 Calendar end,
 Messprogramm messprogramm
 ) {
 }
 return intervals;
 }
+/**
+* Parse an interval string.
+* Posible values are: J, H, Q, M, W4, W2, W, T
+*
+* @param   interval    the interval string.
+*
+* @return the amount of days for the given interval.
+*/
 private int parseInterval(String interval) {
 if ("J".equals(interval)) {
 return 365;
 }
 else if ("H".equals(interval)) {
 else {
 return 0;
 }
 }
+/**
+* Search for the umwelt id using the 'deskriptor'.
+*
+* @param   probe   The probe object.
+*
+* @return The updated probe object.
+*/
 public LProbe findUmweltId(LProbe probe) {
 String[] mediaDesk = probe.getMediaDesk().split(" ");
 if (mediaDesk.length <= 1) {
 return probe;
 }
 probe.setUmwId(findUmwelt(mediaDesk));
 return probe;
 }
+/**
+* Search for the media description using the 'deskriptor'.
+*
+* @param   probe   The probe object
+*
+* @return The updated probe object.
+*/
 public LProbe findMediaDesk(LProbe probe) {
-	probe.setMedia(repository
+probe.setMedia(repository
-	.queryFromString("SELECT get_media_from_media_desk( :mediaDesk );", "stamm")
+.queryFromString("SELECT get_media_from_media_desk( :mediaDesk );", "stamm")
-	.setParameter("mediaDesk", probe.getMediaDesk())
+.setParameter("mediaDesk", probe.getMediaDesk())
-	.getSingleResult()
+.getSingleResult()
-	.toString());
+.toString());
 return probe;
 }
+/**
+* Search for the umwelt id using the 'deskriptor'.
+*
+* @param   messprogramm    The messprogramm
+*
+* @return The updated messprogramm.
+*/
 public Messprogramm findUmweltId(Messprogramm messprogramm) {
 String[] mediaDesk = messprogramm.getMediaDesk().split(" ");
 if (mediaDesk.length <= 1) {
 return messprogramm;
 }
 messprogramm.setUmwId(findUmwelt(mediaDesk));
 return messprogramm;
 }
+/**
+* Find the umwelt id for a given deskriptor.
+*
+* @param   mediaDesk   The deskriptor string
+*
+* @return The umwelt id or an empty string.
+*/
 private String findUmwelt(String[] mediaDesk) {
 List<Integer> mediaIds = new ArrayList<Integer>();
 boolean zebs = false;
 Integer parent = null;
 Integer hdParent = null;
 }
 }
 return getUmwelt(mediaIds, zebs);
 }
+/**
+* Find the umwelt id in the database using media deskriptor ids.
+*
+* @param   media   The list of media ids.
+* @param   isZebs  Flag for type of the deskriptor.
+*
+* @return The umwelt id or an empty string.
+*/
 private String getUmwelt(List<Integer> media, boolean isZebs) {
 QueryBuilder<DeskriptorUmwelt> builder =
 new QueryBuilder<DeskriptorUmwelt>(
 repository.entityManager("stamm"), DeskriptorUmwelt.class);
 }
 return "";
 }
 }
+/**
+* Determine if the entries in the list have the same umwelt id.
+*
+* @param   list    A list of DescriptorUmwelt objects.
+*
+* @return true if the objects have the same umwelt id else false.
+*/
 private boolean isUnique(List<DeskriptorUmwelt> list) {
 if (list.isEmpty()) {
 return false;
 }
 String element = list.get(0).getUmwId();

Mercurial > lada > lada-server

comparison src/main/java/de/intevation/lada/factory/ProbeFactory.java @ 711:3ec358698b4d