DocumentPatchBuilder
public interface DocumentMetadataPatchBuilder
Modifier and Type | Interface | 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.
|
Modifier and Type | Method | Description |
---|---|---|
DocumentMetadataPatchBuilder |
addCollection(java.lang.String... collections) |
Adds the specified collections.
|
DocumentMetadataPatchBuilder |
addMetadataValue(java.lang.String key,
java.lang.String value) |
Adds a new metadata-value
|
DocumentMetadataPatchBuilder |
addPermission(java.lang.String role,
DocumentMetadataHandle.Capability... capabilities) |
Adds a role with the specified
capabilities
|
DocumentMetadataPatchBuilder |
addPropertyValue(java.lang.String name,
java.lang.Object value) |
Adds a new metadata property with a simple
name.
|
DocumentMetadataPatchBuilder |
addPropertyValue(javax.xml.namespace.QName name,
java.lang.Object value) |
Adds a new metadata property with a namespaced
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(java.lang.String... collections) |
Deletes the specified collections.
|
DocumentMetadataPatchBuilder |
deleteMetadataValue(java.lang.String key) |
Deletes the specified metadata-value with the
given key.
|
DocumentMetadataPatchBuilder |
deletePermission(java.lang.String... roles) |
Deletes the specified roles.
|
DocumentMetadataPatchBuilder |
deleteProperty(java.lang.String... names) |
Deletes the specified metadata properties with
simple names.
|
DocumentMetadataPatchBuilder |
deleteProperty(javax.xml.namespace.QName... names) |
Deletes the specified metadata properties with
namespaced names.
|
IterableNamespaceContext |
getNamespaces() |
Returns the namespaces available for the paths
of a patch against XML documents.
|
DocumentMetadataPatchBuilder |
library(java.lang.String ns,
java.lang.String at) |
Specifies an XQuery library installed on the
server that supplies functions for modifying existing
fragments.
|
DocumentMetadataPatchBuilder |
replaceCollection(java.lang.String oldCollection,
java.lang.String newCollection) |
Replaces the specified collection.
|
DocumentMetadataPatchBuilder |
replaceMetadataValue(java.lang.String key,
java.lang.String newValue) |
Replaces the existing metadata-value
|
DocumentMetadataPatchBuilder |
replaceMetadataValueApply(java.lang.String key,
DocumentMetadataPatchBuilder.Call call) |
Specifies a replacement operation by applying a
function to the metadata-value.
|
DocumentMetadataPatchBuilder |
replacePermission(java.lang.String role,
DocumentMetadataHandle.Capability... newCapabilities) |
Replaces the existing capabilities of a
role.
|
DocumentMetadataPatchBuilder |
replacePermission(java.lang.String oldRole,
java.lang.String newRole, DocumentMetadataHandle.Capability... newCapabilities) |
Replaces an existing role with a new role.
|
DocumentMetadataPatchBuilder |
replacePropertyApply(java.lang.String name,
DocumentMetadataPatchBuilder.Call call) |
Specifies a replacement operation by applying a
function to a metadata property having a simple name.
|
DocumentMetadataPatchBuilder |
replacePropertyApply(javax.xml.namespace.QName name,
DocumentMetadataPatchBuilder.Call call) |
Specifies a replacement operation by applying a
function to a metadata property having a namespaced name.
|
DocumentMetadataPatchBuilder |
replacePropertyValue(java.lang.String name,
java.lang.Object newValue) |
Replaces the existing value of a metadata
property having a simple name.
|
DocumentMetadataPatchBuilder |
replacePropertyValue(java.lang.String oldName,
java.lang.String newName,
java.lang.Object newValue) |
Replaces an existing metadata property with a
new property having a simple name.
|
DocumentMetadataPatchBuilder |
replacePropertyValue(javax.xml.namespace.QName name,
java.lang.Object newValue) |
Replaces the existing value of a metadata
property having a namespaced name.
|
DocumentMetadataPatchBuilder |
replacePropertyValue(javax.xml.namespace.QName oldName,
javax.xml.namespace.QName newName,
java.lang.Object newValue) |
Replaces an existing metadata property with a
new property having a namespaced 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.
|
IterableNamespaceContext getNamespaces()
void setNamespaces(IterableNamespaceContext namespaces)
EditableNamespaceContext
class to edit a set of namespaces. Note that the following prefixes
are predefined for internal use: rapi, prop, xsi, and xsnamespaces
- the declared namespacesDocumentMetadataPatchBuilder library(java.lang.String ns, java.lang.String at)
ns
- the XQuery library namespaceat
- the XQuery library path on the serverDocumentMetadataPatchBuilder addCollection(java.lang.String... collections)
collections
- the collection identifiersDocumentMetadataPatchBuilder deleteCollection(java.lang.String... collections)
collections
- the collection identifiersDocumentMetadataPatchBuilder replaceCollection(java.lang.String oldCollection, java.lang.String newCollection)
oldCollection
- the identifier for the existing
collectionnewCollection
- the identifier for the new
collectionDocumentMetadataPatchBuilder addPermission(java.lang.String role, DocumentMetadataHandle.Capability... capabilities)
role
- the name of the rolecapabilities
- the set of capabilitiesDocumentMetadataPatchBuilder deletePermission(java.lang.String... roles)
roles
- the names of the rolesDocumentMetadataPatchBuilder replacePermission(java.lang.String role, DocumentMetadataHandle.Capability... newCapabilities)
role
- the name of the rolenewCapabilities
- the replacing set of
capabilitiesDocumentMetadataPatchBuilder replacePermission(java.lang.String oldRole, java.lang.String newRole, DocumentMetadataHandle.Capability... newCapabilities)
oldRole
- the name of the replaced rolenewRole
- the name of the replacing rolenewCapabilities
- the capabilities of the
replacing roleDocumentMetadataPatchBuilder addMetadataValue(java.lang.String key, java.lang.String value)
key
- the key of the metadata-valuevalue
- the value of the metadata-valueDocumentMetadataPatchBuilder deleteMetadataValue(java.lang.String key)
key
- the key of the metadata-valueDocumentMetadataPatchBuilder replaceMetadataValue(java.lang.String key, java.lang.String newValue)
key
- the key of the existing metadata-valuenewValue
- the new value to be assigned to the
keyDocumentMetadataPatchBuilder replaceMetadataValueApply(java.lang.String key, DocumentMetadataPatchBuilder.Call call)
key
- the key of the existing metadata-valuecall
- the specification of the function callDocumentMetadataPatchBuilder addPropertyValue(java.lang.String name, java.lang.Object value)
name
- the name of the new propertyvalue
- the value of the new propertyDocumentMetadataPatchBuilder addPropertyValue(javax.xml.namespace.QName name, java.lang.Object value)
name
- the namespaced name of the new
propertyvalue
- the value of the new propertyDocumentMetadataPatchBuilder deleteProperty(java.lang.String... names)
names
- the property namesDocumentMetadataPatchBuilder deleteProperty(javax.xml.namespace.QName... names)
names
- the namespaced property namesDocumentMetadataPatchBuilder replacePropertyValue(java.lang.String name, java.lang.Object newValue)
name
- the name of the existing propertynewValue
- the new value of the propertyDocumentMetadataPatchBuilder replacePropertyValue(javax.xml.namespace.QName name, java.lang.Object newValue)
name
- the namespaced name of the existing
propertynewValue
- the new value of the propertyDocumentMetadataPatchBuilder replacePropertyValue(java.lang.String oldName, java.lang.String newName, java.lang.Object newValue)
oldName
- the name of the existing propertynewName
- the name of the replacing propertynewValue
- the value of the propertyDocumentMetadataPatchBuilder replacePropertyValue(javax.xml.namespace.QName oldName, javax.xml.namespace.QName newName, java.lang.Object newValue)
oldName
- the namespaced name of the existing
propertynewName
- the namespaced name of the replacing
propertynewValue
- the value of the propertyDocumentMetadataPatchBuilder.CallBuilder call()
DocumentMetadataPatchBuilder replacePropertyApply(java.lang.String name, DocumentMetadataPatchBuilder.Call call)
name
- the name of the existing propertycall
- the specification of the function callDocumentMetadataPatchBuilder replacePropertyApply(javax.xml.namespace.QName name, DocumentMetadataPatchBuilder.Call call)
name
- the name of the existing propertycall
- the specification of the function callDocumentMetadataPatchBuilder setQuality(int quality)
quality
- the new value for search qualityDocumentMetadataPatchBuilder.PatchHandle build() throws MarkLogicIOException
MarkLogicIOException
Copyright © 2022 MarkLogic Corporation