the beginnings of the bulk read api

Author: sammefford

src/main/java/com/marklogic/client/Page.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2012-2014 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;
+
+import java.util.Iterator;
+
+public interface Page<T> extends Iterable<T> {
+    public Iterator<T> iterator();
+    public long getStart();
+    public long getPageSize();
+    public long getTotalSize();
+    public long size();
+    public long getTotalPages();
+    public boolean hasContent();
+    public boolean hasNextPage();
+    public boolean hasPreviousPage();
+    public long getPageNumber();
+    public boolean isFirstPage();
+    public boolean isLastPage();
+}

src/main/java/com/marklogic/client/document/DocumentPage.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2012-2014 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.document;
+
+import com.marklogic.client.Page;
+import com.marklogic.client.io.marker.AbstractReadHandle;
+
+public interface DocumentPage extends Iterable<DocumentRecord>, Page<DocumentRecord> {
+    public boolean hasNext();
+
+    public DocumentRecord next();
+
+    public <T extends AbstractReadHandle> T nextContent(T contentHandle);
+}

src/main/java/com/marklogic/client/document/DocumentRecord.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2012-2014 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.document;
+
+import com.marklogic.client.io.Format;
+import com.marklogic.client.io.marker.AbstractReadHandle;
+import com.marklogic.client.io.marker.DocumentMetadataReadHandle;
+
+public interface DocumentRecord {
+    public String getUri();
+
+    public Format getFormat();
+
+    public String getMimetype();
+
+    public <T extends DocumentMetadataReadHandle> T getMetadata(T metadataHandle);
+    public <T extends AbstractReadHandle> T getContent(T contentHandle);
+}

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

@@ -0,0 +1,99 @@
+/*
+ * Copyright 2012-2014 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.impl;
+
+import java.util.Iterator;
+import com.marklogic.client.Page;
+
+public class BasicPage<T> implements Page<T> {
+    private Iterable<T> iterable;
+    private long start;
+    private long pageSize;
+    private long totalSize;
+
+    public BasicPage(Iterable<T> iterable) {
+        this.iterable = iterable;
+    }
+
+    public Iterator<T> iterator() {
+        return iterable.iterator();
+    }
+
+    public long getStart() {
+        return start;
+    }
+
+    public BasicPage<T> setStart(long start) {
+        this.start = start;
+		return this;
+    }
+
+    public long getPageSize() {
+        return pageSize;
+    }
+
+    public BasicPage<T> setPageSize(long pageSize) {
+        this.pageSize = pageSize;
+		return this;
+    }
+
+    public long getTotalSize() {
+        return totalSize;
+    }
+
+    public BasicPage<T> setTotalSize(long totalSize) {
+        this.totalSize = totalSize;
+		return this;
+    }
+
+    public long size() {
+        if ( hasNextPage() ) {
+            return getPageSize();
+        } else if ((getTotalSize() % getPageSize()) == 0) {
+            return getPageSize();
+        } else {
+            return getTotalSize() % getPageSize();
+        }
+    }
+
+    public long getTotalPages() {
+        return (long) Math.ceil((double) getTotalSize() / (double) getPageSize());
+    }
+
+    public boolean hasContent() {
+        return size() > 0;
+    }
+
+    public boolean hasNextPage() {
+        return getPageNumber() < getTotalPages();
+    }
+
+    public boolean hasPreviousPage() {
+        return getPageNumber() > 0;
+    }
+
+    public long getPageNumber() {
+        return (long) Math.floor((double) start / (double) getPageSize()) + 1;
+    }
+
+    public boolean isFirstPage() {
+        return getPageNumber() == 1;
+    }
+
+    public boolean isLastPage() {
+        return getPageNumber() == getTotalPages();
+    }
+}

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

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2012-2014 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.impl;
+
+import java.util.Iterator;
+
+import com.marklogic.client.document.DocumentPage;
+import com.marklogic.client.document.DocumentRecord;
+import com.marklogic.client.io.marker.AbstractReadHandle;
+
+class DocumentPageImpl extends BasicPage<DocumentRecord> implements DocumentPage {
+    private Iterable<DocumentRecord> iterable;
+    private Iterator<DocumentRecord> iterator;
+
+    public DocumentPageImpl(Iterable<DocumentRecord> iterable) {
+        super(iterable);
+        this.iterable = iterable;
+        this.iterator = iterable.iterator();
+    }
+
+    public boolean hasNext() {
+        return iterator.hasNext();
+    }
+
+    public DocumentRecord next() {
+        return iterator.next();
+    }
+
+    public <T extends AbstractReadHandle> T nextContent(T contentHandle) {
+        return iterator.next().getContent(contentHandle);
+    }
+}

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

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2012-2014 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.impl;
+
+import java.io.InputStream;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.marklogic.client.document.DocumentRecord;
+import com.marklogic.client.io.Format;
+import com.marklogic.client.io.marker.AbstractReadHandle;
+import com.marklogic.client.io.marker.DocumentMetadataReadHandle;
+
+public class DocumentRecordImpl implements DocumentRecord {
+	private static final Logger logger = LoggerFactory.getLogger(DocumentRecordImpl.class);
+	private String uri;
+	private Format format;
+	private String mimetype;
+	private InputStream metadata; 
+	private InputStream content; 
+
+	DocumentRecordImpl(String uri, Format format, String mimetype, InputStream metadata, InputStream content) {
+		this.uri = uri;
+		this.format = format;
+		this.mimetype = mimetype;
+		this.metadata = metadata;
+		this.content = content;
+	}
+
+    public String getUri() {
+		return uri;
+	}
+
+    public Format getFormat() {
+		return format;
+	}
+
+    public String getMimetype() {
+		return mimetype;
+	}
+
+    public <T extends DocumentMetadataReadHandle> T getMetadata(T metadataHandle) {
+		HandleImplementation metadataBase = HandleAccessor.checkHandle(metadataHandle, "metadata");
+		Format metadataFormat = metadataBase.getFormat();
+		if (metadataFormat == null || (metadataFormat != Format.XML)) {
+			if (logger.isWarnEnabled())
+				logger.warn("Unsupported metadata format {}, using XML",metadataFormat.name());
+			metadataBase.setFormat(Format.XML);
+		}
+		HandleAccessor.receiveContent(metadataHandle, metadata);
+		return metadataHandle;
+	}
+
+    public <T extends AbstractReadHandle> T getContent(T contentHandle) {
+		HandleAccessor.checkHandle(contentHandle, "content");
+		HandleAccessor.receiveContent(contentHandle, content);
+		return contentHandle;
+	}
+}
+