Merge branch 'pojoFacade' into dev

Author: sammefford

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

@@ -113,10 +113,15 @@ public interface DatabaseClient {
     public ServerConfigurationManager newServerConfigManager();
 
     /**
-     * Creates a PojoRepository specific to the specified class and id types. 
+     * Creates a PojoRepository specific to the specified class and its id type. 
      * The PojoRepository provides a facade for persisting, retrieving, and
      * querying data contained in Java objects.  Annotations are required to
      * identify the id field and any fields for which you wish to create indexes.
+     *
+     * @param clazz the class type for this PojoRepository to handle
+     * @param idClass the class type of the id field for this clazz, must obviously 
+     *          be Serializable or we'll struggle to marshall it
+     * @return the initialized PojoRepository
      **/
     public <T, ID extends Serializable> PojoRepository<T, ID> newPojoRepository(Class<T> clazz, Class<ID> idClass);
 

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

@@ -368,12 +368,52 @@ public <T extends R> T read(DocumentDescriptor desc, DocumentMetadataReadHandle
     public <T extends R> T read(DocumentDescriptor desc, DocumentMetadataReadHandle metadataHandle, T contentHandle, ServerTransform transform, Transaction transaction)
 		throws ResourceNotFoundException, ForbiddenUserException,  FailedRequestException;
 
+    /**
+     * Reads from the database a list of documents matching the provided uris.  Allows
+     * iteration across matching documents and metadata (only if setMetadataCategories 
+     * has been called to request metadata).  To find out how many of your uris matched,
+     * call the {@link DocumentPage#size() DocumentPage.size()} method.
+     *
+     * @param uris the database uris identifying documents to retrieve
+     * @return the DocumentPage of matching documents and metadata
+     */
     public DocumentPage read(String... uris);
 
+    /**
+     * Reads from the database a list of documents matching the provided uris.  Allows
+     * iteration across matching documents and metadata (only if setMetadataCategories 
+     * has been called to request metadata).  To find out how many of your uris matched,
+     * call the {@link DocumentPage#size() DocumentPage.size()} method.
+     *
+     * @param transform the transform to be run on the server on each document (must already be installed)
+     * @param uris the database uris identifying documents to retrieve
+     * @return the DocumentPage of matching documents and metadata
+     */
     public DocumentPage read(ServerTransform transform, String... uris);
 
+    /**
+     * Reads from the database a list of documents matching the provided uris.  Allows
+     * iteration across matching documents and metadata (only if setMetadataCategories 
+     * has been called to request metadata).  To find out how many of your uris matched,
+     * call the {@link DocumentPage#size() DocumentPage.size()} method.
+     *
+     * @param transaction the transaction in which this read is participating
+     * @param uris the database uris identifying documents to retrieve
+     * @return the DocumentPage of matching documents and metadata
+     */
     public DocumentPage read(Transaction transaction, String... uris);
 
+    /**
+     * Reads from the database a list of documents matching the provided uris.  Allows
+     * iteration across matching documents and metadata (only if setMetadataCategories 
+     * has been called to request metadata).  To find out how many of your uris matched,
+     * call the {@link DocumentPage#size() DocumentPage.size()} method.
+     *
+     * @param transform the transform to be run on the server on each document (must already be installed)
+     * @param transaction the transaction in which this read is participating
+     * @param uris the database uris identifying documents to retrieve
+     * @return the DocumentPage of matching documents and metadata
+     */
     public DocumentPage read(ServerTransform transform, Transaction transaction, String... uris);
 
     public DocumentPage readMetadata(String... uris);

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

@@ -1,3 +1,18 @@
+/*
+ * 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;

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

@@ -1,3 +1,18 @@
+/*
+ * 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 com.marklogic.client.DatabaseClient;

src/main/java/com/marklogic/client/pojo/PojoPage.java

@@ -1,3 +1,18 @@
+/*
+ * 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.pojo;
 
 import com.marklogic.client.Page;

src/main/java/com/marklogic/client/pojo/PojoQueryBuilder.java

@@ -1,3 +1,18 @@
+/*
+ * 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.pojo;
 
 import javax.xml.namespace.QName;

src/main/java/com/marklogic/client/pojo/PojoRepository.java

@@ -1,3 +1,18 @@
+/*
+ * 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.pojo;
 
 import com.marklogic.client.DatabaseClient;

src/main/java/com/marklogic/client/pojo/annotation/Id.java

@@ -1,3 +1,18 @@
+/*
+ * 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.pojo.annotation;
 
 import java.lang.annotation.Retention;