Package com.marklogic.client.ext.helper

Class ClientHelper

  • public class ClientHelper
extends LoggingObject
    The intent of this class is to provide some syntactic sugar on common operations using the ML Java API, which is a wrapper around the ML REST API.

    • Constructor Summary

      Constructors 
      Constructor Description
      ClientHelper​(com.marklogic.client.DatabaseClient client)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String eval​(java.lang.String expr)  
      com.marklogic.client.DatabaseClient getClient()  
      java.util.List<java.lang.String> getCollections​(java.lang.String uri)  
      long getCollectionSize​(java.lang.String collectionName)  
      com.marklogic.client.io.DocumentMetadataHandle getMetadata​(java.lang.String uri)  
      java.util.List<java.lang.String> getUrisInCollection​(java.lang.String collectionName)  
      java.util.List<java.lang.String> getUrisInCollection​(java.lang.String collectionName, int pageLength)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ClientHelper

        public ClientHelper​(com.marklogic.client.DatabaseClient client)

    • Method Detail

      • getClient

        public com.marklogic.client.DatabaseClient getClient()

      • getMetadata

        public com.marklogic.client.io.DocumentMetadataHandle getMetadata​(java.lang.String uri)

      • getCollections

        public java.util.List<java.lang.String> getCollections​(java.lang.String uri)

      • getCollectionSize

        public long getCollectionSize​(java.lang.String collectionName)

      • getUrisInCollection

        public java.util.List<java.lang.String> getUrisInCollection​(java.lang.String collectionName)

      • getUrisInCollection

        public java.util.List<java.lang.String> getUrisInCollection​(java.lang.String collectionName,
                                                            int pageLength)

      • eval

        public java.lang.String eval​(java.lang.String expr)