smile.data.DateAttribute Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openchemlib Show documentation
Open Source Chemistry Library
There is a newer version: 2024.11.2
/*******************************************************************************
 * Copyright (c) 2010 Haifeng Li
 *   
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *  
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
package smile.data;

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

/**
 * Data attribute. The default format string accepts the ISO-8601 combined date
 * and time format: "yyyy-MM-dd'T'HH:mm:ss".
 *
 * @author Haifeng Li
 */
public class DateAttribute extends Attribute {

    /**
     * Date string format.
     */
    private DateFormat format;

    /**
     * Constructor.
     */
    public DateAttribute(String name) {
        this(name, 1.0);
    }

    /**
     * Constructor.
     */
    public DateAttribute(String name, double weight) {
        this(name, null, weight);
    }

    /**
     * Constructor.
     */
    public DateAttribute(String name, String description, double weight) {
        super(Type.DATE, name, description, weight);
        format = new SimpleDateFormat();
    }

    /**
     * Constructor.
     * @param name the name of attribute.
     * @param format the date format.
     */
    public DateAttribute(String name, String description, String format) {
        super(Type.DATE, name, description);
        this.format = new SimpleDateFormat(format);
    }

    /**
     * Constructor.
     * @param name the name of attribute.
     * @param format the date format.
     */
    public DateAttribute(String name, String description, double weight, String format) {
        super(Type.DATE, name, description, weight);
        this.format = new SimpleDateFormat(format);
    }

    /**
     * Returns the date string formatter.
     * @return the date string formatter.
     */
    public DateFormat getFormat() {
        return format;
    }
    
    /**
     * Sets the date format.
     * @param format the date format string.
     */
    public void setFormat(String format) {
        this.format = new SimpleDateFormat(format);
    }
    
    /**
     * Sets the date string formatter.
     * @param format the date string formatter.
     */
    public void setFormat(DateFormat format) {
        this.format = format;
    }
    
    /**
     * Generate the date string.
     */
    public String toString(Date date) {
        return format.format(date);
    }

    /**
     * Retruns the date object from internal double encoding.
     * @param x the date in double encoding.
     */
    public Date toDate(double x) {
        if (Double.isNaN(x)) {
            return null;
        }

        return new Date(Double.doubleToRawLongBits(x));
    }

    /**
     * Returns the double value representation of a data object.
     */
    public double valueOf(Date date) {
        return Double.longBitsToDouble(date.getTime());
    }
    
    @Override
    public String toString(double x) {
        if (Double.isNaN(x)) {
            return null;
        }
        
        return format.format(Double.doubleToRawLongBits(x));
    }

    @Override
    public double valueOf(String s) throws ParseException {
        Date d = format.parse(s);
        return Double.longBitsToDouble(d.getTime());
    }
}