com.marklogic.hub.dataservices

Interface EntitySearchService

public interface EntitySearchService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
void	deleteSavedQuery(java.lang.String id) Invokes the deleteSavedQuery operation on the database server
java.io.Reader	exportSearchAsCSV(java.lang.String structuredQuery, java.lang.String searchText, java.lang.String queryOptions, java.lang.String schemaName, java.lang.String viewName, java.lang.Long limit, com.fasterxml.jackson.databind.node.ArrayNode sortOrder, java.util.stream.Stream<java.lang.String> columns) Invokes the exportSearchAsCSV operation on the database server
com.fasterxml.jackson.databind.JsonNode	getMatchingPropertyValues(com.fasterxml.jackson.databind.JsonNode facetValuesSearchQuery) Invokes the getMatchingPropertyValues operation on the database server
com.fasterxml.jackson.databind.JsonNode	getMinAndMaxPropertyValues(com.fasterxml.jackson.databind.JsonNode facetRangeSearchQuery) Invokes the getMinAndMaxPropertyValues operation on the database server
com.fasterxml.jackson.databind.JsonNode	getModelRelationships() Invokes the getModelRelationships operation on the database server
com.fasterxml.jackson.databind.JsonNode	getRecord(java.lang.String docUri) Invokes the getRecord operation on the database server
com.fasterxml.jackson.databind.JsonNode	getSavedQueries() Invokes the getSavedQueries operation on the database server
com.fasterxml.jackson.databind.JsonNode	getSavedQuery(java.lang.String id) Invokes the getSavedQuery operation on the database server
com.fasterxml.jackson.databind.JsonNode	getSemanticConceptInfo(java.lang.String semanticConceptIRI) Invokes the getSemanticConceptInfo operation on the database server
static EntitySearchService	on(com.marklogic.client.DatabaseClient db) Creates a EntitySearchService object for executing operations on the database server.
static EntitySearchService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a EntitySearchService object for executing operations on the database server.
com.fasterxml.jackson.databind.JsonNode	saveSavedQuery(com.fasterxml.jackson.databind.JsonNode saveQuery) Invokes the saveSavedQuery operation on the database server

Method Detail

on

static EntitySearchService on(com.marklogic.client.DatabaseClient db)

Creates a EntitySearchService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads.

Parameters:

db - provides a client for communicating with the database server

Returns:

an object for executing database operations

on

static EntitySearchService on(com.marklogic.client.DatabaseClient db,
                              com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)

Creates a EntitySearchService object for executing operations on the database server. The DatabaseClientFactory class can create the DatabaseClient parameter. A single client object can be used for any number of requests and in multiple threads. The service declaration uses a custom implementation of the same service instead of the default implementation of the service by specifying an endpoint directory in the modules database with the implementation. A service.json file with the declaration can be read with FileHandle or a string serialization of the JSON declaration with StringHandle.

Parameters:

db - provides a client for communicating with the database server

serviceDeclaration - substitutes a custom implementation of the service

Returns:

an object for executing database operations

getMinAndMaxPropertyValues

com.fasterxml.jackson.databind.JsonNode getMinAndMaxPropertyValues(com.fasterxml.jackson.databind.JsonNode facetRangeSearchQuery)

Invokes the getMinAndMaxPropertyValues operation on the database server

Parameters:

facetRangeSearchQuery - provides input

Returns:

as output

getSavedQuery

com.fasterxml.jackson.databind.JsonNode getSavedQuery(java.lang.String id)

Invokes the getSavedQuery operation on the database server

Parameters:

id - provides input

Returns:

as output

deleteSavedQuery

void deleteSavedQuery(java.lang.String id)

Invokes the deleteSavedQuery operation on the database server

Parameters:

id - provides input

saveSavedQuery

com.fasterxml.jackson.databind.JsonNode saveSavedQuery(com.fasterxml.jackson.databind.JsonNode saveQuery)

Invokes the saveSavedQuery operation on the database server

Parameters:

saveQuery - provides input

Returns:

as output

getSavedQueries

com.fasterxml.jackson.databind.JsonNode getSavedQueries()

Invokes the getSavedQueries operation on the database server

Returns:

as output

exportSearchAsCSV

java.io.Reader exportSearchAsCSV(java.lang.String structuredQuery,
                                 java.lang.String searchText,
                                 java.lang.String queryOptions,
                                 java.lang.String schemaName,
                                 java.lang.String viewName,
                                 java.lang.Long limit,
                                 com.fasterxml.jackson.databind.node.ArrayNode sortOrder,
                                 java.util.stream.Stream<java.lang.String> columns)

Invokes the exportSearchAsCSV operation on the database server

Parameters:

structuredQuery - provides input

searchText - provides input

queryOptions - provides input

schemaName - provides input

viewName - provides input

limit - provides input

sortOrder - provides input

columns - provides input

Returns:

as output

getSemanticConceptInfo

com.fasterxml.jackson.databind.JsonNode getSemanticConceptInfo(java.lang.String semanticConceptIRI)

Invokes the getSemanticConceptInfo operation on the database server

Parameters:

semanticConceptIRI - The IRI of the concept instance for which related entity instances info is to be returned

Returns:

The document with the IRI provided

getModelRelationships

com.fasterxml.jackson.databind.JsonNode getModelRelationships()

Invokes the getModelRelationships operation on the database server

Returns:

The relationships between entity models

getRecord

com.fasterxml.jackson.databind.JsonNode getRecord(java.lang.String docUri)

Invokes the getRecord operation on the database server

Parameters:

docUri - The URI of the document to be returned

Returns:

The document with the URI provided

getMatchingPropertyValues

com.fasterxml.jackson.databind.JsonNode getMatchingPropertyValues(com.fasterxml.jackson.databind.JsonNode facetValuesSearchQuery)

Invokes the getMatchingPropertyValues operation on the database server

Parameters:

facetValuesSearchQuery - provides input

Returns:

as output