Package com.marklogic.client.document

Interface DocumentMetadataPatchBuilder.CallBuilder

Enclosing interface:

DocumentMetadataPatchBuilder

public static interface DocumentMetadataPatchBuilder.CallBuilder

A CallBuilder constructs a Call to a built-in or library function to produce the replacement for an existing fragment. You must construct the CallBuilder using the factory method of the DocumentPatchBuilder.

Method Summary

Modifier and Type	Method	Description
DocumentMetadataPatchBuilder.Call	add(java.lang.Number number)	Calls the built-in method to add to an existing value.
DocumentMetadataPatchBuilder.Call	applyLibrary(java.lang.String function)	Calls a function with no arguments other than the existing fragment.
DocumentMetadataPatchBuilder.Call	applyLibraryFragments(java.lang.String function, java.lang.Object... args)	Calls a function with the existing fragment and one or more specified fragments.
DocumentMetadataPatchBuilder.Call	applyLibraryValues(java.lang.String function, java.lang.Object... args)	Calls a function with the existing fragment and one or more values.
DocumentMetadataPatchBuilder.Call	concatenateAfter(java.lang.String prefix)	Calls the built-in method to append an existing string to the supplied string.
DocumentMetadataPatchBuilder.Call	concatenateBefore(java.lang.String suffix)	Calls the built-in method to concatenate an existing string before the supplied string.
DocumentMetadataPatchBuilder.Call	concatenateBetween(java.lang.String prefix, java.lang.String suffix)	Calls the built-in method to concatenate an existing string between the supplied strings.
DocumentMetadataPatchBuilder.Call	divideBy(java.lang.Number number)	Calls the built-in method to divide an existing value by the supplied number.
DocumentMetadataPatchBuilder.Call	multiply(java.lang.Number number)	Calls the built-in method to multiply an existing value.
DocumentMetadataPatchBuilder.Call	replaceRegex(java.lang.String pattern, java.lang.String replacement)	Calls the built-in method to modify an existing string with a regular expression
DocumentMetadataPatchBuilder.Call	replaceRegex(java.lang.String pattern, java.lang.String replacement, java.lang.String flags)	Calls the built-in method to modify an existing string with a regular expression
DocumentMetadataPatchBuilder.Call	substringAfter(java.lang.String prefix)	Calls the built-in method to reduce an existing string to a trailing substring.
DocumentMetadataPatchBuilder.Call	substringBefore(java.lang.String suffix)	Calls the built-in method to reduce an existing string to a leading substring.
DocumentMetadataPatchBuilder.Call	subtract(java.lang.Number number)	Calls the built-in method to subtract from an existing value.

Method Detail

add

DocumentMetadataPatchBuilder.Call add(java.lang.Number number)

Calls the built-in method to add to an existing value.

Parameters:

number - the added number

Returns:

the specification of the add call

subtract

DocumentMetadataPatchBuilder.Call subtract(java.lang.Number number)

Calls the built-in method to subtract from an existing value.

Parameters:

number - the subtracted number

Returns:

the specification of the subtract call

multiply

DocumentMetadataPatchBuilder.Call multiply(java.lang.Number number)

Calls the built-in method to multiply an existing value.

Parameters:

number - the multiplier

Returns:

the specification of the multiply call

divideBy

DocumentMetadataPatchBuilder.Call divideBy(java.lang.Number number)

Calls the built-in method to divide an existing value by the supplied number.

Parameters:

number - the divisor

Returns:

the specification of the divide call

concatenateAfter

DocumentMetadataPatchBuilder.Call concatenateAfter(java.lang.String prefix)

Calls the built-in method to append an existing string to the supplied string.

Parameters:

prefix - the string that appears first

Returns:

the specification of the concatenation call

concatenateBetween

DocumentMetadataPatchBuilder.Call concatenateBetween(java.lang.String prefix,
                                                     java.lang.String suffix)

Calls the built-in method to concatenate an existing string between the supplied strings.

Parameters:

prefix - the string that appears first

suffix - the string that appears last

Returns:

the specification of the concatenation call

concatenateBefore

DocumentMetadataPatchBuilder.Call concatenateBefore(java.lang.String suffix)

Calls the built-in method to concatenate an existing string before the supplied string.

Parameters:

suffix - the string that appears last

Returns:

the specification of the concatenation call

substringAfter

DocumentMetadataPatchBuilder.Call substringAfter(java.lang.String prefix)

Calls the built-in method to reduce an existing string to a trailing substring.

Parameters:

prefix - the initial part of the string

Returns:

the specification of the substring call

substringBefore

DocumentMetadataPatchBuilder.Call substringBefore(java.lang.String suffix)

Calls the built-in method to reduce an existing string to a leading substring.

Parameters:

suffix - the final part of the string

Returns:

the specification of the substring call

replaceRegex

DocumentMetadataPatchBuilder.Call replaceRegex(java.lang.String pattern,
                                               java.lang.String replacement)

Calls the built-in method to modify an existing string with a regular expression

Parameters:

pattern - the matching regular expression

replacement - the replacement for the match

Returns:

the specification of the regex call

replaceRegex

DocumentMetadataPatchBuilder.Call replaceRegex(java.lang.String pattern,
                                               java.lang.String replacement,
                                               java.lang.String flags)

Calls the built-in method to modify an existing string with a regular expression

Parameters:

pattern - the matching regular expression

replacement - the replacement for the match

flags - the regex flags

Returns:

the specification of the regex call

applyLibrary

DocumentMetadataPatchBuilder.Call applyLibrary(java.lang.String function)

Calls a function with no arguments other than the existing fragment. The function must be provided by the library specified using the DocumentPatchBuilder.

Parameters:

function - the name of the function

Returns:

the specification of the function call

applyLibraryValues

DocumentMetadataPatchBuilder.Call applyLibraryValues(java.lang.String function,
                                                     java.lang.Object... args)

Calls a function with the existing fragment and one or more values. The function must be provided by the library specified using the DocumentPatchBuilder.

Parameters:

function - the name of the function

args - the literal values

Returns:

the specification of the function call

applyLibraryFragments

DocumentMetadataPatchBuilder.Call applyLibraryFragments(java.lang.String function,
                                                        java.lang.Object... args)

Calls a function with the existing fragment and one or more specified fragments. The function must be provided by the library specified using the DocumentPatchBuilder.

Parameters:

function - the name of the function

args - the fragments

Returns:

the specification of the function call