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	deleteNotifications(java.util.List<java.lang.String> uris)
com.fasterxml.jackson.databind.JsonNode	documentHistory(java.lang.String mergedURI) Returns provenance information about a merged document
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	mergePreview(java.lang.String flowName, java.util.List<java.lang.String> uris) Manually merges a set of documents
com.fasterxml.jackson.databind.JsonNode	notifications(int start, int pageLength) Returns notifications
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
com.fasterxml.jackson.databind.JsonNode	unmergeRecord(java.lang.String mergeURI, java.lang.Boolean retainAuditTrail, java.lang.Boolean blockFutureMerges, java.util.List<java.lang.String> removeURIs) Unmerges the set of uris from a merged document

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

unmergeRecord

com.fasterxml.jackson.databind.JsonNode unmergeRecord(java.lang.String mergeURI,
                                                      java.lang.Boolean retainAuditTrail,
                                                      java.lang.Boolean blockFutureMerges,
                                                      java.util.List<java.lang.String> removeURIs)

Unmerges the set of uris from a merged document

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

removeURIs - - URIs of the merged documents that we want to unmerge

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

mergePreview

com.fasterxml.jackson.databind.JsonNode mergePreview(java.lang.String flowName,
                                                     java.util.List<java.lang.String> uris)

Manually merges a set of documents

Parameters:

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

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

documentHistory

com.fasterxml.jackson.databind.JsonNode documentHistory(java.lang.String mergedURI)

Returns provenance information about a merged document

Parameters:

mergedURI - - URI of the document that represents a merge

Returns:

- a JsonNode with the historical information

notifications

com.fasterxml.jackson.databind.JsonNode notifications(int start,
                                                      int pageLength)

Returns notifications

Parameters:

start - - (optional, defaulting to 1) the 1-based index of the first notification to return

pageLength - - (optional, defaulting to 10) the number of notifications to return

Returns:

- a JsonNode with the notifications

deleteNotifications

com.fasterxml.jackson.databind.JsonNode deleteNotifications(java.util.List<java.lang.String> uris)

Parameters:

uris - - notification document URIs to delete

Returns:

- a JsonNode with the notifications delete response