Package com.marklogic.client.document

Class ServerTransform

java.lang.Object

com.marklogic.client.impl.RequestParametersImplementation

com.marklogic.client.util.RequestParameters

com.marklogic.client.document.ServerTransform

public class ServerTransform
extends RequestParameters

ServerTransform specifies the invocation of a transform on the server including both the name of the transform and the parameters passed to the transform.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Constructor Summary

Constructors

Constructor	Description
ServerTransform(java.lang.String name)	Specifies invocation of the named transform on the server.

Method Summary

Modifier and Type	Method	Description
ServerTransform	addParameter(java.lang.String name, java.lang.String value)	Appends a value to the list for a parameter and returns this instance for method chaining.
java.lang.String	getName()	Gets the name of the invoked transform.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	merge(java.util.Map<java.lang.String,java.util.List<java.lang.String>> currentParams)	Merges the transform and its parameters with other parameters of the request.

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, entry, equals, forEach, getOrDefault, hashCode, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from class java.lang.Object

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

Methods inherited from class com.marklogic.client.util.RequestParameters

add, add, clear, containsKey, containsValue, copy, entrySet, get, isEmpty, keySet, put, put, put, putAll, remove, size, values

Methods inherited from class com.marklogic.client.impl.RequestParametersImplementation

getMap

Constructor Detail

ServerTransform

public ServerTransform(java.lang.String name)

Specifies invocation of the named transform on the server.

Parameters:

name - the transform installed on the server

Method Detail

getName

public java.lang.String getName()

Gets the name of the invoked transform.

Returns:

the name of the transform installed on the server

addParameter

public ServerTransform addParameter(java.lang.String name,
                                    java.lang.String value)

Appends a value to the list for a parameter and returns this instance for method chaining.

Parameters:

name - the parameter

value - the value to add to the list

Returns:

this instance (for method chaining)

merge

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> merge(java.util.Map<java.lang.String,java.util.List<java.lang.String>> currentParams)

Merges the transform and its parameters with other parameters of the request. Ordinarily, and application does not need to call this method.

Parameters:

currentParams - the other parameters

Returns:

the union of the other parameters and the transform parameters