[Tynstep-svn] r204 - trunk/step-dataloader/src/main/java/com/tyndalehouse/step/dataloader/common

[ChrisBurrell at crosswire.org]

Author: ChrisBurrell
Date: 2011-01-22 13:05:20 -0700 (Sat, 22 Jan 2011)
New Revision: 204

Added:
   trunk/step-dataloader/src/main/java/com/tyndalehouse/step/dataloader/common/PartialDate.java
   trunk/step-dataloader/src/main/java/com/tyndalehouse/step/dataloader/common/PrecisionType.java
Log:
adding missed files


Added: trunk/step-dataloader/src/main/java/com/tyndalehouse/step/dataloader/common/PartialDate.java
===================================================================
--- trunk/step-dataloader/src/main/java/com/tyndalehouse/step/dataloader/common/PartialDate.java	                        (rev 0)
+++ trunk/step-dataloader/src/main/java/com/tyndalehouse/step/dataloader/common/PartialDate.java	2011-01-22 20:05:20 UTC (rev 204)
@@ -0,0 +1,137 @@
+package com.tyndalehouse.step.core.data.common;
+
+import static java.lang.Integer.parseInt;
+import static org.apache.commons.lang.StringUtils.isEmpty;
+import static org.apache.commons.lang.StringUtils.split;
+
+import java.util.Calendar;
+import java.util.GregorianCalendar;
+
+import org.apache.commons.lang.StringUtils;
+
+import com.tyndalehouse.step.core.exceptions.StepInternalException;
+
+/**
+ * This class is the way dates are represented in the databased and they should be parsed back into this
+ * object on their way out!
+ * 
+ * The date field indicates when the event (or start of the event) took place, the precision type indicates
+ * whether how much of the date can be trusted...
+ * 
+ * This means we can store dates such as (01/03/1900, MONTH), meaning March 1900 (and not 1st March 1900).
+ * 
+ * @author CJBurrell
+ */
+public class PartialDate {
+    private static final String DATE_DELIMITER = " -";
+    private static final int NO_PARTS = 0;
+    private static final int YEAR = 1;
+    private static final int YEAR_AND_MONTH = 2;
+    private static final int YEAR_MONTH_AND_DAY = 3;
+
+    /**
+     * The date to be represented (whether fully accurate or not)
+     */
+    private final Calendar c;
+
+    /**
+     * The precision specifier which tells us just quite how accurate the date is (year, month, day)
+     * 
+     * @see com.tyndalehouse.step.dataloader.common.PrecisionType
+     */
+    private final PrecisionType precision;
+
+    /**
+     * Public constructor to give us a partial date.
+     * 
+     * @param c date partial reprentation of a date
+     * @param precision precision indicating how much of the date can be trusted day/month/year or month/year
+     *            or just year
+     */
+    public PartialDate(final Calendar c, final PrecisionType precision) {
+        this.c = c;
+        this.precision = precision;
+    }
+
+    /**
+     * Date is specified in yy-mm-dd or yyyy-mm-dd and gets parsed in to a date. the mm and dd are optional
+     * which is what determines the precision of the date.
+     * 
+     * @param date date to be parsed as a string
+     * @return a PartialDate
+     */
+    public static PartialDate parseDate(final String date) {
+        // if passed in empty, return null and be done with empty strings!
+        final String trimmedDate = StringUtils.trim(date);
+        if (isEmpty(trimmedDate)) {
+            return new PartialDate(null, PrecisionType.NONE);
+        }
+
+        final boolean negativeDate = date.charAt(0) == '-';
+        final String parseableDate = negativeDate ? trimmedDate.substring(1) : trimmedDate;
+
+        try {
+            return getPartialDateFromArray(split(parseableDate.trim(), DATE_DELIMITER), negativeDate);
+        } catch (final StepInternalException e) {
+            throw new StepInternalException("Unable to parse " + date, e);
+        }
+    }
+
+    /**
+     * Depending on the number of parts, it creates a Partial date with year/month/day resolution
+     * 
+     * @param parts the array of parts each representing part of the date
+     * @param negativeDate true if the date is BC
+     * @return the newly created PartialDate
+     */
+    private static PartialDate getPartialDateFromArray(final String[] parts, final boolean negativeDate) {
+        final Calendar c = Calendar.getInstance();
+        PrecisionType p;
+
+        try {
+            // length of field determines how much of the date has been specified
+            switch (parts.length) {
+                case NO_PARTS:
+                    throw new StepInternalException("There weren't enough parts to this date");
+                case YEAR:
+                    // only the year is specified, so use 1st of Jan Year
+                    c.set(parseInt(parts[0]), 1, 1);
+                    p = PrecisionType.YEAR;
+                    break;
+                case YEAR_AND_MONTH:
+                    c.set(parseInt(parts[0]), parseInt(parts[1]), 1);
+                    p = PrecisionType.MONTH;
+                    break;
+                case YEAR_MONTH_AND_DAY:
+                    c.set(parseInt(parts[0]), parseInt(parts[1]), parseInt(parts[2]));
+                    p = PrecisionType.DAY;
+                    break;
+                default:
+                    throw new StepInternalException("Too many parts to the date: ");
+            }
+        } catch (final NumberFormatException nfe) {
+            throw new StepInternalException("Could not parse date into year, month or day.", nfe);
+        }
+
+        c.set(Calendar.HOUR_OF_DAY, 0);
+        c.set(Calendar.MINUTE, 0);
+        if (negativeDate) {
+            c.set(Calendar.ERA, GregorianCalendar.BC);
+        }
+        return new PartialDate(c, p);
+    }
+
+    /**
+     * @return gets the internal date
+     */
+    public Calendar getDate() {
+        return this.c;
+    }
+
+    /**
+     * @return the precision accuracy
+     */
+    public PrecisionType getPrecision() {
+        return this.precision;
+    }
+}

Added: trunk/step-dataloader/src/main/java/com/tyndalehouse/step/dataloader/common/PrecisionType.java
===================================================================
--- trunk/step-dataloader/src/main/java/com/tyndalehouse/step/dataloader/common/PrecisionType.java	                        (rev 0)
+++ trunk/step-dataloader/src/main/java/com/tyndalehouse/step/dataloader/common/PrecisionType.java	2011-01-22 20:05:20 UTC (rev 204)
@@ -0,0 +1,29 @@
+package com.tyndalehouse.step.core.data.common;
+
+/**
+ * Precision type indicating how trustworthy a date is when passed through the system
+ * 
+ * @author Chris
+ * 
+ */
+public enum PrecisionType {
+    /**
+     * This means the associated date is only meaningful until the year
+     */
+    YEAR,
+
+    /**
+     * This means the month and year are to be taken as accurate
+     */
+    MONTH,
+
+    /**
+     * The day, month and year are accurate
+     */
+    DAY,
+
+    /**
+     * No date available so, we'll set to none.
+     */
+    NONE;
+}