[feature] Add xs:dateTimeStamp implementation.

Author: rhubner

exist-core/src/main/java/org/exist/xquery/functions/fn/FunCurrentDateTime.java

@@ -32,7 +32,7 @@
 import org.exist.xquery.Profiler;
 import org.exist.xquery.XPathException;
 import org.exist.xquery.XQueryContext;
-import org.exist.xquery.value.DateTimeValue;
+import org.exist.xquery.value.DateTimeStampValue;
 import org.exist.xquery.value.FunctionReturnSequenceType;
 import org.exist.xquery.value.Item;
 import org.exist.xquery.value.Sequence;
@@ -48,12 +48,11 @@ public class FunCurrentDateTime extends Function {
     public final static FunctionSignature fnCurrentDateTime =
         new FunctionSignature(
             new QName("current-dateTime", Function.BUILTIN_FUNCTION_NS),
-            "Returns the xs:dateTime (with timezone) that is current at some time " +
+            "Returns the xs:dateTimeStamp (with timezone) that is current at some time " +
             "during the evaluation of a query or transformation in which " +
             "fn:current-dateTime() is executed.",
             null,
-            //should be xs:dateTimeStamp, need to add support for DATE_TIME_STAMP
-            new FunctionReturnSequenceType(Type.DATE_TIME,
+            new FunctionReturnSequenceType(Type.DATE_TIME_STAMP,
                 Cardinality.EXACTLY_ONE, "the date-time current " +
                     "within query execution time span"));
 
@@ -95,7 +94,7 @@ public Sequence eval(Sequence contextSequence, Item contextItem) throws XPathExc
                 {context.getProfiler().message(this, Profiler.START_SEQUENCES,
                     "CONTEXT ITEM", contextItem.toSequence());}
         }
-        Sequence result = new DateTimeValue(context.getCalendar());
+        Sequence result = new DateTimeStampValue(context.getCalendar());
         if (isCalledAs("current-dateTime")) {
             // do nothing, result already in right form
         } else if (isCalledAs("current-date")) {

exist-core/src/main/java/org/exist/xquery/value/DateTimeStampValue.java

@@ -0,0 +1,53 @@
+package org.exist.xquery.value;
+
+import org.exist.xquery.ErrorCodes;
+import org.exist.xquery.XPathException;
+
+import javax.xml.XMLConstants;
+
+import javax.xml.datatype.DatatypeConstants;
+import javax.xml.datatype.XMLGregorianCalendar;
+import javax.xml.namespace.QName;
+
+public class DateTimeStampValue extends DateTimeValue {
+
+    private static final QName XML_SCHEMA_TYPE = new QName(XMLConstants.W3C_XML_SCHEMA_NS_URI, "dateTimeStamp");
+
+    public DateTimeStampValue(XMLGregorianCalendar calendar) throws XPathException {
+        super(calendar);
+        checkValidTimezone();
+    }
+
+    public DateTimeStampValue(String dateTime) throws XPathException {
+        super(dateTime);
+        checkValidTimezone();
+    }
+
+    private void checkValidTimezone() throws XPathException {
+        if(calendar.getTimezone() == DatatypeConstants.FIELD_UNDEFINED) {
+            throw new XPathException(ErrorCodes.ERROR, "Unable to create xs:dateTimeStamp, timezone missing.");
+        }
+    }
+
+    @Override
+    public AtomicValue convertTo(int requiredType) throws XPathException {
+        switch (requiredType) {
+            case Type.DATE_TIME_STAMP:
+                return this;
+            case Type.DATE_TIME:
+                return new DateTimeValue(calendar);
+            default: return
+                    super.convertTo(requiredType);
+        }
+    }
+
+    @Override
+    public int getType() {
+        return Type.DATE_TIME_STAMP;
+    }
+
+    @Override
+    protected QName getXMLSchemaType() {
+        return XML_SCHEMA_TYPE;
+    }
+}

exist-core/src/main/java/org/exist/xquery/value/DateTimeValue.java

@@ -115,6 +115,8 @@ public AtomicValue convertTo(int requiredType) throws XPathException {
             case Type.ATOMIC:
             case Type.ITEM:
                 return this;
+            case Type.DATE_TIME_STAMP:
+                return new DateTimeStampValue(calendar);
             case Type.DATE:
                 return new DateValue(calendar);
             case Type.TIME:

exist-core/src/main/java/org/exist/xquery/value/Type.java

@@ -91,6 +91,7 @@ public class Type {
     public final static int GDAY = 58;
     public final static int GYEARMONTH = 59;
     public final static int GMONTHDAY = 71;
+    public final static int DATE_TIME_STAMP = 72;
     public final static int TOKEN = 60;
     public final static int NORMALIZED_STRING = 61;
     public final static int LANGUAGE = 62;
@@ -158,7 +159,7 @@ public class Type {
         defineSubType(ATOMIC, UNTYPED_ATOMIC);
 
         // DATE_TIME sub-types
-        //defineSubType(DATE_TIME, DATE_TIME_STAMP);
+        defineSubType(DATE_TIME, DATE_TIME_STAMP);
 
         // DURATION sub-types
         defineSubType(DURATION, DAY_TIME_DURATION);
@@ -285,8 +286,7 @@ public class Type {
         defineBuiltInType(HEX_BINARY, "xs:hexBinary");
         defineBuiltInType(NOTATION, "xs:NOTATION");
 
-        //TODO add handling for xs:dateTimeStamp
-        //defineBuiltInType(DATE_TIME_STAMP, "xs:dateTimeStamp");
+        defineBuiltInType(DATE_TIME_STAMP, "xs:dateTimeStamp");
         defineBuiltInType(DATE_TIME, "xs:dateTime");
         defineBuiltInType(DATE, "xs:date");
         defineBuiltInType(TIME, "xs:time");
@@ -355,7 +355,7 @@ public class Type {
                 DAY_TIME_DURATION
         });
         definePrimitiveType(DATE_TIME, new int[] {
-                //DATE_TIME_STAMP
+                DATE_TIME_STAMP
         });
         definePrimitiveType(TIME);
         definePrimitiveType(DATE);

exist-core/src/main/java/org/exist/xquery/value/UntypedAtomicValue.java

@@ -106,6 +106,8 @@ TODO replace UntypedAtomicValue with something that can allow lazily reading tex
 
             case Type.DATE_TIME:
                 return new DateTimeValue(value);
+            case Type.DATE_TIME_STAMP:
+                return new DateTimeStampValue(value);
             case Type.TIME:
                 return new TimeValue(value);
             case Type.DATE:

exist-core/src/test/java/org/exist/xquery/value/DateTimeStampTest.java

@@ -0,0 +1,62 @@
+/*
+ * eXist-db Open Source Native XML Database
+ * Copyright (C) 2001 The eXist-db Authors
+ *
+ * [email protected]
+ * http://www.exist-db.org
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+package org.exist.xquery.value;
+
+import org.exist.xquery.XPathException;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+public class DateTimeStampTest extends AbstractTimeRelatedTestCase {
+
+
+    @Test(expected = XPathException.class)
+    public void crate1() throws XPathException {
+        new DateTimeStampValue("2005-10-11T10:00:00");
+    }
+
+    @Test
+    public void convert1() throws XPathException {
+        DateTimeValue dateTimeValue = new DateTimeValue("2005-10-11T10:00:00Z");
+        AtomicValue value = dateTimeValue.convertTo(Type.DATE_TIME_STAMP);
+        assertEquals(DateTimeStampValue.class, value.getClass());
+    }
+
+    @Test(expected = XPathException.class)
+    public void convert2() throws XPathException {
+        DateTimeValue dateTimeValue = new DateTimeValue("2005-10-11T10:00:00");
+        AtomicValue value = dateTimeValue.convertTo(Type.DATE_TIME_STAMP);
+        assertEquals(DateTimeStampValue.class, value.getClass());
+    }
+
+    @Test()
+    public void getTimezone1() throws XPathException {
+        DateTimeStampValue value = new DateTimeStampValue("2005-10-11T10:00:00+10:00");
+        assertEquals(10 * 60, value.calendar.getTimezone());
+    }
+
+
+
+
+
+
+}