timeBench.data.io.schema.TwoStringInstantEncoding Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of timebench Show documentation

TimeBench, a flexible, easy-to-use, and reusable software library written in Java that provides foundational data structures and algorithms for time- oriented data in Visual Analytics.

The newest version!

package timeBench.data.io.schema;

import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlTransient;

import prefuse.data.Tuple;
import timeBench.data.TemporalDataException;

/**
 * 
 * Warning: If prefuse has parsed the column as a date it will use the
 * runtime's locale to format the string. Either use {@link DateInstantEncoding}
 * or load the data without a DateParser.
 * 
 * @author Rind
 * 
 */
public class TwoStringInstantEncoding extends InstantEncoding {

    @XmlElement(name = "date-column", required = true)
    private String dateColumn;

    @XmlElement(name = "time-column", required = true)
    private String timeColumn;

    @XmlElement(name = "date-pattern", required = false)
    private String datePattern = "yyyy-MM-dd";

    @XmlElement(name = "time-pattern", required = false)
    private String timePattern = "HH:mm:ss";

    // allow specification of Locale via encoding (e.g. May vs. Mai)
    @XmlElement(required = false)
    private String language = "en";

    @XmlTransient
    private SimpleDateFormat format = null;

    TwoStringInstantEncoding() {
        super();
    }

    public TwoStringInstantEncoding(String key, String dateColumn,
            String timeColumn, String datePattern, String timePattern) {
        super.setKey(key);
        this.dateColumn = dateColumn;
        this.timeColumn = timeColumn;
        this.datePattern = datePattern;
        this.timePattern = timePattern;
    }

    // lazy
    private SimpleDateFormat prepareFormat() {
        if (format == null)
            format = new java.text.SimpleDateFormat(datePattern + "'T'"
                    + timePattern, new Locale(language));
        return format;
    }

    @Override
    protected Date buildDate(Tuple tuple) throws TemporalDataException {
        if (logger.isDebugEnabled())
            logger.debug("prepare temp.e. " + tuple.getString(dateColumn) + " "
                    + tuple.getString(timeColumn));

        String dateTime = tuple.getString(dateColumn) + "T"
                + tuple.getString(timeColumn);
        try {
            return prepareFormat().parse(dateTime);
        } catch (ParseException e) {
            throw new TemporalDataException(
                    "import temporal element failed could not parse \""
                            + dateTime + "\" using pattern \""
                            + format.toPattern() + "\"");
        }
    }
}