com.marklogic.hub

Interface MasteringManager

All Known Implementing Classes:

MasteringManagerImpl

public interface MasteringManager

Handles the calls to the Mastering endpoints.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	match(java.lang.String matchURI, java.lang.String flowName, java.lang.String stepNumber, java.lang.Boolean includeMatchDetails, com.fasterxml.jackson.databind.JsonNode options) Returns potential candidates for merging with a document
com.fasterxml.jackson.databind.JsonNode	merge(java.util.List<java.lang.String> mergeURIs, java.lang.String flowName, java.lang.String stepNumber, java.lang.Boolean preview, com.fasterxml.jackson.databind.JsonNode options) Manually merges a set of documents
com.fasterxml.jackson.databind.JsonNode	unmerge(java.lang.String mergeURI, java.lang.Boolean retainAuditTrail, java.lang.Boolean blockFutureMerges) Reverses the last set of merges made into the given merge UR

Method Detail

unmerge

com.fasterxml.jackson.databind.JsonNode unmerge(java.lang.String mergeURI,
                                                java.lang.Boolean retainAuditTrail,
                                                java.lang.Boolean blockFutureMerges)

Reverses the last set of merges made into the given merge UR

Parameters:

mergeURI - - URI of the merged document that is being reversed

retainAuditTrail - - determines if provenance for the merge/unmerge is kept

blockFutureMerges - - ensures that the documents won't be merged together in the next mastering run, if true

Returns:

- a JsonNode for the unmerge response

merge

com.fasterxml.jackson.databind.JsonNode merge(java.util.List<java.lang.String> mergeURIs,
                                              java.lang.String flowName,
                                              java.lang.String stepNumber,
                                              java.lang.Boolean preview,
                                              com.fasterxml.jackson.databind.JsonNode options)

Manually merges a set of documents

Parameters:

mergeURIs - - URIs of the documents to merge

flowName - - The name of the flow that has the mastering settings

stepNumber - - The number of the mastering step with settings

preview - - determines if the changes should be written to the database

options - - Overrides any options for the step

Returns:

- a JsonNode for the merge response

match

com.fasterxml.jackson.databind.JsonNode match(java.lang.String matchURI,
                                              java.lang.String flowName,
                                              java.lang.String stepNumber,
                                              java.lang.Boolean includeMatchDetails,
                                              com.fasterxml.jackson.databind.JsonNode options)

Returns potential candidates for merging with a document

Parameters:

matchURI - - URI of the document to find matches for

flowName - - The name of the flow that has the mastering settings

stepNumber - - The number of the mastering step with settings

includeMatchDetails - - determines if the results should also return details of how matches occurred

options - - Overrides any options for the step

Returns:

- a JsonNode for the merge response