com.marklogic.hub.dataservices

Interface MasteringService

public interface MasteringService

Provides a set of operations on the database server

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	calculateMatchingActivity(java.lang.String stepName) Invokes the calculateMatchingActivity operation on the database server
com.fasterxml.jackson.databind.JsonNode	calculateMergingActivity(java.lang.String stepName) Calculates tangential information about a merging step to provide configuration insights.
com.fasterxml.jackson.databind.JsonNode	getDefaultCollections(java.lang.String entityType) Invokes the getDefaultCollections operation on the database server
static MasteringService	on(com.marklogic.client.DatabaseClient db) Creates a MasteringService object for executing operations on the database server.
static MasteringService	on(com.marklogic.client.DatabaseClient db, com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration) Creates a MasteringService object for executing operations on the database server.
com.fasterxml.jackson.databind.JsonNode	previewMatchingActivity(java.lang.Integer sampleSize, java.util.stream.Stream<java.lang.String> uris, java.lang.String stepName, java.lang.Boolean restrictToUris, java.lang.Boolean nonMatches) Invokes the previewMatchingActivity operation on the database server
com.fasterxml.jackson.databind.JsonNode	updateMatchOptions(com.fasterxml.jackson.databind.JsonNode options) Invokes the updateMatchOptions operation on the database server
com.fasterxml.jackson.databind.JsonNode	updateMergeOptions(com.fasterxml.jackson.databind.JsonNode options) Invokes the updateMergeOptions operation on the database server
com.fasterxml.jackson.databind.JsonNode	validateMatchingStep(java.lang.String stepName) Invokes the validateMatchingStep operation on the database server
com.fasterxml.jackson.databind.JsonNode	validateMergingStep(java.lang.String stepName, java.lang.String view, java.lang.String entityPropertyPath) Provides feedback in the form of errors and warnings about a merge step.

Method Detail

on

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

Creates a MasteringService 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 MasteringService on(com.marklogic.client.DatabaseClient db,
                           com.marklogic.client.io.marker.JSONWriteHandle serviceDeclaration)

Creates a MasteringService 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

calculateMergingActivity

com.fasterxml.jackson.databind.JsonNode calculateMergingActivity(java.lang.String stepName)

Calculates tangential information about a merging step to provide configuration insights. Returns a list of source names that apply to the target Entity Type.

Parameters:

stepName - provides input

Returns:

as output

validateMatchingStep

com.fasterxml.jackson.databind.JsonNode validateMatchingStep(java.lang.String stepName)

Invokes the validateMatchingStep operation on the database server

Parameters:

stepName - provides input

Returns:

Returns an array of zero or more warning objects; each object has "level" and "message" properties

updateMergeOptions

com.fasterxml.jackson.databind.JsonNode updateMergeOptions(com.fasterxml.jackson.databind.JsonNode options)

Invokes the updateMergeOptions operation on the database server

Parameters:

options - provides input

Returns:

as output

calculateMatchingActivity

com.fasterxml.jackson.databind.JsonNode calculateMatchingActivity(java.lang.String stepName)

Invokes the calculateMatchingActivity operation on the database server

Parameters:

stepName - provides input

Returns:

as output

updateMatchOptions

com.fasterxml.jackson.databind.JsonNode updateMatchOptions(com.fasterxml.jackson.databind.JsonNode options)

Invokes the updateMatchOptions operation on the database server

Parameters:

options - provides input

Returns:

as output

previewMatchingActivity

com.fasterxml.jackson.databind.JsonNode previewMatchingActivity(java.lang.Integer sampleSize,
                                                                java.util.stream.Stream<java.lang.String> uris,
                                                                java.lang.String stepName,
                                                                java.lang.Boolean restrictToUris,
                                                                java.lang.Boolean nonMatches)

Invokes the previewMatchingActivity operation on the database server

Parameters:

sampleSize - provides input

uris - provides input

stepName - provides input

restrictToUris - provides input

nonMatches - provides input

Returns:

as output

getDefaultCollections

com.fasterxml.jackson.databind.JsonNode getDefaultCollections(java.lang.String entityType)

Invokes the getDefaultCollections operation on the database server

Parameters:

entityType - provides input

Returns:

as output

validateMergingStep

com.fasterxml.jackson.databind.JsonNode validateMergingStep(java.lang.String stepName,
                                                            java.lang.String view,
                                                            java.lang.String entityPropertyPath)

Provides feedback in the form of errors and warnings about a merge step.

Parameters:

stepName - provides input

view - Designates the view the messages are for. Valid values are 'settings' or 'rules'

entityPropertyPath - Restricts property warnings to a given entity property path

Returns:

Returns an array of zero or more warning objects; each object has "level" and "message" properties