com.marklogic.hub.impl

Class MasteringManagerImpl

java.lang.Object

com.marklogic.hub.impl.MasteringManagerImpl

All Implemented Interfaces:

MasteringManager

@Component
public class MasteringManagerImpl
extends java.lang.Object
implements MasteringManager

Field Summary

Fields

Modifier and Type	Field and Description
protected HubConfig	hubConfig

Constructor Summary

Constructors

Constructor and Description
MasteringManagerImpl(com.marklogic.hub.HubClientConfig hubClientConfig)
MasteringManagerImpl(HubConfig hubConfig)

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

Methods inherited from class java.lang.Object

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

Field Detail

hubConfig

protected HubConfig hubConfig

Constructor Detail

MasteringManagerImpl

@Autowired
public MasteringManagerImpl(HubConfig hubConfig)

MasteringManagerImpl

public MasteringManagerImpl(com.marklogic.hub.HubClientConfig hubClientConfig)

Method Detail

unmerge

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

Description copied from interface: MasteringManager

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

Specified by:

unmerge in interface MasteringManager

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

public 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)

Description copied from interface: MasteringManager

Unmerges the set of uris from a merged document

Specified by:

unmergeRecord in interface MasteringManager

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

public 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)

Description copied from interface: MasteringManager

Manually merges a set of documents

Specified by:

merge in interface MasteringManager

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

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

Description copied from interface: MasteringManager

Manually merges a set of documents

Specified by:

mergePreview in interface MasteringManager

Parameters:

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

Returns:

- a JsonNode for the merge response

match

public 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)

Description copied from interface: MasteringManager

Returns potential candidates for merging with a document

Specified by:

match in interface MasteringManager

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

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

Description copied from interface: MasteringManager

Returns provenance information about a merged document

Specified by:

documentHistory in interface MasteringManager

Parameters:

mergedURI - - URI of the document that represents a merge

Returns:

- a JsonNode with the historical information

notifications

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

Description copied from interface: MasteringManager

Returns notifications

Specified by:

notifications in interface MasteringManager

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

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

Specified by:

deleteNotifications in interface MasteringManager

Parameters:

uris - - notification document URIs to delete

Returns:

- a JsonNode with the notifications delete response