com.marklogic.client.document

Interface DocumentMetadataPatchBuilder

All Known Subinterfaces:

DocumentPatchBuilder

public interface DocumentMetadataPatchBuilder

A DocumentMetadataPatchBuilder specifies changes to the metadata of a database document. When using the newPatchBuilder() factory method of the DocumentManager to create the builder, you identify whether paths are specified with JSONPath or XPath.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentMetadataPatchBuilder.Call A Call specifies how to apply a built-in or library function when replacing an existing fragment.
static interface	DocumentMetadataPatchBuilder.CallBuilder A CallBuilder constructs a Call to a built-in or library function to produce the replacement for an existing fragment.
static class	DocumentMetadataPatchBuilder.Cardinality The Cardinality enumeration indicates the number of times that a path can match without error (which defaults to ZERO_OR_MORE, meaning any number of matches).
static interface	DocumentMetadataPatchBuilder.PatchHandle A PatchHandle produced by the builder can produce a string representation of the patch for saving, logging, or other uses.

Method Summary

Modifier and Type	Method and Description
DocumentMetadataPatchBuilder	addCollection(String... collections) Adds the specified collections.
DocumentMetadataPatchBuilder	addMetadataValue(String key, String value) Adds a new metadata-value
DocumentMetadataPatchBuilder	addPermission(String role, DocumentMetadataHandle.Capability... capabilities) Adds a role with the specified capabilities
DocumentMetadataPatchBuilder	addPropertyValue(QName name, Object value) Adds a new metadata property with a namespaced name.
DocumentMetadataPatchBuilder	addPropertyValue(String name, Object value) Adds a new metadata property with a simple name.
DocumentMetadataPatchBuilder.PatchHandle	build() Builds the patch that modifies the metadata or content of the database document and provides a handle for sending the patch to the server using the patch() method of the DocumentManager.
DocumentMetadataPatchBuilder.CallBuilder	call() A factory method for building calls to modify an existing node by applying built-in functions or functions from a library.
DocumentMetadataPatchBuilder	deleteCollection(String... collections) Deletes the specified collections.
DocumentMetadataPatchBuilder	deleteMetadataValue(String key) Deletes the specified metadata-value with the given key.
DocumentMetadataPatchBuilder	deletePermission(String... roles) Deletes the specified roles.
DocumentMetadataPatchBuilder	deleteProperty(QName... names) Deletes the specified metadata properties with namespaced names.
DocumentMetadataPatchBuilder	deleteProperty(String... names) Deletes the specified metadata properties with simple names.
IterableNamespaceContext	getNamespaces() Returns the namespaces available for the paths of a patch against XML documents.
DocumentMetadataPatchBuilder	library(String ns, String at) Specifies an XQuery library installed on the server that supplies functions for modifying existing fragments.
DocumentMetadataPatchBuilder	replaceCollection(String oldCollection, String newCollection) Replaces the specified collection.
DocumentMetadataPatchBuilder	replaceMetadataValue(String key, String newValue) Replaces the existing metadata-value
DocumentMetadataPatchBuilder	replaceMetadataValueApply(String key, DocumentMetadataPatchBuilder.Call call) Specifies a replacement operation by applying a function to the metadata-value.
DocumentMetadataPatchBuilder	replacePermission(String role, DocumentMetadataHandle.Capability... newCapabilities) Replaces the existing capabilities of a role.
DocumentMetadataPatchBuilder	replacePermission(String oldRole, String newRole, DocumentMetadataHandle.Capability... newCapabilities) Replaces an existing role with a new role.
DocumentMetadataPatchBuilder	replacePropertyApply(QName name, DocumentMetadataPatchBuilder.Call call) Specifies a replacement operation by applying a function to a metadata property having a namespaced name.
DocumentMetadataPatchBuilder	replacePropertyApply(String name, DocumentMetadataPatchBuilder.Call call) Specifies a replacement operation by applying a function to a metadata property having a simple name.
DocumentMetadataPatchBuilder	replacePropertyValue(QName name, Object newValue) Replaces the existing value of a metadata property having a namespaced name.
DocumentMetadataPatchBuilder	replacePropertyValue(QName oldName, QName newName, Object newValue) Replaces an existing metadata property with a new property having a namespaced name.
DocumentMetadataPatchBuilder	replacePropertyValue(String name, Object newValue) Replaces the existing value of a metadata property having a simple name.
DocumentMetadataPatchBuilder	replacePropertyValue(String oldName, String newName, Object newValue) Replaces an existing metadata property with a new property having a simple name.
void	setNamespaces(IterableNamespaceContext namespaces) Declares the namespaces available for the paths of a patch against XML documents.
DocumentMetadataPatchBuilder	setQuality(int quality) Sets the search quality of the document.

Method Detail

getNamespaces

IterableNamespaceContext getNamespaces()

Returns the namespaces available for the paths of a patch against XML documents.

Returns:

the declared namespaces

setNamespaces

void setNamespaces(IterableNamespaceContext namespaces)

Declares the namespaces available for the paths of a patch against XML documents. You can use the EditableNamespaceContext class to edit a set of namespaces. Note that the following prefixes are predefined for internal use: rapi, prop, xsi, and xs

Parameters:

namespaces - the declared namespaces

library

DocumentMetadataPatchBuilder library(String ns,
                                     String at)

Specifies an XQuery library installed on the server that supplies functions for modifying existing fragments.

Parameters:

ns - the XQuery library namespace

at - the XQuery library path on the server

Returns:

the patch builder (for convenient chaining)

addCollection

DocumentMetadataPatchBuilder addCollection(String... collections)

Adds the specified collections.

Parameters:

collections - the collection identifiers

Returns:

the patch builder (for convenient chaining)

deleteCollection

DocumentMetadataPatchBuilder deleteCollection(String... collections)

Deletes the specified collections.

Parameters:

collections - the collection identifiers

Returns:

the patch builder (for convenient chaining)

replaceCollection

DocumentMetadataPatchBuilder replaceCollection(String oldCollection,
                                               String newCollection)

Replaces the specified collection.

Parameters:

oldCollection - the identifier for the existing collection

newCollection - the identifier for the new collection

Returns:

the patch builder (for convenient chaining)

addPermission

DocumentMetadataPatchBuilder addPermission(String role,
                                           DocumentMetadataHandle.Capability... capabilities)

Adds a role with the specified capabilities

Parameters:

role - the name of the role

capabilities - the set of capabilities

Returns:

the patch builder (for convenient chaining)

deletePermission

DocumentMetadataPatchBuilder deletePermission(String... roles)

Deletes the specified roles.

Parameters:

roles - the names of the roles

Returns:

the patch builder (for convenient chaining)

replacePermission

DocumentMetadataPatchBuilder replacePermission(String role,
                                               DocumentMetadataHandle.Capability... newCapabilities)

Replaces the existing capabilities of a role.

Parameters:

role - the name of the role

newCapabilities - the replacing set of capabilities

Returns:

the patch builder (for convenient chaining)

replacePermission

DocumentMetadataPatchBuilder replacePermission(String oldRole,
                                               String newRole,
                                               DocumentMetadataHandle.Capability... newCapabilities)

Replaces an existing role with a new role.

Parameters:

oldRole - the name of the replaced role

newRole - the name of the replacing role

newCapabilities - the capabilities of the replacing role

Returns:

the patch builder (for convenient chaining)

addMetadataValue

DocumentMetadataPatchBuilder addMetadataValue(String key,
                                              String value)

Adds a new metadata-value

Parameters:

key - the key of the metadata-value

value - the value of the metadata-value

Returns:

the patch builder (for convenient chaining)

deleteMetadataValue

DocumentMetadataPatchBuilder deleteMetadataValue(String key)

Deletes the specified metadata-value with the given key.

Parameters:

key - the key of the metadata-value

Returns:

the patch builder (for convenient chaining)

replaceMetadataValue

DocumentMetadataPatchBuilder replaceMetadataValue(String key,
                                                  String newValue)

Replaces the existing metadata-value

Parameters:

key - the key of the existing metadata-value

newValue - the new value to be assigned to the key

Returns:

the patch builder (for convenient chaining)

replaceMetadataValueApply

DocumentMetadataPatchBuilder replaceMetadataValueApply(String key,
                                                       DocumentMetadataPatchBuilder.Call call)

Specifies a replacement operation by applying a function to the metadata-value. You must use CallBuilder to build a specification of the call.

Parameters:

key - the key of the existing metadata-value

call - the specification of the function call

Returns:

the patch builder (for convenient chaining)

addPropertyValue

DocumentMetadataPatchBuilder addPropertyValue(String name,
                                              Object value)

Adds a new metadata property with a simple name.

Parameters:

name - the name of the new property

value - the value of the new property

Returns:

the patch builder (for convenient chaining)

addPropertyValue

DocumentMetadataPatchBuilder addPropertyValue(QName name,
                                              Object value)

Adds a new metadata property with a namespaced name.

Parameters:

name - the namespaced name of the new property

value - the value of the new property

Returns:

the patch builder (for convenient chaining)

deleteProperty

DocumentMetadataPatchBuilder deleteProperty(String... names)

Deletes the specified metadata properties with simple names.

Parameters:

names - the property names

Returns:

the patch builder (for convenient chaining)

deleteProperty

DocumentMetadataPatchBuilder deleteProperty(QName... names)

Deletes the specified metadata properties with namespaced names.

Parameters:

names - the namespaced property names

Returns:

the patch builder (for convenient chaining)

replacePropertyValue

DocumentMetadataPatchBuilder replacePropertyValue(String name,
                                                  Object newValue)

Replaces the existing value of a metadata property having a simple name.

Parameters:

name - the name of the existing property

newValue - the new value of the property

Returns:

the patch builder (for convenient chaining)

replacePropertyValue

DocumentMetadataPatchBuilder replacePropertyValue(QName name,
                                                  Object newValue)

Replaces the existing value of a metadata property having a namespaced name.

Parameters:

name - the namespaced name of the existing property

newValue - the new value of the property

Returns:

the patch builder (for convenient chaining)

replacePropertyValue

DocumentMetadataPatchBuilder replacePropertyValue(String oldName,
                                                  String newName,
                                                  Object newValue)

Replaces an existing metadata property with a new property having a simple name.

Parameters:

oldName - the name of the existing property

newName - the name of the replacing property

newValue - the value of the property

Returns:

the patch builder (for convenient chaining)

replacePropertyValue

DocumentMetadataPatchBuilder replacePropertyValue(QName oldName,
                                                  QName newName,
                                                  Object newValue)

Replaces an existing metadata property with a new property having a namespaced name.

Parameters:

oldName - the namespaced name of the existing property

newName - the namespaced name of the replacing property

newValue - the value of the property

Returns:

the patch builder (for convenient chaining)

call

DocumentMetadataPatchBuilder.CallBuilder call()

A factory method for building calls to modify an existing node by applying built-in functions or functions from a library.

Returns:

the builder for function calls

replacePropertyApply

DocumentMetadataPatchBuilder replacePropertyApply(String name,
                                                  DocumentMetadataPatchBuilder.Call call)

Specifies a replacement operation by applying a function to a metadata property having a simple name. You must use CallBuilder to build a specification of the call.

Parameters:

name - the name of the existing property

call - the specification of the function call

Returns:

the patch builder (for convenient chaining)

replacePropertyApply

DocumentMetadataPatchBuilder replacePropertyApply(QName name,
                                                  DocumentMetadataPatchBuilder.Call call)

Specifies a replacement operation by applying a function to a metadata property having a namespaced name. You must use CallBuilder to build a specification of the call.

Parameters:

name - the name of the existing property

call - the specification of the function call

Returns:

the patch builder (for convenient chaining)

setQuality

DocumentMetadataPatchBuilder setQuality(int quality)

Sets the search quality of the document.

Parameters:

quality - the new value for search quality

Returns:

the patch builder (for convenient chaining)

build

DocumentMetadataPatchBuilder.PatchHandle build()
                                        throws MarkLogicIOException

Builds the patch that modifies the metadata or content of the database document and provides a handle for sending the patch to the server using the patch() method of the DocumentManager. Once the patch is built, specifying additional operation with the patch builder do not alter the patch built previously.

Returns:

the handle on the built patch

Throws:

MarkLogicIOException