timeBench.data.io.schema.StringInstantEncoding 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.DateFormat;
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.calendar.Calendar;
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 StringInstantEncoding extends InstantEncoding {

    @XmlElement(name = "temporal-column", required = true)
    private String temporalColumn;

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

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

    @XmlTransient
    private DateFormat format = null;

    public StringInstantEncoding() {
    }

    public StringInstantEncoding(String key, String temporalColumn,
            String dateTimePattern) {
        super.setKey(key);
        this.temporalColumn = temporalColumn;
        this.dateTimePattern = dateTimePattern;
    }

    @Override
    void init(Calendar calendar) throws TemporalDataException {
        super.init(calendar);
        prepareFormat();
    }

    // lazy
    private DateFormat prepareFormat() {
        if (format == null)
            format = new SimpleDateFormat(dateTimePattern, new Locale(language));
        return format;
    }

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

        try {
            return prepareFormat().parse(tuple.getString(temporalColumn));
        } catch (ParseException e) {
            throw new TemporalDataException(
                    "import temporal element failed could not parse \""
                            + tuple.getString(temporalColumn)
                            + "\" using pattern \"" + this.dateTimePattern
                            + "\"");
        }
    }
}