001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.progmodel.facets.value;
021
022import java.text.DateFormat;
023import java.util.ArrayList;
024import java.util.List;
025import java.util.Locale;
026import java.util.Map;
027import java.util.TimeZone;
028
029import com.google.common.collect.Maps;
030
031import org.apache.isis.applib.profiles.Localization;
032import org.apache.isis.core.commons.config.ConfigurationConstants;
033import org.apache.isis.core.commons.config.IsisConfiguration;
034import org.apache.isis.core.metamodel.facetapi.FacetHolder;
035import org.apache.isis.core.progmodel.facets.object.value.ValueSemanticsProviderContext;
036
037public abstract class DateAndTimeValueSemanticsProviderAbstract<T> extends ValueSemanticsProviderAbstractTemporal<T> {
038
039    private static Map<String, DateFormat> formats = Maps.newHashMap();
040
041    static {
042        formats.put(ISO_ENCODING_FORMAT, createDateEncodingFormat("yyyyMMdd'T'HHmmssSSS"));
043        formats.put("iso", createDateFormat("yyyy-MM-dd HH:mm"));
044        formats.put("medium", DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.SHORT));
045    }
046
047    private static final Object DEFAULT_VALUE = null; // no default
048    private static final int TYPICAL_LENGTH = 18;
049
050    @SuppressWarnings("unchecked")
051    public DateAndTimeValueSemanticsProviderAbstract(final FacetHolder holder, final Class<T> adaptedClass, final Immutability immutability, final EqualByContent equalByContent, final IsisConfiguration configuration, final ValueSemanticsProviderContext context) {
052        super("datetime", holder, adaptedClass, TYPICAL_LENGTH, immutability, equalByContent, (T) DEFAULT_VALUE, configuration, context);
053
054        final String formatRequired = configuration.getString(ConfigurationConstants.ROOT + "value.format.datetime");
055        if (formatRequired == null) {
056            format = formats().get(defaultFormat());
057        } else {
058            setMask(formatRequired);
059        }
060    }
061
062
063    // //////////////////////////////////////////////////////////////////
064    // temporal-specific stuff
065    // //////////////////////////////////////////////////////////////////
066
067    @Override
068    protected String defaultFormat() {
069        return "medium";
070    }
071
072    @Override
073    protected Map<String, DateFormat> formats() {
074        return formats;
075    }
076
077    @Override
078    protected DateFormat format(final Localization localization) {
079        final DateFormat dateFormat = DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.SHORT, localization.getLocale());
080        dateFormat.setTimeZone(localization.getTimeZone());
081        return dateFormat;
082    }
083
084    @Override
085    public String toString() {
086        return "JavaDateTimeValueSemanticsProvider: " + format;
087    }
088
089    protected List<DateFormat> formatsToTry(Localization localization) {
090        List<DateFormat> formats = new ArrayList<DateFormat>();
091
092        Locale locale = localization == null ? Locale.getDefault() : localization.getLocale();
093        formats.add(DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.LONG, locale));
094        formats.add(createDateFormat("yyyy-MM-dd HH:mm:ss.SSS"));
095        formats.add(createDateFormat("yyyyMMdd'T'HHmmssSSS"));
096        formats.add(DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.SHORT, locale));
097        formats.add(createDateFormat("yyyy-MM-dd HH:mm:ss"));
098        formats.add(DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, locale));
099        formats.add(createDateFormat("yyyyMMdd'T'HHmmss"));
100        formats.add(createDateFormat("yyyy-MM-dd HH:mm"));
101        formats.add(createDateFormat("yyyyMMdd'T'HHmm"));
102        formats.add(createDateFormat("dd-MMM-yyyy HH:mm"));
103
104        for (DateFormat format : formats) {
105            format.setTimeZone(localization == null ? TimeZone.getDefault() : localization.getTimeZone());
106        }
107
108        return formats;
109    }
110
111}