fix #270 - expose bitemporal system time

Author: sammefford

src/main/java/com/marklogic/client/bitemporal/TemporalDescriptor.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2012-2015 MarkLogic Corporation
+ *
+ * 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 com.marklogic.client.bitemporal;
+
+import java.util.Calendar;
+import com.marklogic.client.document.DocumentDescriptor;
+
+public interface TemporalDescriptor extends DocumentDescriptor {
+    /**
+     * Returns the URI identifier for the database document.
+     * @return	the document URI
+     */
+    public String getUri();
+
+    /**
+     * Returns the temporal system time when the document was written or deleted.
+     * @return  the temporal system time
+     */
+    public Calendar getTemporalSystemTime();
+}

src/main/java/com/marklogic/client/bitemporal/TemporalDocumentManager.java

@@ -19,6 +19,7 @@
 import com.marklogic.client.ForbiddenUserException;
 import com.marklogic.client.ResourceNotFoundException;
 import com.marklogic.client.Transaction;
+import com.marklogic.client.bitemporal.TemporalDescriptor;
 import com.marklogic.client.document.DocumentDescriptor;
 import com.marklogic.client.document.DocumentManager;
 import com.marklogic.client.document.DocumentUriTemplate;
@@ -42,9 +43,10 @@ public interface TemporalDocumentManager<R extends AbstractReadHandle, W extends
    * @param transaction	an open transaction under which the document may have been created or deleted
    * @param temporalCollection	the name of the temporal collection existing in the database into
    *    which this document should be written
-   * @return the database uri that identifies the created document
+   * @return the TemporalDescriptor including the database uri that identifies the created document,
+   *    as well as the temporal system time when the document was created
    */
-  public DocumentDescriptor create(DocumentUriTemplate template,
+  public TemporalDescriptor create(DocumentUriTemplate template,
       DocumentMetadataWriteHandle metadataHandle,
       W contentHandle,
       ServerTransform transform,
@@ -65,8 +67,9 @@ public DocumentDescriptor create(DocumentUriTemplate template,
    * @param transaction	an open transaction under which the document may have been created or deleted
    * @param temporalCollection	the name of the temporal collection existing in the database into
    *    which this document should be written
+   * @return the TemporalDescriptor with the temporal system time when the document was written
    */
-  public void write(DocumentDescriptor desc,
+  public TemporalDescriptor write(DocumentDescriptor desc,
       DocumentMetadataWriteHandle metadataHandle,
       W contentHandle,
       ServerTransform transform,
@@ -87,8 +90,9 @@ public void write(DocumentDescriptor desc,
    * @param transaction	an open transaction under which the document may have been created or deleted
    * @param temporalCollection	the name of the temporal collection existing in the database into
    *    which this document should be written
+   * @return the TemporalDescriptor with the temporal system time when the document was written
    */
-  public void write(String docId,
+  public TemporalDescriptor write(String docId,
       DocumentMetadataWriteHandle metadataHandle,
       W contentHandle,
       ServerTransform transform,
@@ -105,8 +109,9 @@ public void write(String docId,
    * @param transaction	an open transaction under which the document may have been created or deleted
    * @param temporalCollection	the name of the temporal collection existing in the database in
    *    which this document should be marked as deleted
+   * @return the TemporalDescriptor with the temporal system time when the document was deleted
    */
-  public void delete(DocumentDescriptor desc,
+  public TemporalDescriptor delete(DocumentDescriptor desc,
       Transaction transaction,
       String temporalCollection)
   throws ResourceNotFoundException, ForbiddenUserException,  FailedRequestException;
@@ -120,8 +125,9 @@ public void delete(DocumentDescriptor desc,
    * @param transaction	an open transaction under which the document may have been created or deleted
    * @param temporalCollection	the name of the temporal collection existing in the database in
    *    which this document should be marked as deleted
+   * @return the TemporalDescriptor with the temporal system time when the document was deleted
    */
-  public void delete(String docId,
+  public TemporalDescriptor delete(String docId,
       Transaction transaction,
       String temporalCollection)
   throws ResourceNotFoundException, ForbiddenUserException,  FailedRequestException;
@@ -139,9 +145,10 @@ public void delete(String docId,
      * @param temporalCollection	the name of the temporal collection existing in the database into
      *    which this document should be written
      * @param systemTime	the application-specified system time with which this document will be marked
-     * @return the database uri that identifies the created document
+     * @return the database uri that identifies the created document,
+     *    as well as the temporal system time when the document was created
      */
-    public DocumentDescriptor create(DocumentUriTemplate template,
+    public TemporalDescriptor create(DocumentUriTemplate template,
         DocumentMetadataWriteHandle metadataHandle,
         W contentHandle,
         ServerTransform transform,
@@ -162,8 +169,9 @@ public DocumentDescriptor create(DocumentUriTemplate template,
      * @param temporalCollection	the name of the temporal collection existing in the database into
      *    which this document should be written
      * @param systemTime	the application-specified system time with which this document will be marked
+     * @return the TemporalDescriptor with the temporal system time when the document was written
      */
-    public void write(DocumentDescriptor desc,
+    public TemporalDescriptor write(DocumentDescriptor desc,
         DocumentMetadataWriteHandle metadataHandle,
         W contentHandle,
         ServerTransform transform,
@@ -184,8 +192,9 @@ public void write(DocumentDescriptor desc,
      * @param temporalCollection	the name of the temporal collection existing in the database into
      *    which this document should be written
      * @param systemTime	the application-specified system time with which this document will be marked
+     * @return the TemporalDescriptor with the temporal system time when the document was written
      */
-    public void write(String docId,
+    public TemporalDescriptor write(String docId,
         DocumentMetadataWriteHandle metadataHandle,
         W contentHandle,
         ServerTransform transform,
@@ -202,8 +211,9 @@ public void write(String docId,
      * @param temporalCollection	the name of the temporal collection existing in the database in
      *    which this document should be marked as deleted
      * @param systemTime	the application-specified system time with which this document will be marked
+     * @return the TemporalDescriptor with the temporal system time when the document was deleted
      */
-    public void delete(DocumentDescriptor desc,
+    public TemporalDescriptor delete(DocumentDescriptor desc,
         Transaction transaction,
         String temporalCollection,
         java.util.Calendar systemTime)
@@ -217,8 +227,9 @@ public void delete(DocumentDescriptor desc,
      * @param temporalCollection	the name of the temporal collection existing in the database in
      *    which this document should be marked as deleted
      * @param systemTime	the application-specified system time with which this document will be marked
+     * @return the TemporalDescriptor with the temporal system time when the document was deleted
      */
-    public void delete(String docId,
+    public TemporalDescriptor delete(String docId,
         Transaction transaction,
         String temporalCollection,
         java.util.Calendar systemTime)

src/main/java/com/marklogic/client/impl/DocumentDescriptorImpl.java

@@ -15,16 +15,20 @@
  */
 package com.marklogic.client.impl;
 
+import java.util.Calendar;
+
+import com.marklogic.client.bitemporal.TemporalDescriptor;
 import com.marklogic.client.document.DocumentDescriptor;
 import com.marklogic.client.io.Format;
 
-public class DocumentDescriptorImpl implements DocumentDescriptor {
+public class DocumentDescriptorImpl implements DocumentDescriptor, TemporalDescriptor {
 	private String  uri;
 	private Format  format;
 	private String  mimetype;
 	private long    byteLength = UNKNOWN_LENGTH;
 	private long    version    = UNKNOWN_VERSION;
 	private boolean isInternal = false;
+	private Calendar temporalSystemTime;
 
 	public DocumentDescriptorImpl(boolean isInternal) {
 		super();
@@ -93,4 +97,13 @@ protected void setInternal(boolean isInternal) {
 	protected boolean isInternal() {
 		return isInternal;
 	}
+
+	@Override
+	public Calendar getTemporalSystemTime() {
+		return temporalSystemTime;
+	}
+
+	protected void setTemporalSystemTime(Calendar dateTime) {
+		this.temporalSystemTime = dateTime;
+	}
 }