- abbreviate()
- Method in enum com.marklogic.client.document.DocumentMetadataPatchBuilder.Cardinality
-
Returns the standard abbreviation for the
cardinality value.
- abs(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the absolute value of arg.
- AbstractReadHandle - Interface in
com.marklogic.client.io.marker
-
A Read Handle defines a representation for
reading database content.
- AbstractStructuredQuery()
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.AbstractStructuredQuery
-
- AbstractWriteHandle - Interface in
com.marklogic.client.io.marker
-
A Write Handle defines a representation for
writing database content.
- accept(I)
- Method in interface com.marklogic.client.dataservices.InputCaller.BulkInputCaller
-
Accepts an input item for the endpoint.
- accept(I)
- Method in interface com.marklogic.client.dataservices.InputOutputCaller.BulkInputOutputCaller
-
Accepts an input item for the endpoint.
- acceptAll(I[])
- Method in interface com.marklogic.client.dataservices.InputCaller.BulkInputCaller
-
Accepts multiple input items for the
endpoint.
- acceptAll(I[])
- Method in interface com.marklogic.client.dataservices.InputOutputCaller.BulkInputOutputCaller
-
Accepts multiple input items for the
endpoint.
- acos(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc cosine of x, in radians, in the
range from 0 to pi (inclusive).
- add(String, AbstractWriteHandle)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- add(String, DocumentMetadataWriteHandle, AbstractWriteHandle)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- add(WriteEvent...)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Add docs in the form of WriteEvents.
- add(DocumentWriteOperation)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- add(Number)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to add to an existing
value.
- add(String, AbstractWriteHandle)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
docId (server uri) and contents provided by the handle
- add(String, DocumentMetadataWriteHandle, AbstractWriteHandle)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
docId (server uri), metadata, and contents provided by the
handle
- add(DocumentDescriptor, AbstractWriteHandle)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
uri template, and contents provided by the handle
- add(DocumentDescriptor, DocumentMetadataWriteHandle, AbstractWriteHandle)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
uri template, metadata, and contents provided by the handle
- add(String, AbstractWriteHandle, String)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
docId (server uri), temporalDocumentURI and contents provided by
the handle
- add(String, DocumentMetadataWriteHandle, AbstractWriteHandle, String)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
docId (server uri), metadata, temporalDocumentURI and contents
provided by the handle
- add(DocumentDescriptor, AbstractWriteHandle, String)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
uri template, temporalDocumentURI and contents provided by the
handle
- add(DocumentDescriptor, DocumentMetadataWriteHandle, AbstractWriteHandle, String)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
uri template, metadata, temporalDocumentURI and contents provided
by the handle
- add(ServerExpression...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns the sum of the specified
numeric expressions.
- add(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns the sum of two vectors.
- add(String, String)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentMetadataValues
-
Adds metadata-value that can be written for the
document.
- add(String, DocumentMetadataHandle.Capability...)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentPermissions
-
Adds a role with one or more capabilities to the
metadata that can be written for the document.
- add(String, String)
- Method in class com.marklogic.client.util.RequestParameters
-
Appends a value to the list for a
parameter.
- add(String, String...)
- Method in class com.marklogic.client.util.RequestParameters
-
Appends a list of values to the list for a
parameter.
- add64(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Add two 64-bit integer values, discarding
overflow.
- addAll(Stream<? extends DocumentWriteOperation>)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Writes a document stream to the database.
- addAll(String...)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentCollections
-
Adds one or more collections to the metadata
that can be written for the document.
- addAs(String, Object)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- addAs(String, DocumentMetadataWriteHandle, Object)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- addAs(String, Object)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
docId (server uri) and contents.
- addAs(String, DocumentMetadataWriteHandle, Object)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
docId (server uri), metadata, and contents.
- addAs(String, Object, String)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
docId (server uri), temporalDocumentURI and contents.
- addAs(String, DocumentMetadataWriteHandle, Object, String)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Adds to this write set a document with the given
docId (server uri), metadata, temporalDocumentURI and
contents.
- addCollection(String...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds the specified collections.
- addConfigurator(DatabaseClientFactory.ClientConfigurator<?>)
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Adds a listener that provides custom
configuration when a communication library is created.
- addDefault(DocumentMetadataWriteHandle)
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Sets the default metadata for this write set for
all documents added after this call
- addFromDelimitedString(String)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentPermissions
-
Adds one or more permissions based on the given
comma-delimited string.
- addMetadataValue(String, String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds a new metadata-value
- addNamespace(String, String)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Add a single namespace prefix-to-uri mapping to
the namespace context.
- addParameter(String, String)
- Method in class com.marklogic.client.document.ServerTransform
-
Appends a value to the list for a parameter and
returns this instance for method chaining.
- addPermission(String, String)
- Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
adds a permission to this module
- addPermission(String, DocumentMetadataHandle.Capability...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds a role with the specified
capabilities
- addPropertyValue(String, Object)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds a new metadata property with a simple
name.
- addPropertyValue(QName, Object)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Adds a new metadata property with a namespaced
name.
- addVariable(String, String)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Set a variable name-value pair to pass to the
code executing server-side.
- addVariable(String, Number)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Set a variable name-value pair to pass to the
code executing server-side.
- addVariable(String, Boolean)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Set a variable name-value pair to pass to the
code executing server-side.
- addVariable(String, AbstractWriteHandle)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Set a variable name-value pair to pass to the
code executing server-side.
- addVariableAs(String, Object)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Convenience method to set a variable of a type
mapped to an io handle.
- adjustDateTimeToTimezone(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:dateTime value to a specific
timezone, or to no timezone at all.
- adjustDateTimeToTimezone(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:dateTime value to a specific
timezone, or to no timezone at all.
- adjustDateTimeToTimezone(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:dateTime value to a specific
timezone, or to no timezone at all.
- adjustDateToTimezone(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:date value to a specific timezone,
or to no timezone at all.
- adjustDateToTimezone(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:date value to a specific timezone,
or to no timezone at all.
- adjustDateToTimezone(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:date value to a specific timezone,
or to no timezone at all.
- adjustTimeToTimezone(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:time value to a specific timezone,
or to no timezone at all.
- adjustTimeToTimezone(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:time value to a specific timezone,
or to no timezone at all.
- adjustTimeToTimezone(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Adjusts an xs:time value to a specific timezone,
or to no timezone at all.
- advanceLsqt(String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Enables Last Stable Query Time (LSQT) on the
named collection and advances the LSQT for the collection to the
maximum system start time.
- advanceLsqt(String, long)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Enables Last Stable Query Time (LSQT) on the
named collection and advances the LSQT for the collection to the
maximum system start time.
- afterQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching fragments committed
after a specified timestamp.
- afterQuery(long)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents with timestamp after the given
timestamp.
- AggregateResult - Class in com.marklogic.client.query
-
A CountedDistinctValue is a value that includes
a frequency.
- AggregateResult()
- Constructor for class com.marklogic.client.query.AggregateResult
-
- aggregateSeq(PlanAggregateCol...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a sequence from multiple aggregate
values to pass as a parameter to an operation.
- ALL_CONTENT
- Static variable in interface com.marklogic.client.util.RequestLogger
-
Indicates that all content is copied to the
log.
- ALL_VALUES_FROM
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- allowsEndpointConstants()
- Method in interface com.marklogic.client.dataservices.IOEndpoint
-
Identifies whether the endpoint accepts a data
structure that defines constant input to provide to the
endpoint.
- allowsEndpointState()
- Method in interface com.marklogic.client.dataservices.IOEndpoint
-
Identifies whether the endpoint accepts and
returns a data structure that provides a snapshot of the mutable
state of the endpoint.
- allowsInput()
- Method in interface com.marklogic.client.dataservices.IOEndpoint
-
Identifies whether the endpoint accepts one or
more input data structures to work on.
- allowsSession()
- Method in interface com.marklogic.client.dataservices.IOEndpoint
-
Identifies whether the endpoint accepts a
session identifier that the endpoint can use to access a session
cache on the server.
- analyzeString(String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
The result of the function is a new element node
whose string value is the original string, but which contains
markup to show which parts of the input match the regular
expression.
- analyzeString(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
The result of the function is a new element node
whose string value is the original string, but which contains
markup to show which parts of the input match the regular
expression.
- analyzeString(String, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
The result of the function is a new element node
whose string value is the original string, but which contains
markup to show which parts of the input match the regular
expression.
- analyzeString(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
The result of the function is a new element node
whose string value is the original string, but which contains
markup to show which parts of the input match the regular
expression.
- and(ServerExpression...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if the specified
expressions all return true.
- and(StructuredQueryDefinition...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- and(StructuredQueryDefinition...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines an AND query over the list of query
definitions.
- and64(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
AND two 64-bit integer values.
- andNot(StructuredQueryDefinition, StructuredQueryDefinition)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- andNot(StructuredQueryDefinition, StructuredQueryDefinition)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines an AND NOT query combining a positive
and negative query.
- andNotQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the set difference of
the matches specified by two sub-queries.
- AndNotQuery(StructuredQueryDefinition, StructuredQueryDefinition)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.AndNotQuery
-
- andQuery(CtsQueryExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the intersection of
the matches specified by the sub-queries.
- andQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the intersection of
the matches specified by the sub-queries.
- andQuery(ServerExpression, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the intersection of
the matches specified by the sub-queries.
- andQuery(ServerExpression, XsStringSeqVal)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the intersection of
the matches specified by the sub-queries.
- AndQuery(StructuredQueryDefinition...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.AndQuery
-
- ANY
- Static variable in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
The ANY SSLHostnameVerifier allows any hostname,
which can be useful during initial development when a valid SSL
certificate is not available but is not recommended for production
because it would permit an invalid SSL certificate.
- anyURI(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:anyURI server data type.
- anyURI(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a uri as a string and constructs an
xs:anyURI value
- anyURISeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of uris as a string and
constructs an xs:anyURI sequence
- anyURISeq(XsAnyURIVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:anyURI values and
constructs an xs:anyURI sequence
- applyLibrary(String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls a function with no arguments other than
the existing fragment.
- applyLibraryFragments(String, Object...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls a function with the existing fragment and
one or more specified fragments.
- applyLibraryValues(String, Object...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls a function with the existing fragment and
one or more values.
- ApplyTransformListener - Class in
com.marklogic.client.datamovement
-
- ApplyTransformListener()
- Constructor for class com.marklogic.client.datamovement.ApplyTransformListener
-
- ApplyTransformListener.ApplyResult - Enum
in com.marklogic.client.datamovement
-
- approxCenter(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Return a point approximating the center of the
given region.
- approxCenter(ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Return a point approximating the center of the
given region.
- approxCenter(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Return a point approximating the center of the
given region.
- arcIntersection(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the point at the intersection of two
arcs.
- arcIntersection(ServerExpression, ServerExpression, ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the point at the intersection of two
arcs.
- arcIntersection(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the point at the intersection of two
arcs.
- array()
- Method in interface com.marklogic.client.expression.JsonExpr
-
Creates a (JSON) array, which is like a sequence
of values, but allows for nesting.
- array(ServerExpression)
- Method in interface com.marklogic.client.expression.JsonExpr
-
Creates a (JSON) array, which is like a sequence
of values, but allows for nesting.
- arrayAggregate(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an array whose items
are the result of evaluating the column for each row in the group
or row set.
- arrayAggregate(PlanColumn, PlanExprCol)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an array whose items
are the result of evaluating the column for each row in the group
or row set.
- arrayAggregate(String, String, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an array whose items
are the result of evaluating the column for each row in the group
or row set.
- arrayAggregate(PlanColumn, PlanExprCol, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs an array whose items
are the result of evaluating the column for each row in the group
or row set.
- arraySize(ServerExpression)
- Method in interface com.marklogic.client.expression.JsonExpr
-
Returns the size of the array.
- arrayValues(ServerExpression)
- Method in interface com.marklogic.client.expression.JsonExpr
-
Returns the array values as an XQuery
sequence.
- arrayValues(ServerExpression, boolean)
- Method in interface com.marklogic.client.expression.JsonExpr
-
Returns the array values as an XQuery
sequence.
- arrayValues(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.JsonExpr
-
Returns the array values as an XQuery
sequence.
- ArrayVisitor()
- Constructor for class com.marklogic.client.datamovement.JSONSplitter.ArrayVisitor
-
- as(String, ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function defines a column by assigning the
value of an expression over the rows in the row set.
- as(PlanColumn, ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function defines a column by assigning the
value of an expression over the rows in the row set.
- asc(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function sorts the rows by the values of
the specified column in ascending order.
- asc(PlanExprCol)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function sorts the rows by the values of
the specified column in ascending order.
- asin(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc sine of x, in radians, in the
range from -pi/2 to +pi/2 (inclusive).
- asParameters()
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Constructs request parameters expressing the
extension metadata.
- atan(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc tangent of x, in radians.
- atan2(ServerExpression, double)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc tangent of y/x, in radians, in
the range from -pi/2 to +pi/2 (inclusive), using the signs of y and
x to determine the appropriate quadrant.
- atan2(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the arc tangent of y/x, in radians, in
the range from -pi/2 to +pi/2 (inclusive), using the signs of y and
x to determine the appropriate quadrant.
- attribute(QName)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a namespaced attribute to match with
a query.
- attribute(String)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a simple attribute to match with a
query.
- AUTH_TYPE_BASIC
- Static variable in class com.marklogic.client.DatabaseClientBuilder
-
- AUTH_TYPE_CERTIFICATE
- Static variable in class com.marklogic.client.DatabaseClientBuilder
-
- AUTH_TYPE_DIGEST
- Static variable in class com.marklogic.client.DatabaseClientBuilder
-
- AUTH_TYPE_KERBEROS
- Static variable in class com.marklogic.client.DatabaseClientBuilder
-
- AUTH_TYPE_MARKLOGIC_CLOUD
- Static variable in class com.marklogic.client.DatabaseClientBuilder
-
- AUTH_TYPE_OAUTH
- Static variable in class com.marklogic.client.DatabaseClientBuilder
-
- AUTH_TYPE_SAML
- Static variable in class com.marklogic.client.DatabaseClientBuilder
-
- avg(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the average of the values in the input
sequence arg, that is, the sum of the values divided by the number
of values.
- avg(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function averages the non-null values of
the column for the rows in the group or row set.
- avg(PlanColumn, PlanExprCol)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function averages the non-null values of
the column for the rows in the group or row set.
- avg(String, String, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function averages the non-null values of
the column for the rows in the group or row set.
- avg(PlanColumn, PlanExprCol, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function averages the non-null values of
the column for the rows in the group or row set.
- awaitCompletion()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Blocks until the job is complete.
- awaitCompletion(long, TimeUnit)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Blocks until the job is complete.
- awaitCompletion()
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Suspends execution of the current thread until
either all rows have been retrieved from the view or the job is
stopped.
- awaitCompletion(long, TimeUnit)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Suspends execution of the current thread until
either all rows have been retrieved from the view, the job is
stopped, or a timeout expires.
- awaitCompletion()
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Blocks until the job has finished or cancelled
all queued tasks.
- awaitCompletion(long, TimeUnit)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Blocks until the job has finished or cancelled
all queued tasks.
- awaitCompletion()
- Method in interface com.marklogic.client.dataservices.IOEndpoint.BulkIOEndpointCaller
-
Waits for the bulk calling to complete, first
starting the calls if appropriate.
- axis(String)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- base64Binary(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:base64Binary server data type.
- base64Binary(byte[])
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a binary value as a byte array and
constructs an xs:base64Binary value
- base64BinarySeq(byte[]...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of binary values as a byte
array and constructs an xs:base64Binary sequence
- base64BinarySeq(XsBase64BinaryVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:base64Binary values and
constructs an xs:base64Binary sequence
- base64Decode(ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns a vector value by decoding the base64
encoded string input.
- base64Decode(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Converts base64-encoded string to
plaintext.
- base64Encode(ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns the base64 encoding of the vector.
- base64Encode(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Converts plaintext into base64-encoded
string.
- BaseHandle<R,W> - Class in com.marklogic.client.io
-
BaseHandle is the base class for content
representations such as byte arrays, strings, input streams,
character readers, files, POJO (Plain Old Java Object) structures
and so on.
- BaseHandle()
- Constructor for class com.marklogic.client.io.BaseHandle
-
Zero-argument constructor.
- baseUri(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the value of the base-uri property for
the specified node.
- BasicAuthContext(String, String)
- Constructor for class com.marklogic.client.DatabaseClientFactory.BasicAuthContext
-
- BasicElementVisitor(String, String)
- Constructor for class com.marklogic.client.datamovement.XMLSplitter.BasicElementVisitor
-
Construct the BasicElementVisitor with target
namespace URI and local name.
- Batch<T> - Interface in com.marklogic.client.datamovement
-
A group of items (generally documents or uris)
and context representing a completed action in a datamovement
job.
- Batcher - Interface in com.marklogic.client.datamovement
-
- BatchEvent - Interface in com.marklogic.client.datamovement
-
A completed action in a datamovement job.
- BatchFailureListener<T extends
BatchEvent>
- Interface in com.marklogic.client.datamovement
-
A generic interface for listeners which process
failures on batches.
- BatchListener<T extends BatchEvent>
- Interface in com.marklogic.client.datamovement
-
Runs processEvent on each batch as it is ready
during a QueryBatcher or WriteBatcher job.
- Bean()
- Constructor for class com.marklogic.client.DatabaseClientFactory.Bean
-
Zero-argument constructor for bean
applications.
- bearing(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the true bearing in radians of the path
from the first point to the second.
- bearing(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the true bearing in radians of the path
from the first point to the second.
- bearing(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the true bearing in radians of the path
from the first point to the second.
- beforeQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching fragments committed
before or at a specified timestamp.
- beforeQuery(long)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents with timestamp prior to the
given timestamp.
- BinaryDocumentManager - Interface in
com.marklogic.client.document
-
A Binary Document Manager provides database
operations on binary documents.
- BinaryDocumentManager.MetadataExtraction
- Enum in com.marklogic.client.document
-
The MetadataExtraction enumeration identifies
whether properties are extracted from binary documents to metadata
properties on the binary document, to a separate XHTML document, or
not at all.
- BinaryReadHandle - Interface in com.marklogic.client.io.marker
-
A Binary Read Handle can represent binary
content read from the database.
- BinaryWriteHandle - Interface in com.marklogic.client.io.marker
-
A Binary Write Handle can represent binary
content written to the database.
- bind(PlanExprColSeq)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This function adds new columns or modifies
existing columns based on expressions while preserving existing
unmodified columns in the row set.
- bind(String, String)
- Method in interface com.marklogic.client.semantics.SPARQLBindings
-
Bind a variable of type iri.
- bind(String, String, RDFTypes)
- Method in interface com.marklogic.client.semantics.SPARQLBindings
-
Bind a variable of specified type.
- bind(String, String, Locale)
- Method in interface com.marklogic.client.semantics.SPARQLBindings
-
Bind a variable of type
http://www.w3.org/1999/02/22-rdf-syntax-ns#langString with the
specified language tag.
- bindAs(String, ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This function is deprecated in favor of the
bind() function and will not be supported in MarkLogic 11.
- bindAs(PlanColumn, ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This function is deprecated in favor of the
bind() function and will not be supported in MarkLogic 11.
- bindParam(PlanParamExpr, PlanParamBindingVal)
- Method in interface com.marklogic.client.expression.PlanBuilder.Plan
-
Specifies a value to replace a placeholder
parameter during this execution of the plan in all expressions in
which the parameter appears.
- bindParam(String, boolean)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a boolean primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, boolean)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a boolean primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, byte)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a byte primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, byte)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a byte primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, double)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a double primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, double)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a double primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, float)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a float primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, float)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a float primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, int)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies an int primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, int)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies an int primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, long)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a long primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, long)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a long primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, short)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a short primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, short)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a short primitive value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a string literal value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a string literal value to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, DocumentWriteSet)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a set of documents to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, DocumentWriteSet)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a set of documents to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, AbstractWriteHandle)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a content handle to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(String, AbstractWriteHandle, Map<String, Map<String, AbstractWriteHandle>>)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a content handle to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bindParam(PlanParamExpr, AbstractWriteHandle, Map<String, Map<String, AbstractWriteHandle>>)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.PlanBase
-
Specifies a content handle to replace a
placeholder parameter during this execution of the plan in all
expressions in which the parameter appears.
- bitLength(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns the length of the string "str" in
bits.
- bnode()
- Method in interface com.marklogic.client.expression.SemExpr
-
This function returns an identifier for a blank
node, allowing the construction of a triple that refers to a blank
node.
- bnode(ServerExpression)
- Method in interface com.marklogic.client.expression.SemExpr
-
This function returns an identifier for a blank
node, allowing the construction of a triple that refers to a blank
node.
- booleanExpr(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Computes the effective boolean value of the
sequence arg.
- booleanExpr(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:boolean server data type.
- booleanSeq(boolean...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of boolean primitives and
constructs an xs:boolean sequence
- booleanSeq(XsBooleanVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:boolean values and
constructs an xs:boolean sequence
- booleanVal(boolean)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a boolean primitive and constructs an
xs:boolean value
- boost(StructuredQueryDefinition, StructuredQueryDefinition)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- boost(StructuredQueryDefinition, StructuredQueryDefinition)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a boost query for the matching and
boosting query definitions.
- boostQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying that matches to
matching-query should have their search relevance scores boosted if
they also match boosting-query.
- boundingBoxes(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns a sequence of boxes that bound the given
region.
- boundingBoxes(ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns a sequence of boxes that bound the given
region.
- boundingBoxes(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns a sequence of boxes that bound the given
region.
- box(double, double, double, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a geospatial box value.
- box(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a geospatial box value.
- box(double, double, double, double)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- box(double, double, double, double)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial region as a box,
supplying the coordinates for the perimeter.
- boxEast(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a box's eastern boundary.
- BoxImpl(double, double, double, double)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.BoxImpl
-
- boxIntersects(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the box intersects with a
region.
- boxIntersects(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the box intersects with a
region.
- boxIntersects(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the box intersects with a
region.
- boxNorth(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a box's northern boundary.
- boxSeq(CtsBoxExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsBoxExpr items.
- boxSouth(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a box's southern boundary.
- boxWest(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a box's western boundary.
- bucket(ServerExpression, String)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an unsignedLong specifying the index of
the bucket the second parameter belongs to in buckets formed by the
first parameter.
- bucket(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an unsignedLong specifying the index of
the bucket the second parameter belongs to in buckets formed by the
first parameter.
- bucket(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an unsignedLong specifying the index of
the bucket the second parameter belongs to in buckets formed by the
first parameter.
- bucket(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an unsignedLong specifying the index of
the bucket the second parameter belongs to in buckets formed by the
first parameter.
- bucketGroup(String, String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function can be used as a named group in
functions op:group-to-arrays or op:facet-by.
- bucketGroup(XsStringVal, PlanExprCol, XsAnyAtomicTypeSeqVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function can be used as a named group in
functions op:group-to-arrays or op:facet-by.
- bucketGroup(String, String, String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function can be used as a named group in
functions op:group-to-arrays or op:facet-by.
- bucketGroup(XsStringVal, PlanExprCol, XsAnyAtomicTypeSeqVal, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function can be used as a named group in
functions op:group-to-arrays or op:facet-by.
- BufferableContentHandle<C,R> -
Interface in com.marklogic.client.io.marker
-
A Bufferable Content Handle provides an adapter
for a content representation that can be read multiple times for
purposes such as resending input when retrying after a failed
request.
- BufferableHandle - Interface in com.marklogic.client.io.marker
-
A Bufferable Handle can read content from a
byte[] buffer or write content as a byte[] buffer without changing
the state of an external resource.
- build()
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- build()
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
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.
- build(StructuredQueryDefinition...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- build(StructuredQueryDefinition...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Builds a structured query in XML from the list
of query definitions.
- buildBean()
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- bulkCaller()
- Method in interface com.marklogic.client.dataservices.ExecCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext)
- Method in interface com.marklogic.client.dataservices.ExecCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext[])
- Method in interface com.marklogic.client.dataservices.ExecCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext[], int)
- Method in interface com.marklogic.client.dataservices.ExecCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller()
- Method in interface com.marklogic.client.dataservices.InputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext)
- Method in interface com.marklogic.client.dataservices.InputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext[])
- Method in interface com.marklogic.client.dataservices.InputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext[], int)
- Method in interface com.marklogic.client.dataservices.InputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller()
- Method in interface com.marklogic.client.dataservices.InputOutputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext)
- Method in interface com.marklogic.client.dataservices.InputOutputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext[])
- Method in interface com.marklogic.client.dataservices.InputOutputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext[], int)
- Method in interface com.marklogic.client.dataservices.InputOutputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller()
- Method in interface com.marklogic.client.dataservices.OutputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext)
- Method in interface com.marklogic.client.dataservices.OutputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext[])
- Method in interface com.marklogic.client.dataservices.OutputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- bulkCaller(IOEndpoint.CallContext[], int)
- Method in interface com.marklogic.client.dataservices.OutputCaller
-
Constructs an instance of a bulk caller, which
completes a unit of work by repeated calls to the endpoint.
- byteExpr(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:byte
server data type.
- byteSeq(byte...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of byte primitives and
constructs an xs:byte sequence
- byteSeq(XsByteVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:byte values and
constructs an xs:byte sequence
- BytesHandle - Class in com.marklogic.client.io
-
A Bytes Handle represents document content as a
byte array for reading or writing.
- BytesHandle()
- Constructor for class com.marklogic.client.io.BytesHandle
-
Zero-argument constructor.
- BytesHandle(byte[])
- Constructor for class com.marklogic.client.io.BytesHandle
-
Initializes the handle with a byte array for the
content.
- BytesHandle(InputStream)
- Constructor for class com.marklogic.client.io.BytesHandle
-
Initializes the handle by reading a byte array
from an input stream.
- BytesHandle(BufferableHandle)
- Constructor for class com.marklogic.client.io.BytesHandle
-
Initializes the handle from the byte content of
another handle
- bytesToContent(byte[])
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.BytesHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.DOMHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.FileHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.InputSourceHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.InputStreamHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.JAXBHandle
-
- bytesToContent(byte[])
- Method in interface com.marklogic.client.io.marker.BufferableContentHandle
-
Converts a byte serialization to the content
representation.
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.ReaderHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.SourceHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.StringHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- bytesToContent(byte[])
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- byteVal(byte)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a byte primitive and constructs an xs:byte
value
- call()
- Method in interface com.marklogic.client.dataservices.ExecCaller
-
Makes one call to an endpoint that doesn't take
endpoint constants, endpoint state, or a session.
- call(IOEndpoint.CallContext)
- Method in interface com.marklogic.client.dataservices.ExecCaller
-
Makes one call to the endpoint for the instance
and sets the endpoint state in the Call Context.
- call(I[])
- Method in interface com.marklogic.client.dataservices.InputCaller
-
Makes one call to an endpoint that doesn't take
endpoint constants, endpoint state, or a session.
- call(IOEndpoint.CallContext, I[])
- Method in interface com.marklogic.client.dataservices.InputCaller
-
Makes one call to the endpoint for the instance
and sets the endpoint state in the Call Context.
- call(I[])
- Method in interface com.marklogic.client.dataservices.InputOutputCaller
-
Makes one call to an endpoint that doesn't take
endpoint constants, endpoint state, or a session.
- call(IOEndpoint.CallContext, I[])
- Method in interface com.marklogic.client.dataservices.InputOutputCaller
-
Makes one call to an endpoint that sets endpoint
constants, endpoint state, or a session in the Call Context.
- call()
- Method in interface com.marklogic.client.dataservices.OutputCaller
-
Makes one call to an endpoint that doesn't take
endpoint constants, endpoint state, or a session.
- call(IOEndpoint.CallContext)
- Method in interface com.marklogic.client.dataservices.OutputCaller
-
Makes one call to the endpoint for the instance
and sets the endpoint state in the Call Context.
- call()
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
A factory method for building calls to modify an
existing node by applying built-in functions or functions from a
library.
- canSerializeQueryAsJSON()
- Method in class com.marklogic.client.query.StructuredQueryBuilder.AbstractStructuredQuery
-
- Capability - Enum in com.marklogic.client.semantics
-
The permission capabilities available for
operations on graphs.
- caseExpr(PlanCase...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
This function returns the specified value
expression if the specified value expression is true.
- castableAs(ServerExpression, String, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns true if a value is castable.
- castableAs(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns true if a value is castable.
- castAs(Object, Class<?>)
- Method in class com.marklogic.client.io.DOMHandle
-
- ceil(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the smallest integer greater than or
equal to x.
- ceiling(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the smallest (closest to negative
infinity) number with no fractional part that is not less than the
value of arg.
- CertificateAuthContext(SSLContext, X509TrustManager)
- Constructor for class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
Creates a CertificateAuthContext by initializing
the SSLContext of the HTTPS channel with the SSLContext object
passed and using the TrustManger passed.
- CertificateAuthContext(SSLContext, DatabaseClientFactory.SSLHostnameVerifier, X509TrustManager)
- Constructor for class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
Creates a CertificateAuthContext by initializing
the SSLContext of the HTTPS channel with the SSLContext object
passed and assigns the SSLHostnameVerifier passed to be used for
checking host names.
- CertificateAuthContext(String, X509TrustManager)
- Constructor for class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
Creates a CertificateAuthContext with a PKCS12
file.
- CertificateAuthContext(String, String, X509TrustManager)
- Constructor for class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
Creates a CertificateAuthContext with a PKCS12
file.
- checkConnection()
- Method in interface com.marklogic.client.DatabaseClient
-
Checks if the connection is valid.
- checkContext(Node)
- Method in class com.marklogic.client.io.DOMHandle
-
- circle(double, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a geospatial circle value.
- circle(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a geospatial circle value.
- circle(double, double, double)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- circle(StructuredQueryBuilder.Point, double)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- circle(double, double, double)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial region as a circle,
supplying coordinates for the center.
- circle(StructuredQueryBuilder.Point, double)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial region as a circle,
supplying a point for the center.
- circleCenter(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a circle's center point.
- CircleImpl(double, double, double)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CircleImpl
-
- circleIntersects(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the circle intersects with a
region.
- circleIntersects(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the circle intersects with a
region.
- circleIntersects(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the circle intersects with a
region.
- circlePolygon(ServerExpression, double)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Construct a polygon approximating a
circle.
- circlePolygon(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Construct a polygon approximating a
circle.
- circlePolygon(ServerExpression, double, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Construct a polygon approximating a
circle.
- circlePolygon(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Construct a polygon approximating a
circle.
- circleRadius(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a circle's radius.
- circleSeq(CtsCircleExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsCircleExpr
items.
- clear()
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Removes all namespace bindings.
- clear()
- Method in class com.marklogic.client.util.RequestParameters
-
Removes all parameters.
- clearBindings()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Remove all variable bindings from the child
SPARQLBindings instance.
- clearHandleRegistry()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Removes the current registered associations so
the handle registry is empty.
- clearHandleRegistry()
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Removes the current registered associations so
the handle registry is empty.
- clearMetadataCategories()
- Method in interface com.marklogic.client.document.DocumentManager
-
Clears the metadata categories.
- clearPageLength()
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Reset this instance to have no page length
set.
- close()
- Method in class com.marklogic.client.datamovement.ExtractRowsViaTemplateListener
-
- close()
- Method in interface com.marklogic.client.document.DocumentPage
-
Frees the underlying resources, including the
http connection.
- close()
- Method in interface com.marklogic.client.eval.EvalResultIterator
-
- close()
- Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResultIterator
-
Closes the iterator when no longer needed.
- close()
- Method in class com.marklogic.client.io.InputSourceHandle
-
Always call close() when finished with this
handle -- it closes the underlying InputStream.
- close()
- Method in class com.marklogic.client.io.InputStreamHandle
-
Either call close() or get().close() when
finished with this handle to close the underlying
InputStream.
- close()
- Method in class com.marklogic.client.io.JacksonParserHandle
-
Always call close() when finished with this
handle -- it closes the underlying InputStream.
- close()
- Method in class com.marklogic.client.io.ReaderHandle
-
Either call close() or get().close() when
finished with this handle to close the underlying Reader.
- close()
- Method in class com.marklogic.client.io.SourceHandle
-
Always call close() when finished with this
handle -- it closes the underlying InputStream.
- close()
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Either call close() or get().close() when
finished with this handle to close the underlying
InputStream.
- close()
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Closes the XMLStreamReader and the InputStream,
if any, used to populate the XMLStreamReader.
- close()
- Method in interface com.marklogic.client.pojo.PojoPage
-
Frees the underlying resources, including the
http connection.
- close()
- Method in interface com.marklogic.client.util.RequestLogger
-
Close the log.
- coalesce(ServerExpression...)
- Method in interface com.marklogic.client.expression.SemExpr
-
Returns the value of the first argument that
evaluates without error.
- codepointEqual(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the specified parameters are the
same Unicode code point, otherwise returns false.
- codepointEqual(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the specified parameters are the
same Unicode code point, otherwise returns false.
- codepointsToString(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Creates an xs:string from a sequence of Unicode
code points.
- col(String)
- Method in interface com.marklogic.client.expression.PlanBuilder.AccessPlan
-
Identifies a column where the column name is
unique and a qualifier on the column name isn't necessary (and
might not exist).
- col(XsStringVal)
- Method in interface com.marklogic.client.expression.PlanBuilder.AccessPlan
-
Identifies a column where the column name is
unique and a qualifier on the column name isn't necessary (and
might not exist).
- col(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies a column where the column name is
unique and a qualifier on the column name isn't necessary (and
might not exist).
- col(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies a column where the column name is
unique and a qualifier on the column name isn't necessary (and
might not exist).
- collatedString(ServerExpression, String)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an rdf:collatedString value with the
given value and collation tag.
- collatedString(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an rdf:collatedString value with the
given value and collation tag.
- collection(String...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- collection(String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents belonging to at least one of
the criteria collections.
- collectionConstraint(String, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents belonging to at least one of
the criteria collections with the specified constraint.
- CollectionConstraintQuery(String, String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CollectionConstraintQuery
-
- collectionQuery(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Match documents in at least one of the specified
collections.
- collectionQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Match documents in at least one of the specified
collections.
- CollectionQuery(String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CollectionQuery
-
- collectionReference()
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to the collection lexicon,
for use as a parameter to cts:value-tuples.
- collectionReference(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to the collection lexicon,
for use as a parameter to cts:value-tuples.
- collectionReference(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to the collection lexicon,
for use as a parameter to cts:value-tuples.
- colSeq(String...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a sequence from multiple col values
to pass as a parameter to an operation.
- colSeq(PlanExprCol...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a sequence from multiple col values
to pass as a parameter to an operation.
- colType(String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Build a new column identifier; the type will
default to "none" and nullable will default to "false".
- colType(String, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Build a new column identifier; nullable will
default to "false".
- colType(String, String, Boolean)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Build a new column identifier.
- colTypes(PlanRowColTypes...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Build a sequence of column identifiers that can
be used with fromParam
.
- columnInfo(PlanBuilder.Plan, T)
- Method in interface com.marklogic.client.row.RowManager
-
This function can be used to inspect the state
of a plan before execution.
- columnInfoAs(PlanBuilder.Plan, Class<T>)
- Method in interface com.marklogic.client.row.RowManager
-
This function can be used to inspect the state
of a plan before execution.
- columnRangeQuery(String, String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
- columnRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
- columnRangeQuery(String, String, String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
- columnRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
- columnRangeQuery(String, String, String, String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
- columnRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
- columnRangeQuery(String, String, String, String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
- columnRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents matching
a TDE-view column equals to an value.
- com.marklogic.client
- package com.marklogic.client
-
The package provides the core classes,
interfaces and exceptions for working with the database.
- com.marklogic.client.admin
- package com.marklogic.client.admin
-
The package provides the classes for
configuration and initialization of the REST server.
- com.marklogic.client.alerting
- package com.marklogic.client.alerting
-
A REST interface to MarkLogic alerting
capabilities.
- com.marklogic.client.bitemporal
- package com.marklogic.client.bitemporal
-
- com.marklogic.client.datamovement
- package com.marklogic.client.datamovement
-
The MarkLogic Data Movement SDK supports
long-running write, read, delete, or transform jobs.
- com.marklogic.client.dataservices
- package com.marklogic.client.dataservices
-
- com.marklogic.client.document
- package com.marklogic.client.document
-
The package provides classes for creating,
retrieving, updating, and deleting documents in the database for
the REST server.
- com.marklogic.client.eval
- package com.marklogic.client.eval
-
- com.marklogic.client.expression
- package com.marklogic.client.expression
-
The package provides classes for building Optic
plan pipelines and expressions for execution on the REST
server.
- com.marklogic.client.extensions
- package com.marklogic.client.extensions
-
The package provides base and support classes so
you can derive a new Resource Manager to provide a client interface
for a Resource Services extension on the REST server.
- com.marklogic.client.extra.dom4j
- package com.marklogic.client.extra.dom4j
-
The package provides an adapter for using the
dom4j Open Source library to read and write XML documents, XML
structured search, and other XML data structures.
- com.marklogic.client.extra.gson
- package com.marklogic.client.extra.gson
-
The package provides an adapter for using the
GSON Open Source library to read and write JSON documents, JSON
structured search, and other JSON input and output.
- com.marklogic.client.extra.httpclient
- package com.marklogic.client.extra.httpclient
-
The package supports optional configuration of
the Open Source HttpClient library.
- com.marklogic.client.extra.jdom
- package com.marklogic.client.extra.jdom
-
The package provides an adapter for using the
JDOM Open Source library to read and write XML documents, XML
structured search, and other XML data structures.
- com.marklogic.client.extra.okhttpclient
- package com.marklogic.client.extra.okhttpclient
-
- com.marklogic.client.io
- package com.marklogic.client.io
-
The package provides the handle classes with
different representations for document content when you read
documents from the database or write documents to the
database.
- com.marklogic.client.io.marker
- package com.marklogic.client.io.marker
-
The package provides marker interfaces for
reading and writing each kind of document format.
- com.marklogic.client.pojo
- package com.marklogic.client.pojo
-
The goal of this package (sometimes referred to
as "the pojo facade" is to simplify working with custom Plain Old
Java Objects (pojos) without hassling with persistence
details.
- com.marklogic.client.pojo.annotation
- package com.marklogic.client.pojo.annotation
-
- com.marklogic.client.pojo.util
- package com.marklogic.client.pojo.util
-
- com.marklogic.client.query
- package com.marklogic.client.query
-
The package provides classes for queries
including searching documents and reading values directly from
indexes in the database for the REST server.
- com.marklogic.client.row
- package com.marklogic.client.row
-
The package provides classes for sending plan
requests to and processing row responses from the REST
server.
- com.marklogic.client.semantics
- package com.marklogic.client.semantics
-
- com.marklogic.client.type
- package com.marklogic.client.type
-
The package provides interfaces specifying the
type of an expression or value as passed to a
PlanBuilder
method or returned from a
RowRecord
method.
- com.marklogic.client.util
- package com.marklogic.client.util
-
The package provides loggers, specialized maps,
and other utilities shared across other packages.
- commit()
- Method in interface com.marklogic.client.Transaction
-
Completes the transaction, making writes and
deletes visible to other database clients.
- COMMON
- Static variable in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
The COMMON SSLHostnameVerifier applies common
rules for checking hostnames during SSL authentication (similar to
org.apache.http.conn.ssl.BrowserCompatHostnameVerifier).
- compare(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns -1, 0, or 1, depending on whether the
value of the comparand1 is respectively less than, equal to, or
greater than the value of comparand2, according to the rules of the
collation that is used.
- compare(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns -1, 0, or 1, depending on whether the
value of the comparand1 is respectively less than, equal to, or
greater than the value of comparand2, according to the rules of the
collation that is used.
- compare(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns -1, 0, or 1, depending on whether the
value of the comparand1 is respectively less than, equal to, or
greater than the value of comparand2, according to the rules of the
collation that is used.
- compare(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns -1, 0, or 1, depending on whether the
value of the comparand1 is respectively less than, equal to, or
greater than the value of comparand2, according to the rules of the
collation that is used.
- compileXPath(String)
- Method in class com.marklogic.client.io.DOMHandle
-
Compile an XPath string expression for efficient
evaluation later.
- complexPolygon(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a geospatial complex polygon
value.
- concat(ServerExpression...)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the xs:string that is the concatenation
of the values of the specified parameters.
- concatenateAfter(String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to append an existing
string to the supplied string.
- concatenateBefore(String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to concatenate an
existing string before the supplied string.
- concatenateBetween(String, String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to concatenate an
existing string between the supplied strings.
- configure(T)
- Method in interface com.marklogic.client.DatabaseClientFactory.ClientConfigurator
-
Called as the last step in configuring the
communication library.
- configure(OkHttpClient.Builder)
- Method in class com.marklogic.client.extra.okhttpclient.RemoveAcceptEncodingConfigurator
-
- containerConstraint(String, StructuredQueryDefinition)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a query within the substructure of the
container specified by the constraint.
- containerQuery(String, StructuredQueryDefinition)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- containerQuery(StructuredQueryBuilder.ContainerIndex, StructuredQueryDefinition)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a query within the substructure
contained by an element or JSON property.
- containerQueryBuilder(String, Class<C>)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Use this method to provide a query builder that
can query a nested object within your pojo.
- contains(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter contains the
string from the second parameter, otherwise returns false.
- contains(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter contains the
string from the second parameter, otherwise returns false.
- contains(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter contains the
string from the second parameter, otherwise returns false.
- contains(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter contains the
string from the second parameter, otherwise returns false.
- contains(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'contains' DE-9IM relation.
- contains(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'contains' DE-9IM relation.
- contains(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'contains' DE-9IM relation.
- contains(ServerExpression, String)
- Method in interface com.marklogic.client.expression.MapExpr
-
Returns true if the key exists in the map.
- contains(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MapExpr
-
Returns true if the key exists in the map.
- containsKey(Object)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Checks whether a prefix has a binding.
- containsKey(String)
- Method in interface com.marklogic.client.util.NameMap
-
Whether the map contains the string name as a
key.
- containsKey(Object)
- Method in class com.marklogic.client.util.RequestParameters
-
Checks whether the parameter name has been
specified.
- containsValue(Object)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Checks whether a namespace URI has a
binding.
- containsValue(Object)
- Method in class com.marklogic.client.util.RequestParameters
-
Checks whether any parameters have the
value.
- ContentDescriptor - Interface in com.marklogic.client.document
-
A Content Descriptor identifies the properties
of some content.
- ContentHandle<C> - Interface in com.marklogic.client.io.marker
-
A Content Handle provides get / set access to a
representation of content such a byte[] array, input stream, file,
reader, string, and so on.
- ContentHandleFactory - Interface in
com.marklogic.client.io.marker
-
A ContentHandleFactory creates instances of a
ContentHandle that provides an adapter for an IO
representation.
- ContentNoVersionException - Exception in
com.marklogic.client
-
Represents a "RESTAPI-CONTENTNOVERSION" error
from the REST API that can occur when using optimistic
locking.
- ContentNoVersionException(String, FailedRequest)
- Constructor for exception com.marklogic.client.ContentNoVersionException
-
- contentToBytes(Document)
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- contentToBytes(JsonElement)
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
- contentToBytes(Document)
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- contentToBytes(byte[])
- Method in class com.marklogic.client.io.BytesHandle
-
- contentToBytes(Document)
- Method in class com.marklogic.client.io.DOMHandle
-
- contentToBytes(File)
- Method in class com.marklogic.client.io.FileHandle
-
- contentToBytes(InputSource)
- Method in class com.marklogic.client.io.InputSourceHandle
-
- contentToBytes(InputStream)
- Method in class com.marklogic.client.io.InputStreamHandle
-
- contentToBytes(C)
- Method in class com.marklogic.client.io.JAXBHandle
-
- contentToBytes(C)
- Method in interface com.marklogic.client.io.marker.BufferableContentHandle
-
Converts the content representation to
bytes.
- contentToBytes(Reader)
- Method in class com.marklogic.client.io.ReaderHandle
-
- contentToBytes(Source)
- Method in class com.marklogic.client.io.SourceHandle
-
- contentToBytes(String)
- Method in class com.marklogic.client.io.StringHandle
-
- contentToBytes(XMLEventReader)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- contentToBytes(XMLStreamReader)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- ContentWrongVersionException - Exception
in com.marklogic.client
-
Represents a "RESTAPI-CONTENTWRONGVERSION" error
from the REST API that can occur when using optimistic
locking.
- ContentWrongVersionException(String, FailedRequest)
- Constructor for exception com.marklogic.client.ContentWrongVersionException
-
- convert(RawQueryByExampleDefinition, T)
- Method in interface com.marklogic.client.query.QueryManager
-
Sends a query by example to the server to
convert into a combined query that expresses the criteria as a
structured search.
- copy()
- Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Create a copy of the current registry
- copy(String)
- Method in class com.marklogic.client.util.RequestParameters
-
Creates a copy of the parameters, prepending a
namespace prefix to each parameter name.
- copyContent(T)
- Method in interface com.marklogic.client.util.RequestLogger
-
Copies content to the log during request
processing up to the length limit specified for the logger.
- correlation(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the Pearson correlation coefficient of a
data set.
- cos(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the cosine of x, in the range from -1 to
+1 (inclusive).
- cosh(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the hyperbolic cosine of x.
- cosineSimilarity(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns the cosine similarity between two
vectors.
- cot(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the cotangent of x.
- count(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the number of items in the value of
arg.
- count(ServerExpression, double)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the number of items in the value of
arg.
- count(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the number of items in the value of
arg.
- count(ServerExpression)
- Method in interface com.marklogic.client.expression.MapExpr
-
Returns the number of keys used in the
map.
- count(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the
specified input column has a value.
- count(PlanColumn)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the
specified input column has a value.
- count(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the
specified input column has a value.
- count(PlanColumn, PlanExprCol)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the
specified input column has a value.
- count(String, String, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the
specified input column has a value.
- count(PlanColumn, PlanExprCol, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function counts the rows where the
specified input column has a value.
- count()
- Method in interface com.marklogic.client.pojo.PojoRepository
-
The number of documents of the type managed by
this PojoRepository persisted in the database
- count(Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
In the context of transaction, the number of
documents of the type managed by this PojoRepository persisted in
the database
- count(String...)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
The number of documents of the type managed by
this PojoRepository persisted in the database with at least one of
the criteria collections
- count(String[], Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
In the context of transaction, the number of
documents of the type managed by this PojoRepository persisted in
the database with at least one of the criteria collections
- count(PojoQueryDefinition)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
The number of documents of the type managed by
this PojoRepository persisted in the database which match the
query
- count(PojoQueryDefinition, Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
In the context of transaction, the number of
documents of the type managed by this PojoRepository persisted in
the database which match the query
- countDistinctVertices(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Return a count of the distinct number of
vertices in a region, taking tolerance into account.
- countDistinctVertices(ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Return a count of the distinct number of
vertices in a region, taking tolerance into account.
- countDistinctVertices(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Return a count of the distinct number of
vertices in a region, taking tolerance into account.
- CountedDistinctValue - Class in com.marklogic.client.query
-
A CountedDistinctValue is a value that includes
a frequency.
- CountedDistinctValue()
- Constructor for class com.marklogic.client.query.CountedDistinctValue
-
- countVertices(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function returns a count of the number of
vertices in a region.
- covariance(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the sample covariance of a data
set.
- covarianceP(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the population covariance of a data
set.
- coveredBy(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'covered by' DE-9IM relation.
- coveredBy(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'covered by' DE-9IM relation.
- coveredBy(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'covered by' DE-9IM relation.
- covers(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'covers' DE-9IM relation.
- covers(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'covers' DE-9IM relation.
- covers(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'covers' DE-9IM relation.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
create
but create document at a specific system
time
- create(DocumentUriTemplate, W)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned
by the server.
- create(DocumentUriTemplate, W, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned
by the server as transformed on the server.
- create(DocumentUriTemplate, W, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned
by the server in an open database transaction.
- create(DocumentUriTemplate, W, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned
by the server in an open database transaction as transformed on the
server.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with metadata and
content and a uri assigned by the server.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with metadata and
content and a uri assigned by the server as transformed on the
server.
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
- create(DocumentUriTemplate, DocumentMetadataWriteHandle, W, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with metadata and
content and a uri assigned by the server in an open database
transaction as transformed on the server.
- createAs(DocumentUriTemplate, Object)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned
by the server from an object of an IO class.
- createAs(DocumentUriTemplate, Object, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned
by the server from an object of an IO class.
- createAs(DocumentUriTemplate, DocumentMetadataWriteHandle, Object)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned
by the server from an object of an IO class.
- createAs(DocumentUriTemplate, DocumentMetadataWriteHandle, Object, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a database document with a uri assigned
by the server from an object of an IO class.
- crosses(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'crosses' DE-9IM relation.
- crosses(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'crosses' DE-9IM relation.
- crosses(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'crosses' DE-9IM relation.
- crypt(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the password hash for the given
password and salt.
- crypt(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the password hash for the given
password and salt.
- crypt2(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the password hash for the given
plain-text password.
- cts
- Variable in class com.marklogic.client.expression.CtsQueryBuilder
-
Builds expressions with cts server
functions.
- cts
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with cts server
functions.
- CtsBoxExpr - Interface in com.marklogic.client.type
-
An instance of a cts.box expression.
- CtsBoxSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.box expressions.
- CtsCircleExpr - Interface in com.marklogic.client.type
-
An instance of a cts.circle expression.
- CtsCircleSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.circle expressions.
- CtsExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the cts
server library for a row pipeline.
- CtsPeriodExpr - Interface in com.marklogic.client.type
-
An instance of a cts.period expression.
- CtsPeriodSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.period expressions.
- CtsPointExpr - Interface in com.marklogic.client.type
-
An instance of a cts.point expression.
- CtsPointSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.point expressions.
- CtsPolygonExpr - Interface in com.marklogic.client.type
-
An instance of a cts.polygon expression.
- CtsPolygonSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.polygon expressions.
- CtsQueryBuilder - Class in com.marklogic.client.expression
-
CtsQueryBuilder builds a query for documents in
the database.
- CtsQueryBuilder(CtsExpr, FnExpr, GeoExpr, JsonExpr, MapExpr, MathExpr, RdfExpr, SemExpr, SpellExpr, SqlExpr, XdmpExpr, XsExpr)
- Constructor for class com.marklogic.client.expression.CtsQueryBuilder
-
- CtsQueryDefinition - Interface in
com.marklogic.client.query
-
A CtsQueryDefinition represents all kinds of cts
queries that can be performed.
- CtsQueryExpr - Interface in com.marklogic.client.type
-
An instance of a cts.query expression.
- CtsQuerySeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.query expressions.
- CtsQueryWriteHandle - Interface in
com.marklogic.client.io.marker
-
A CtsQueryWriteHandle represents a serialized
cts query.
- CtsReferenceExpr - Interface in com.marklogic.client.type
-
An instance of a cts.reference expression.
- CtsReferenceSeqExpr - Interface in
com.marklogic.client.type
-
A sequence of cts.reference expressions.
- CtsRegionExpr - Interface in com.marklogic.client.type
-
An instance of a cts.region expression.
- CtsRegionSeqExpr - Interface in com.marklogic.client.type
-
A sequence of cts.region expressions.
- cube(PlanExprColSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies a list of grouping keys
for a group and returns that group and every possible larger group
(including all rows) formed from any subset of keys.
- cube(String...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Specifies the keys for a sequence of groups that
provide a cube for a row set.
- currentDate()
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns xs:date(fn:current-dateTime()).
- currentDateTime()
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the current dateTime value (with
timezone) from the dynamic context.
- currentTime()
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns xs:time(fn:current-dateTime()).
- customConstraint(String, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents as specified by a constraint
that implements a custom query parameterized with the supplied
text.
- CustomConstraintQuery(String, String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.CustomConstraintQuery
-
- DatabaseClient - Interface in com.marklogic.client
-
A Database Client instantiates document and
query managers and other objects with shared access to a
database.
- DatabaseClient.ConnectionResult -
Interface in com.marklogic.client
-
- DatabaseClient.ConnectionType - Enum in
com.marklogic.client
-
Identifies whether the client connects directly
to MarkLogic (the default) or by means of a gateway such as a load
balancer.
- DatabaseClientBuilder - Class in com.marklogic.client
-
Intended to support programmatically building a
DatabaseClient
via chained "with" methods for setting
each possible input allowed for connecting to and authenticating
with MarkLogic.
- DatabaseClientBuilder()
- Constructor for class com.marklogic.client.DatabaseClientBuilder
-
- DatabaseClientBuilder(Map<String, Object>)
- Constructor for class com.marklogic.client.DatabaseClientBuilder
-
Initialize the builder with the given set of
properties.
- DatabaseClientFactory - Class in com.marklogic.client
-
A Database Client Factory configures a database
client for making database requests.
- DatabaseClientFactory.BasicAuthContext -
Class in com.marklogic.client
-
- DatabaseClientFactory.Bean - Class in
com.marklogic.client
-
A Database Client Factory Bean provides an
object for specifying configuration before creating a client to
make database requests.
- DatabaseClientFactory.CertificateAuthContext
- Class in com.marklogic.client
-
- DatabaseClientFactory.ClientConfigurator<T>
- Interface in com.marklogic.client
-
A ClientConfigurator provides custom
configuration for the communication library used to sending client
requests and receiving server responses.
- DatabaseClientFactory.DigestAuthContext -
Class in com.marklogic.client
-
- DatabaseClientFactory.HandleFactoryRegistry
- Interface in com.marklogic.client
-
A HandleFactoryRegistry associates IO
representation classes with handle factories.
- DatabaseClientFactory.KerberosAuthContext
- Class in com.marklogic.client
-
- DatabaseClientFactory.KerberosConfig -
Class in com.marklogic.client
-
- DatabaseClientFactory.MarkLogicCloudAuthContext
- Class in com.marklogic.client
-
- DatabaseClientFactory.OAuthContext -
Class in com.marklogic.client
-
- DatabaseClientFactory.SAMLAuthContext -
Class in com.marklogic.client
-
A SAMLAuthContext is used for authorization
using SAML.
- DatabaseClientFactory.SAMLAuthContext.AuthorizerCallback
- Interface in com.marklogic.client
-
A callback for getting a SAML assertions token
from the IDP (Identity Provider).
- DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth
- Interface in com.marklogic.client
-
ExpiringSAMLAuth is used by SAMLAuthContext when
renewing a SAML assertions token.
- DatabaseClientFactory.SAMLAuthContext.RenewerCallback
- Interface in com.marklogic.client
-
A callback for renewing the SAML assertions
token with the IDP (Identity Provider) by extending the expiration
time.
- DatabaseClientFactory.SecurityContext -
Interface in com.marklogic.client
-
- DatabaseClientFactory.SSLHostnameVerifier
- Interface in com.marklogic.client
-
An SSLHostnameVerifier checks whether a hostname
is acceptable during SSL authentication.
- DatabaseClientFactory.SSLHostnameVerifier.Builtin
- Class in com.marklogic.client
-
Builtin supports builtin implementations of
SSLHostnameVerifier.
- DatabaseClientFactory.SSLHostnameVerifier.HostnameVerifierAdapter
- Class in com.marklogic.client
-
HostnameVerifierAdapter verifies the
hostname,SSLSession and X509Certificate certificate.
- DataMovementException - Exception in
com.marklogic.client.datamovement
-
The generic base exception used throughout the
Data Movement SDK.
- DataMovementException(String, Throwable)
- Constructor for exception
com.marklogic.client.datamovement.DataMovementException
-
- DataMovementManager - Interface in
com.marklogic.client.datamovement
-
DataMovementManager is the starting point for
getting new instances of QueryBatcher, WriteBatcher and RowBatcher,
configured with a DatabaseClient and ForestConfiguration.
- datatype(ServerExpression)
- Method in interface com.marklogic.client.expression.SemExpr
-
Returns the name of the simple type of the
atomic value argument as a SPARQL style IRI.
- date(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:date
server data type.
- date(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a date in a string format based on ISO
8601 and constructs an xs:date value
- date(Calendar)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a date as a Calendar value and constructs
an xs:date value
- date(XMLGregorianCalendar)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a date as an XMLGregorianCalendar value
and constructs an xs:date value
- dateadd(ServerExpression, int, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a specified date with the specified
number interval (signed integer) added to a specified datepart of
that date
- dateadd(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a specified date with the specified
number interval (signed integer) added to a specified datepart of
that date
- datediff(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns the count (signed integer) of the
specified datepart boundaries crossed between the specified
startdate and enddate.
- datepart(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an integer that represents the specified
datepart of the specified date.
- dateSeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of dates in a string format
based on ISO 8601 and constructs an xs:date sequence
- dateSeq(Calendar...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of dates as Calendar values and
constructs an xs:date sequence
- dateSeq(XMLGregorianCalendar...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of dates as
XMLGregorianCalendar values and constructs an xs:date
sequence
- dateSeq(XsDateVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:date values and
constructs an xs:date sequence
- dateTime(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:dateTime value created by
combining an xs:date and an xs:time.
- dateTime(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:dateTime value created by
combining an xs:date and an xs:time.
- dateTime(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:dateTime server data type.
- dateTime(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a timestamp in a string format based on
ISO 8601 and constructs an xs:dateTime value
- dateTime(Date)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a timestamp as a Date value and constructs
an xs:dateTime value
- dateTime(Calendar)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a timestamp as a Calendar value and
constructs an xs:dateTime value
- dateTime(XMLGregorianCalendar)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a timestamp as an XMLGregorianCalendar
value and constructs an xs:dateTime value
- dateTimeSeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of timestamps in a string
format based on ISO 8601 and constructs an xs:dateTime
sequence
- dateTimeSeq(Date...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of timestamps as Date values
and constructs an xs:dateTime sequence
- dateTimeSeq(Calendar...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of timestamps as Calendar
values and constructs an xs:dateTime sequence
- dateTimeSeq(XMLGregorianCalendar...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of timestamps as
XMLGregorianCalendar values and constructs an xs:dateTime
sequence
- dateTimeSeq(XsDateTimeVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:dateTime values and
constructs an xs:dateTime sequence
- day(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:integer between 1 and 31, both
inclusive, representing the day component in the localized value of
arg.
- dayFromDate(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer between 1 and 31, both
inclusive, representing the day component in the localized value of
arg.
- dayFromDateTime(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer between 1 and 31, both
inclusive, representing the day component in the localized value of
arg.
- dayname(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:string representing the dayname
value in the localized value of arg.
- daynameFromDate(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string representing the dayname value
in the localized value of arg.
- daysFromDuration(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:integer representing the days
component in the canonical lexical representation of the value of
arg.
- dayTimeDuration(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:dayTimeDuration server data type.
- dayTimeDuration(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a duration of increments of a day or less
in a string format based on ISO 8601 and constructs an
xs:dayTimeDuration value
- dayTimeDuration(Duration)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a duration in increments of a day or less
as a Duration value and constructs an xs:dayTimeDuration
value
- dayTimeDurationSeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of duration in increments of a
day or less as a string and constructs an xs:dayTimeDuration
sequence
- dayTimeDurationSeq(Duration...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of duration in increments of a
day or less as a Duration and constructs an xs:dayTimeDuration
sequence
- dayTimeDurationSeq(XsDayTimeDurationVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:dayTimeDuration values
and constructs an xs:dayTimeDuration sequence
- decimal(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:decimal server data type.
- decimal(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a real number as a decimal string and
constructs an xs:decimal value
- decimal(long)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a real number as a long primitive and
constructs an xs:decimal value
- decimal(double)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a real number as a double primitive and
constructs an xs:decimal value
- decimal(BigDecimal)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a real number as a BigDecimal value and
constructs an xs:decimal value
- decimalSeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of real numbers as a string and
constructs an xs:decimal sequence
- decimalSeq(long...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of real numbers as a long
primitive and constructs an xs:decimal sequence
- decimalSeq(double...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of real numbers as a double
primitive and constructs an xs:decimal sequence
- decimalSeq(BigDecimal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of real numbers as a BigDecimal
value and constructs an xs:decimal sequence
- decimalSeq(XsDecimalVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:decimal values and
constructs an xs:decimal sequence
- decodeFromNCName(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Invertible function that decodes characters an
NCName produced by xdmp:encode-for-NCName.
- decrementArrayDepth()
- Method in class com.marklogic.client.datamovement.JSONSplitter.ArrayVisitor
-
Decrement array depth by 1 while traversing the
JSON tree.
- deepEqual(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
This function assesses whether two sequences are
deep-equal to each other.
- deepEqual(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
This function assesses whether two sequences are
deep-equal to each other.
- deepEqual(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
This function assesses whether two sequences are
deep-equal to each other.
- DEFAULT_GRAPH
- Static variable in interface
com.marklogic.client.semantics.GraphManager
-
Use with any GraphManager method in place of the
uri to work against the default graph.
- DEFAULT_PAGE_LENGTH
- Static variable in interface com.marklogic.client.query.QueryManager
-
The default maximum number of documents in a
page of search results.
- DEFAULT_SPLITTER_KEY
- Static variable in class
com.marklogic.client.datamovement.PathSplitter
-
The default splitter key in splitterMap
- defaultCollation()
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the value of the default collation
property from the static context.
- defaultGraphIri()
- Method in interface com.marklogic.client.expression.SemExpr
-
Returns the iri of the default graph.
- degrees(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns numeric expression converted from
radians to degrees.
- delete(String)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Removes a library asset from the server.
- delete(ExtensionLibraryDescriptor)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Removes a library asset from the server.
- delete(String)
- Method in interface com.marklogic.client.alerting.RuleManager
-
Removes a rule from the server.
- delete(DocumentDescriptor, Transaction, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- delete(String, Transaction, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- delete(DocumentDescriptor, Transaction, String, Calendar)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
delete
but delete document at a specified system
time
- delete(String, Transaction, String, Calendar)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
delete
but delete document at a specified system
time
- delete(String)
- Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from
the database To call delete(), an application must authenticate as
rest-writer or rest-admin.
- delete(String, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from
an open database transaction To call delete(), an application must
authenticate as rest-writer or rest-admin.
- delete(String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the documents' metadata and content To
call delete(), an application must authenticate as rest-writer or
rest-admin.
- delete(Transaction, String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the documents' metadata and content from
an open database transaction To call delete(), an application must
authenticate as rest-writer or rest-admin.
- delete(DocumentDescriptor)
- Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from
the database To call delete(), an application must authenticate as
rest-writer or rest-admin.
- delete(DocumentDescriptor, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Deletes the document metadata and content from
an open database transaction To call delete(), an application must
authenticate as rest-writer or rest-admin.
- delete(String)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies an operation to delete an existing
JSON or XML fragment.
- delete(String, DocumentMetadataPatchBuilder.Cardinality)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies an operation to delete an existing
JSON or XML fragment.
- delete(RequestParameters, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Deletes content by calling a DELETE
service.
- delete(RequestParameters, Transaction, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Deletes content by calling a DELETE
service.
- delete(ID...)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Deletes from the database the persisted pojo
instances with the corresponding ids
- delete(ID[], Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
As part of transaction, deletes from the
database the documents with the corresponding ids
- delete(DeleteQueryDefinition)
- Method in interface com.marklogic.client.query.QueryManager
-
Deletes documents based on the query
criteria.
- delete(DeleteQueryDefinition, Transaction)
- Method in interface com.marklogic.client.query.QueryManager
-
Deletes documents based on the query criteria as
part of the specified transaction.
- delete(String)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Permanently delete the specified graph from the
server.
- delete(String, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Permanently delete the specified graph from the
server.
- deleteAll()
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Deletes from the database all documents of the
type managed by this PojoRepositoryof type T persisted by the pojo
facade
- deleteAll(Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
As part of transaction, deletes from the
database all documents of the type managed by this PojoRepositoryof
type T persisted by the pojo facade
- deleteCollection(String...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified collections.
- deleteGraphs()
- Method in interface com.marklogic.client.semantics.GraphManager
-
Permanently delete all quads from all
graphs.
- deleteGraphs(Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Permanently delete all quads from all
graphs.
- DeleteListener - Class in com.marklogic.client.datamovement
-
Sends a Java API bulk
delete
request for all the documents from each
batch.
- DeleteListener()
- Constructor for class com.marklogic.client.datamovement.DeleteListener
-
- deleteMetadataValue(String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified metadata-value with the
given key.
- deleteOptions(String)
- Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Remove a search configuration from the REST
server.
- deletePermission(String...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified roles.
- deletePermissions(String)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Delete all permissions for the graph.
- deletePermissions(String, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Delete all permissions for the graph.
- deleteProperty(String...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified metadata properties with
simple names.
- deleteProperty(QName...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Deletes the specified metadata properties with
namespaced names.
- DeleteQueryDefinition - Interface in
com.marklogic.client.query
-
A DeleteQueryDefinition is a query definition
suitable for use in performing a delete query.
- deleteServices(String)
- Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Uninstalls the services that implement a
resource.
- deleteTransform(String)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Uninstalls the transform.
- desc(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function sorts the rows by the values of
the specified column in descending order.
- desc(PlanExprCol)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function sorts the rows by the values of
the specified column in descending order.
- describe(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string representing the description of
a given item sequence.
- describe(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string representing the description of
a given item sequence.
- describe(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string representing the description of
a given item sequence.
- destination(ServerExpression, double, double)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the point at the given distance (in
units) along the given bearing (in radians) from the starting
point.
- destination(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the point at the given distance (in
units) along the given bearing (in radians) from the starting
point.
- destination(ServerExpression, double, double, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the point at the given distance (in
units) along the given bearing (in radians) from the starting
point.
- destination(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the point at the given distance (in
units) along the given bearing (in radians) from the starting
point.
- diacriticLess(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the specified string, converting all of
the characters with diacritics to characters without
diacritics.
- DigestAuthContext(String, String)
- Constructor for class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- dimension(ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns the dimension of the vector passed
in.
- directory(boolean, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches documents at the specified depth within
at least one of the criteria directories.
- directoryQuery(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the
directories with the given URIs.
- directoryQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the
directories with the given URIs.
- directoryQuery(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the
directories with the given URIs.
- directoryQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents in the
directories with the given URIs.
- DirectoryQuery(Boolean, String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.DirectoryQuery
-
- disableDefault()
- Method in interface com.marklogic.client.document.DocumentWriteSet
-
Removes the default metadata for this write set
for all documents added after this call
- disjoint(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'disjoint' DE-9IM relation.
- disjoint(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'disjoint' DE-9IM relation.
- disjoint(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'disjoint' DE-9IM relation.
- distance(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the distance (in units) between two
points.
- distance(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the distance (in units) between two
points.
- distance(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the distance (in units) between two
points.
- distanceConvert(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function converts a distance from one unit
of measure to another.
- distanceConvert(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function converts a distance from one unit
of measure to another.
- distinctValues(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the sequence that results from removing
from arg all but one of a set of values that are eq to one
other.
- distinctValues(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the sequence that results from removing
from arg all but one of a set of values that are eq to one
other.
- distinctValues(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the sequence that results from removing
from arg all but one of a set of values that are eq to one
other.
- divide(ServerExpression, ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function divides the left numericExpression
by the right numericExpression and returns the value.
- divideBy(Number)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to divide an existing
value by the supplied number.
- docCols()
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a document column identifier object
for columns of uri, doc, collections, metadata, permissions,
quality and temporalCollection.
- docCols(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a document column identifier object
for columns of uri, doc, collections, metadata, permissions,
quality and temporalCollection.
- docCols(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a document column identifier object
for columns of uri, doc, collections, metadata, permissions,
quality and temporalCollection.
- docCols(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a document column identifier object
for columns of uri, doc, collections, metadata, permissions,
quality and temporalCollection.
- docCols(XsStringVal, XsStringSeqVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a document column identifier object
for columns of uri, doc, collections, metadata, permissions,
quality and temporalCollection.
- docCols(Map<String, PlanColumn>)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Construct a mapping of document descriptor
column names to columns in the plan.
- docColTypes()
- Method in class com.marklogic.client.expression.PlanBuilder
-
Provides the 3rd parameter for op:from-param for
row column types.
- docDescriptor(DocumentWriteOperation)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Build a single doc descriptor that can be used
with fromDocDescriptors
.
- docDescriptors(DocumentWriteSet)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Build a sequence of doc descriptors that can be
used with fromDocDescriptors
.
- document(String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the specified documents.
- DocumentDescriptor - Interface in
com.marklogic.client.document
-
A Document Descriptor describes a database
document.
- documentFormatQuery(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents of a given
format.
- documentFormatQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents of a given
format.
- documentFragment(StructuredQueryDefinition)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Associates a query with the content of documents
(as opposed to the properties of documents).
- documentFragmentQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query that matches all documents where
query matches any document fragment.
- DocumentFragmentQuery(StructuredQueryDefinition)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.DocumentFragmentQuery
-
- DocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>
- Interface in com.marklogic.client.document
-
A Document Manager provides database operations
on a document.
- DocumentManager.Metadata - Enum in
com.marklogic.client.document
-
The Metadata enumeration specifies the
categories of metadata read from or written to the database.
- DocumentMetadataHandle - Class in
com.marklogic.client.io
-
A DocumentMetadataHandle represents the metadata
for a database document.
- DocumentMetadataHandle()
- Constructor for class com.marklogic.client.io.DocumentMetadataHandle
-
Zero-argument constructor.
- DocumentMetadataHandle.Capability - Enum
in com.marklogic.client.io
-
A document operation restricted to users with a
role.
- DocumentMetadataHandle.DocumentCollections
- Interface in com.marklogic.client.io
-
Represents the collections for a database
document.
- DocumentMetadataHandle.DocumentMetadataValues
- Interface in com.marklogic.client.io
-
Represents the metadata-values for a database
document.
- DocumentMetadataHandle.DocumentPermissions
- Interface in com.marklogic.client.io
-
Represents the permissions for a database
document.
- DocumentMetadataHandle.DocumentProperties
- Interface in com.marklogic.client.io
-
Represents the properties for a database
document.
- DocumentMetadataPatchBuilder - Interface
in com.marklogic.client.document
-
A DocumentMetadataPatchBuilder specifies changes
to the metadata of a database document.
- DocumentMetadataPatchBuilder.Call -
Interface in com.marklogic.client.document
-
A Call specifies how to apply a built-in or
library function when replacing an existing fragment.
- DocumentMetadataPatchBuilder.CallBuilder
- Interface in com.marklogic.client.document
-
A CallBuilder constructs a Call to a built-in or
library function to produce the replacement for an existing
fragment.
- DocumentMetadataPatchBuilder.Cardinality
- Enum in com.marklogic.client.document
-
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).
- DocumentMetadataPatchBuilder.PatchHandle
- Interface in com.marklogic.client.document
-
A PatchHandle produced by the builder can
produce a string representation of the patch for saving, logging,
or other uses.
- DocumentMetadataReadHandle - Interface in
com.marklogic.client.io.marker
-
A Metadata Read Handle can represent metadata
read from the database.
- DocumentMetadataWriteHandle - Interface
in com.marklogic.client.io.marker
-
A Document Metadata Write Handle can represent
document metadata written to the database.
- DocumentPage - Interface in com.marklogic.client.document
-
Allows iteration over documents in the page as
DocumentRecord
instances.
- DocumentPatchBuilder - Interface in
com.marklogic.client.document
-
A DocumentPatchBuilder specifies changes to the
metadata, content, or both of a database document.
- DocumentPatchBuilder.PathLanguage - Enum
in com.marklogic.client.document
-
MarkLogic's REST API patch operations support
two path languages for JSON, XPATH and JSONPATH.
- DocumentPatchBuilder.Position - Enum in
com.marklogic.client.document
-
The Position enumeration indicates the location
relative to the context for inserting content.
- DocumentPatchHandle - Interface in
com.marklogic.client.io.marker
-
A Document Patch Handle can represent a patch
with changes to document metadata or structured content.
- documentPermissionQuery(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents with a given
permission.
- documentPermissionQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents with a given
permission.
- documentQuery(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents with the
given URIs.
- documentQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents with the
given URIs.
- DocumentQuery(String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.DocumentQuery
-
- DocumentRecord - Interface in com.marklogic.client.document
-
Each DocumentRecord represents one document, its
uri, format, mime-type and possibly its metadata (collections,
properties, quality, and permissions).
- documentRootQuery(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents with a given
root element.
- documentRootQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching documents with a given
root element.
- documentUri(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the value of the document-uri property
for the specified node.
- DocumentUriTemplate - Interface in
com.marklogic.client.document
-
A DocumentUriTemplate specifies how the server
should construct a name for a document.
- DocumentWriteOperation - Interface in
com.marklogic.client.document
-
- DocumentWriteOperation.DocumentUriMaker -
Interface in com.marklogic.client.document
-
- DocumentWriteOperation.OperationType -
Enum in com.marklogic.client.document
-
- DocumentWriteSet - Interface in com.marklogic.client.document
-
- DOM4JHandle - Class in com.marklogic.client.extra.dom4j
-
A DOM4JHandle represents XML content as a dom4j
document for reading or writing.
- DOM4JHandle()
- Constructor for class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Zero-argument constructor.
- DOM4JHandle(Document)
- Constructor for class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Provides a handle on XML content as a dom4j
document structure.
- DOMAIN
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- DOMHandle - Class in com.marklogic.client.io
-
A DOM Handle represents XML content as a DOM
document for reading or writing.
- DOMHandle()
- Constructor for class com.marklogic.client.io.DOMHandle
-
Zero-argument constructor.
- DOMHandle(Document)
- Constructor for class com.marklogic.client.io.DOMHandle
-
Initializes the handle with a DOM document for
the content.
- dotProduct(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns the dot product between two
vectors.
- doubleExpr(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:double server data type.
- doubleMetaphone(ServerExpression)
- Method in interface com.marklogic.client.expression.SpellExpr
-
Given a word returns the two metaphone
keys.
- doubleSeq(double...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of double primitives and
constructs an xs:double sequence
- doubleSeq(XsDoubleVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:double values and
constructs an xs:double sequence
- doubleVal(double)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a double primitive and constructs an
xs:double value
- DraconianErrorHandler()
- Constructor for class com.marklogic.client.io.InputSourceHandle.DraconianErrorHandler
-
- EditableNamespaceContext - Class in
com.marklogic.client.util
-
EditableNamespaceContext provides access to
namespace bindings of prefixes and URIs and can act as a
NamespaceContext.
- EditableNamespaceContext()
- Constructor for class com.marklogic.client.util.EditableNamespaceContext
-
Constructs a NamespaceContext.
- element(QName)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a namespaced element to match with a
query.
- element(String)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a simple element to match with a
query.
- elementAttribute(StructuredQueryBuilder.Element, StructuredQueryBuilder.Attribute)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies an element having an attribute to
match with a query.
- elementAttributePairGeospatialQuery(String, String, String, CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(String, String, String, ServerExpression, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(String, String, String, ServerExpression, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
- elementAttributePairGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific attributes representing latitude and longitude values
for a point contained within the given geographic box, circle, or
polygon, or equal to the given point.
- elementAttributeRangeQuery(String, String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
- elementAttributeRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
- elementAttributeRangeQuery(String, String, String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
- elementAttributeRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
- elementAttributeRangeQuery(String, String, String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
- elementAttributeRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches
element-attributes by name with a range-index entry equal to a
given value.
- elementAttributeReference(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element attribute
value lexicon, for use as a parameter to cts:value-tuples.
- elementAttributeReference(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element attribute
value lexicon, for use as a parameter to cts:value-tuples.
- elementAttributeReference(String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element attribute
value lexicon, for use as a parameter to cts:value-tuples.
- elementAttributeReference(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element attribute
value lexicon, for use as a parameter to cts:value-tuples.
- elementAttributeValueQuery(String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(String, String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(String, String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
- elementAttributeValueQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content equal a given phrase.
- elementAttributeWordQuery(String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
- elementAttributeWordQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
- elementAttributeWordQuery(String, String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
- elementAttributeWordQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
- elementAttributeWordQuery(String, String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
- elementAttributeWordQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
attributes by name with text content containing a given
phrase.
- elementChildGeospatialQuery(String, String, CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(String, String, ServerExpression, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(String, String, ServerExpression, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementChildGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementContentType(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the schema-defined content-type of an
element ("empty", "simple", "element-only", or "mixed").
- elementGeospatialQuery(String, CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(String, ServerExpression, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(String, ServerExpression, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- elementGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(String, String, String, CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(String, String, String, ServerExpression, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(String, String, String, ServerExpression, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementPairGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name which
has specific element children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- elementQuery(String, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches elements by name
with the content constrained by the query given in the second
parameter.
- elementQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches elements by name
with the content constrained by the query given in the second
parameter.
- elementRangeQuery(String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches elements by name
with range index entry equal to a given value.
- elementRangeQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches elements by name
with range index entry equal to a given value.
- elementRangeQuery(String, String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches elements by name
with range index entry equal to a given value.
- elementRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches elements by name
with range index entry equal to a given value.
- elementRangeQuery(String, String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches elements by name
with range index entry equal to a given value.
- elementRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a query that matches elements by name
with range index entry equal to a given value.
- elementReference(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element value lexicon,
for use as a parameter to cts:value-tuples, temporal:axis-create,
or any other function that takes an index reference.
- elementReference(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element value lexicon,
for use as a parameter to cts:value-tuples, temporal:axis-create,
or any other function that takes an index reference.
- elementReference(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element value lexicon,
for use as a parameter to cts:value-tuples, temporal:axis-create,
or any other function that takes an index reference.
- elementReference(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to an element value lexicon,
for use as a parameter to cts:value-tuples, temporal:axis-create,
or any other function that takes an index reference.
- elementValueQuery(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content equal a given phrase.
- elementValueQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content equal a given phrase.
- elementValueQuery(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content equal a given phrase.
- elementValueQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content equal a given phrase.
- elementValueQuery(String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content equal a given phrase.
- elementValueQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content equal a given phrase.
- elementValueQuery(String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content equal a given phrase.
- elementValueQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content equal a given phrase.
- elementWordQuery(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content containing a given phrase.
- elementWordQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content containing a given phrase.
- elementWordQuery(String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content containing a given phrase.
- elementWordQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content containing a given phrase.
- elementWordQuery(String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content containing a given phrase.
- elementWordQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching elements by name with
text content containing a given phrase.
- ellipsePolygon(ServerExpression, double, double, double, double)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Construct a polygon approximating an
ellipse.
- ellipsePolygon(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Construct a polygon approximating an
ellipse.
- ellipsePolygon(ServerExpression, double, double, double, double, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Construct a polygon approximating an
ellipse.
- ellipsePolygon(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Construct a polygon approximating an
ellipse.
- elseExpr(ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
This function returns the specified value if
none of the preceeding when() conditions are true.
- empty(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
If the value of arg is the empty sequence, the
function returns true; otherwise, the function returns false.
- encodeForNCName(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Invertible function that escapes characters
required to be part of an NCName.
- encodeForUri(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Invertible function that escapes characters
required to be escaped inside path segments of URIs.
- endArray(String)
- Method in class com.marklogic.client.datamovement.JSONSplitter.ArrayVisitor
-
Receives a notification when hitting end of
array, and decreases arrayDepth.
- endArray(String)
- Method in class com.marklogic.client.datamovement.JSONSplitter.Visitor
-
Receives a notification when hitting end of
array.
- endElement(String, String)
- Method in class com.marklogic.client.datamovement.XMLSplitter.Visitor
-
Receives a notification when hitting end
element.
- endObject(String)
- Method in class com.marklogic.client.datamovement.JSONSplitter.Visitor
-
Receives a notification when hitting the end of
current object.
- endsWith(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter ends with
the string from the second parameter, otherwise returns
false.
- endsWith(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter ends with
the string from the second parameter, otherwise returns
false.
- endsWith(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter ends with
the string from the second parameter, otherwise returns
false.
- endsWith(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter ends with
the string from the second parameter, otherwise returns
false.
- entry(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MapExpr
-
Constructs a new map with a single entry
consisting of the key and value specified as arguments.
- entrySet()
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Gets the namespace bindings.
- entrySet()
- Method in class com.marklogic.client.util.RequestParameters
-
Returns a set of parameter-list entries.
- eq(ServerExpression...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function takes two or more expressions and
returns true if all of the expressions return the same value.
- equals(Object)
- Method in class com.marklogic.client.admin.ResourceExtensionsManager.MethodParameters
-
Returns whether the method declaration is the
same.
- equals(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'equals' DE-9IM relation.
- equals(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'equals' DE-9IM relation.
- equals(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'equals' DE-9IM relation.
- EQUIVALENT_CLASS
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- EQUIVALENT_PROPERTY
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- error(SAXParseException)
- Method in class com.marklogic.client.io.InputSourceHandle.DraconianErrorHandler
-
Throws the error as a parse exception.
- escapeHtmlUri(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
%-escapes everything except printable ASCII
characters.
- ETRS89
- Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to "etrs89"
- ETRS89DOUBLE
- Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to
"etrs89/double"
- euclideanDistance(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns the Euclidean distance between two
vectors.
- eval(H)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Provides the single result of the server-side
eval or invoke call, wrapped in an io handle.
- eval()
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Provides all results returned by the server-side
eval or invoke call.
- evalAs(Class<T>)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Conveneince method to get the response
serialized to a particular type by an io handle.
- EvalResult - Interface in com.marklogic.client.eval
-
Represents the content and metadata of a result
from a call to
eval
.
- EvalResult.Type - Enum in com.marklogic.client.eval
-
Convenience enum useful for strongly-typed
comparison to ensure the result is of the type expected.
- EvalResultIterator - Interface in
com.marklogic.client.eval
-
- evaluateXPath(String, Class<T>)
- Method in class com.marklogic.client.io.DOMHandle
-
Evaluate a string XPath expression against the
retrieved document.
- evaluateXPath(String, Node, Class<T>)
- Method in class com.marklogic.client.io.DOMHandle
-
Evaluate a string XPath expression relative to a
node such as a node returned by a previous XPath expression.
- evaluateXPath(XPathExpression, Class<T>)
- Method in class com.marklogic.client.io.DOMHandle
-
Evaluate a compiled XPath expression against the
retrieved document.
- evaluateXPath(XPathExpression, Node, Class<T>)
- Method in class com.marklogic.client.io.DOMHandle
-
Evaluate a compiled XPath expression relative to
a node such as a node returned by a previous XPath
expression.
- except(PlanBuilder.ModifyPlan)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method restricts the left row set to rows
where a row with the same columns and values doesn't exist in the
right row set.
- ExecCaller - Interface in com.marklogic.client.dataservices
-
Provides an interface for calling an endpoint
that doesn't take input data structures or return output data
structures.
- ExecCaller.BulkExecCaller - Interface in
com.marklogic.client.dataservices
-
Provides an interface for completing a unit of
work by repeated calls to an endpoint that doesn't take input data
structure or return output data structures.
- ExecCaller.BulkExecCaller.ErrorListener -
Interface in com.marklogic.client.dataservices
-
- execute(PlanBuilder.Plan)
- Method in interface com.marklogic.client.row.RowManager
-
Execute the given plan without returning any
result.
- execute(PlanBuilder.Plan, Transaction)
- Method in interface com.marklogic.client.row.RowManager
-
Execute the given plan without returning any
result.
- executeAsk(SPARQLQueryDefinition)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "ASK" statement.
- executeAsk(SPARQLQueryDefinition, Transaction)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "ASK" statement.
- executeConstruct(SPARQLQueryDefinition, T)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "CONSTRUCT" statement.
- executeConstruct(SPARQLQueryDefinition, T, Transaction)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "CONSTRUCT" statement.
- executeDescribe(SPARQLQueryDefinition, T)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "DESCRIBE" query (which
implements the Concise Bounded Description specification).
- executeDescribe(SPARQLQueryDefinition, T, Transaction)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "DESCRIBE" query (which
implements the Concise Bounded Description specification).
- executeSelect(SPARQLQueryDefinition, T)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "SELECT" query.
- executeSelect(SPARQLQueryDefinition, T, Transaction)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "SELECT" query.
- executeSelect(SPARQLQueryDefinition, T, long)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "SELECT" query.
- executeSelect(SPARQLQueryDefinition, T, long, Transaction)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL "SELECT" query.
- executeUpdate(SPARQLQueryDefinition)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL update statement.
- executeUpdate(SPARQLQueryDefinition, Transaction)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Execute a SPARQL update statement.
- exists(String)
- Method in interface com.marklogic.client.alerting.RuleManager
-
Tests for existence of rule on the REST
server.
- exists(String)
- Method in interface com.marklogic.client.document.DocumentManager
-
Checks whether a document exists and gets its
byte length, format, mimetype, and version if it does.
- exists(String, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Checks whether a document exists in an open
transaction and gets its byte length, format, mimetype, and version
if it does.
- exists(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
If the value of arg is not the empty sequence,
the function returns true; otherwise, the function returns
false.
- exists(ID)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
True if a document exists in the database with
the specified id
- exists(ID, Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
True if in the context of transaction, a
document exists in the database with the specified id
- existsJoin(PlanBuilder.ModifyPlan)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- existsJoin(PlanBuilder.ModifyPlan, PlanJoinKey...)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- existsJoin(PlanBuilder.ModifyPlan, PlanJoinKeySeq)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- existsJoin(PlanBuilder.ModifyPlan, PlanJoinKeySeq, boolean)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- existsJoin(PlanBuilder.ModifyPlan, PlanJoinKeySeq, ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- exp(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns e (approximately 2.71828182845905) to
the xth power.
- explain(PlanBuilder.Plan, T)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs a plan for retrieving a set of
database rows and returns a handle for the explanation of the plan
as a JSON or XML structure.
- explainAs(PlanBuilder.Plan, Class<T>)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs a plan for retrieving a set of
database rows and returns an explanation of the plan in the
representation specified by the IO class.
- export(CtsQueryExpr, T)
- Method in class com.marklogic.client.expression.CtsQueryBuilder
-
Export cts query into a handle in AST
format
- export(T)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ExportablePlanBase
-
This method exports the plan to an AST (Abstract
Sytax Tree) using the specified JSON handle.
- exportAs(Class<T>)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ExportablePlanBase
-
This method exports the plan to an AST (Abstract
Sytax Tree) using the specified JSON handle.
- ExportListener - Class in com.marklogic.client.datamovement
-
Reads document contents (and optionally
metadata) for each batch, then sends each document to any listeners
registered with
onDocumentReady
for further processing or writing
to any target supported by Java.
- ExportListener()
- Constructor for class com.marklogic.client.datamovement.ExportListener
-
- exportQueryDefinition(T)
- Method in class com.marklogic.client.alerting.RuleDefinition
-
Exports the embedded query definitions and
options to a handle
- ExportToWriterListener - Class in
com.marklogic.client.datamovement
-
An extension of ExportListener which facilitates
writing all documents to a single Writer output stream.
- ExportToWriterListener(Writer)
- Constructor for class com.marklogic.client.datamovement.ExportToWriterListener
-
- ExportToWriterListener.OutputListener -
Interface in com.marklogic.client.datamovement
-
The listener interface required by
onGenerateOutput.
- ExtensionLibrariesManager - Interface in
com.marklogic.client.admin
-
ExtensionLibrariesManager provides methods to
read, list and update server-side XQuery modules that reside in the
REST instanance's modules database.
- ExtensionLibraryDescriptor - Class in
com.marklogic.client.admin
-
Identifies a module in the REST server's modules
database.
- ExtensionLibraryDescriptor()
- Constructor for class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
No-argument constructor.
- ExtensionLibraryDescriptor.Permission -
Class in com.marklogic.client.admin
-
Wraps assigned permissions for an extension into
a Java object.
- ExtensionMetadata - Class in com.marklogic.client.admin
-
Extension Metadata provides detail about a
transform or resource services extension.
- ExtensionMetadata()
- Constructor for class com.marklogic.client.admin.ExtensionMetadata
-
Zero-argument constructor.
- ExtensionMetadata.ScriptLanguage - Enum
in com.marklogic.client.admin
-
The ScriptLanguage enumeration specifies the
categories of metadata read from or written to the database.
- ExtractedItem - Interface in com.marklogic.client.query
-
Access the extracted XML or JSON node using any
StructureReadHandle or class registered by a ContentHandle.
- ExtractedResult - Interface in com.marklogic.client.query
-
Surfaces the data sent from the server-side
XQuery search:search API.
- ExtractRowsViaTemplateListener - Class in
com.marklogic.client.datamovement
-
This QueryBatchListener takes in one or more
uris for templates as defined by Marklogic TDE (Template Driven
Extraction) and applies them to each batch of documents.
- ExtractRowsViaTemplateListener()
- Constructor for class com.marklogic.client.datamovement.ExtractRowsViaTemplateListener
-
- fabs(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the absolute value of x.
- facetBy(PlanNamedGroupSeq)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
This method counts values for multiple grouping
key columns.
- facetBy(PlanNamedGroupSeq, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
This method counts values for multiple grouping
key columns.
- facetBy(PlanNamedGroupSeq, PlanExprCol)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
This method counts values for multiple grouping
key columns.
- FacetHeatmapValue - Interface in com.marklogic.client.query
-
A FacetHeatmapValue is a facet value returned by
a geospatial query heatmap.
- FacetResult - Interface in com.marklogic.client.query
-
A FacetResult represents a single facet as
returned by a search.
- FacetValue - Interface in com.marklogic.client.query
-
A FacetValue represents a single value returned
in a set of facet results.
- FailedRequestException - Exception in
com.marklogic.client
-
A FailedRequestException is used to capture and
report on problems from the REST API.
- FailedRequestException(String)
- Constructor for exception com.marklogic.client.FailedRequestException
-
- FailedRequestException(String, Throwable)
- Constructor for exception com.marklogic.client.FailedRequestException
-
- FailedRequestException(String, FailedRequest)
- Constructor for exception com.marklogic.client.FailedRequestException
-
- FailedRetryException - Exception in
com.marklogic.client
-
A FailedRetryException is used to capture and
report when retry of the request timed out or failed in some other
way.
- FailedRetryException(String)
- Constructor for exception com.marklogic.client.FailedRetryException
-
- FailedRetryException(String, Throwable)
- Constructor for exception com.marklogic.client.FailedRetryException
-
- FailedRetryException(String, FailedRequest)
- Constructor for exception com.marklogic.client.FailedRetryException
-
- FailureListener<T extends
java.lang.Throwable> - Interface in com.marklogic.client.datamovement
-
A generic base interface for listeners
implemented by QueryFailureListener for processing a Throwable that
caused a failure.
- falseExpr()
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the xs:boolean value false.
- falseQuery()
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query that matches no fragments.
- fatalError(SAXParseException)
- Method in class com.marklogic.client.io.InputSourceHandle.DraconianErrorHandler
-
Throws the fatal error as a parse
exception.
- field(String)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a field to match with a query.
- fieldRangeQuery(String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
- fieldRangeQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
- fieldRangeQuery(String, String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
- fieldRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
- fieldRangeQuery(String, String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
- fieldRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching fields by name with
a range-index entry equal to a given value.
- fieldReference(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a field value lexicon,
for use as a parameter to cts:value-tuples.
- fieldReference(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a field value lexicon,
for use as a parameter to cts:value-tuples.
- fieldReference(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a field value lexicon,
for use as a parameter to cts:value-tuples.
- fieldReference(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a field value lexicon,
for use as a parameter to cts:value-tuples.
- fieldValueQuery(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given value in the specified field.
- fieldValueQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given value in the specified field.
- fieldValueQuery(String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given value in the specified field.
- fieldValueQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given value in the specified field.
- fieldValueQuery(String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given value in the specified field.
- fieldValueQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given value in the specified field.
- fieldWordQuery(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching fields with text
content containing a given phrase.
- fieldWordQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching fields with text
content containing a given phrase.
- fieldWordQuery(String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching fields with text
content containing a given phrase.
- fieldWordQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching fields with text
content containing a given phrase.
- fieldWordQuery(String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching fields with text
content containing a given phrase.
- fieldWordQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching fields with text
content containing a given phrase.
- FileHandle - Class in com.marklogic.client.io
-
A File Handle represents document content as a
file for reading or writing.
- FileHandle()
- Constructor for class com.marklogic.client.io.FileHandle
-
Zero-argument constructor.
- FileHandle(File)
- Constructor for class com.marklogic.client.io.FileHandle
-
Initializes the handle with a file containing
the content.
- FilteredForestConfiguration - Class in
com.marklogic.client.datamovement
-
- FilteredForestConfiguration(ForestConfiguration)
- Constructor for class com.marklogic.client.datamovement.FilteredForestConfiguration
-
- filteredQuery(StructuredQueryDefinition)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- findOne(QueryDefinition)
- Method in interface com.marklogic.client.query.QueryManager
-
The findOne method is a convenience.
- findOne(QueryDefinition, Transaction)
- Method in interface com.marklogic.client.query.QueryManager
-
The findOne method is a convenience.
- floatExpr(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:float server data type.
- floatSeq(float...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of float primitives and
constructs an xs:float sequence
- floatSeq(XsFloatVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:float values and
constructs an xs:float sequence
- floatVal(float)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a float primitive and constructs an
xs:float value
- floor(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the largest (closest to positive
infinity) number with no fractional part that is not greater than
the value of arg.
- floor(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the largest integer less than or equal
to x.
- flush()
- Method in interface com.marklogic.client.util.RequestLogger
-
Send buffered output to the log
destination.
- flushAndWait()
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Create a batch from any unbatched documents and
write that batch, then wait for all batches to complete (the same
as awaitCompletion().
- flushAsync()
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Create a batch from any unbatched documents and
write that batch asynchronously.
- fmod(ServerExpression, double)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the remainder of x/y.
- fmod(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the remainder of x/y.
- fn
- Variable in class com.marklogic.client.expression.CtsQueryBuilder
-
Builds expressions with fn server
functions.
- fn
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with fn server
functions.
- FnExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the fn
server library for a row pipeline.
- ForbiddenUserException - Exception in
com.marklogic.client
-
Thrown when the credentials used to connect to a
MarkLogic REST instance are not sufficient for the task
requested.
- ForbiddenUserException(String)
- Constructor for exception com.marklogic.client.ForbiddenUserException
-
- ForbiddenUserException(String, FailedRequest)
- Constructor for exception com.marklogic.client.ForbiddenUserException
-
- Forest - Interface in com.marklogic.client.datamovement
-
Some details about a MarkLogic forest.
- Forest.HostType - Enum in com.marklogic.client.datamovement
-
Enum containing the list of host types a forest
can have.
- ForestConfiguration - Interface in
com.marklogic.client.datamovement
-
A reflection of the forest configuration
associated with the specified database (or the default database for
the specified port) in the MarkLogic cluster.
- Format - Enum in com.marklogic.client.io
-
The Format enumerates different kinds of
document content.
- formatDate(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the
picture argument.
- formatDate(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the
picture argument.
- formatDate(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the
picture argument.
- formatDate(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the
picture argument.
- formatDate(ServerExpression, String, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the
picture argument.
- formatDate(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the
picture argument.
- formatDate(ServerExpression, String, String, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the
picture argument.
- formatDate(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted date value based on the
picture argument.
- formatDateTime(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the
picture argument.
- formatDateTime(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the
picture argument.
- formatDateTime(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the
picture argument.
- formatDateTime(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the
picture argument.
- formatDateTime(ServerExpression, String, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the
picture argument.
- formatDateTime(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the
picture argument.
- formatDateTime(ServerExpression, String, String, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the
picture argument.
- formatDateTime(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted dateTime value based on the
picture argument.
- formatNumber(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted string representation of
value argument based on the supplied picture.
- formatNumber(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted string representation of
value argument based on the supplied picture.
- formatNumber(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted string representation of
value argument based on the supplied picture.
- formatNumber(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted string representation of
value argument based on the supplied picture.
- formatNumber(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, String, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, String, String, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, String, String, String, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, String, String, String, String, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, String, String, String, String, String, String, long)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatNumber(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a formatted number value based on the
picture argument.
- formatTime(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the
picture argument.
- formatTime(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the
picture argument.
- formatTime(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the
picture argument.
- formatTime(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the
picture argument.
- formatTime(ServerExpression, String, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the
picture argument.
- formatTime(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the
picture argument.
- formatTime(ServerExpression, String, String, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the
picture argument.
- formatTime(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a formatted time value based on the
picture argument.
- fragmentIdCol(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Specifies a name for adding a fragment id column
to the row set identifying the source documents for the rows from a
view, lexicons or triples.
- fragmentIdCol(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Specifies a name for adding a fragment id column
to the row set identifying the source documents for the rows from a
view, lexicons or triples.
- frexp(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns x broken up into mantissa and exponent,
where x = mantissa*2^exponent.
- from(Stream<? extends AbstractWriteHandle>, DocumentWriteOperation.DocumentUriMaker)
- Static method in interface com.marklogic.client.document.DocumentWriteOperation
-
The from method prepares each content object for
writing as a document including generating a URI by inserting a
UUID.
- from(InputStream)
- Method in class com.marklogic.client.io.BytesHandle
-
Assigns a byte array by reading all bytes from
an input stream and returns the handle as a fluent
convenience.
- from(Reader)
- Method in class com.marklogic.client.io.StringHandle
-
Assigns a string constructed from the content of
a reader and returns the handle as a fluent convenience.
- fromBuffer(byte[])
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.BytesHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
fromBuffer() populates DocumentMetadataHandle
from a byte array buffer.
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.DOMHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.FileHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.InputSourceHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.InputStreamHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.JAXBHandle
-
fromBuffer() unmarshals a JAXB POJO from a byte
array buffer.
- fromBuffer(byte[])
- Method in interface com.marklogic.client.io.marker.BufferableHandle
-
Sets the content of the handle by copying from a
byte array buffer encoded in UTF-8.
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.ReaderHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.SourceHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.StringHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- fromBuffer(byte[])
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- fromDocDescriptors(PlanDocDescriptor...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs document rows from the
docsDescriptors.
- fromDocDescriptors(PlanDocDescriptorSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs document rows from the
docsDescriptors.
- fromDocDescriptors(PlanDocDescriptorSeq, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs document rows from the
docsDescriptors.
- fromDocDescriptors(PlanDocDescriptorSeq, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs document rows from the
docsDescriptors.
- fromDocUris(CtsQueryExpr)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Construct an AccessPlan
based on
the URIs returned by the given query.
- fromDocUris(CtsQueryExpr, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Construct an AccessPlan
based on
the URIs returned by the given query.
- fromDocUris(String...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Convenience method for constructing an
AccessPlan
based on a given set of URIs.
- fromJson(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Atomizes a JSON node, returning a JSON
value.
- fromLexicons(Map<String, CtsReferenceExpr>)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from
range indexes or the uri or collection lexicons.
- fromLexicons(Map<String, CtsReferenceExpr>, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from
range indexes or the uri or collection lexicons.
- fromLexicons(Map<String, CtsReferenceExpr>, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from
range indexes or the uri or collection lexicons.
- fromLexicons(Map<String, CtsReferenceExpr>, String, PlanSystemColumn)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from
range indexes or the uri or collection lexicons.
- fromLexicons(Map<String, CtsReferenceExpr>, XsStringVal, PlanSystemColumn)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a view from
range indexes or the uri or collection lexicons.
- fromLiterals(Map<String, Object>...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Constructs a literal row set as in the SQL
VALUES or SPARQL VALUES statements.
- fromLiterals(Map<String, Object>[], String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Constructs a literal row set as in the SQL
VALUES or SPARQL VALUES statements.
- fromLiterals(Map<String, Object>[], XsStringVal)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Constructs a literal row set as in the SQL
VALUES or SPARQL VALUES statements.
- fromParam(String, String, PlanRowColTypesSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs document rows with rows
provided by a parameter.
- fromParam(XsStringVal, XsStringVal, PlanRowColTypesSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs document rows with rows
provided by a parameter.
- fromSearch(CtsQueryExpr)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Supports document matching and relevance by
constructing rows with the document fragment id and columns for
relevance factors.
- fromSearch(CtsQueryExpr, PlanExprCol...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Supports document matching and relevance by
constructing rows with the document fragment id and columns for
relevance factors.
- fromSearch(CtsQueryExpr, PlanExprColSeq, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Supports document matching and relevance by
constructing rows with the document fragment id and columns for
relevance factors.
- fromSearch(CtsQueryExpr, PlanExprColSeq, XsStringVal, PlanSearchOptions)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Supports document matching and relevance by
constructing rows with the document fragment id and columns for
relevance factors.
- fromSearchDocs(CtsQueryExpr)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Provides a convenience for matching documents
and constructing rows with the score, document URI, and document
content.
- fromSearchDocs(CtsQueryExpr, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Provides a convenience for matching documents
and constructing rows with the score, document URI, and document
content.
- fromSearchDocs(CtsQueryExpr, String, PlanSearchOptions)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Provides a convenience for matching documents
and constructing rows with the score, document URI, and document
content.
- fromSparql(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
- fromSparql(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
- fromSparql(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
- fromSparql(XsStringVal, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
- fromSparql(String, String, PlanSparqlOptions)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
- fromSparql(XsStringVal, XsStringVal, PlanSparqlOptions)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SPARQL SELECT query from triples.
- fromSql(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SQL SELECT query from views.
- fromSql(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SQL SELECT query from views.
- fromSql(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SQL SELECT query from views.
- fromSql(XsStringVal, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function dynamically constructs a row set
based on a SQL SELECT query from views.
- fromTriples(PlanTriplePattern...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple
index.
- fromTriples(PlanTriplePatternSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple
index.
- fromTriples(PlanTriplePatternSeq, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple
index.
- fromTriples(PlanTriplePatternSeq, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple
index.
- fromTriples(PlanTriplePatternSeq, String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple
index.
- fromTriples(PlanTriplePatternSeq, XsStringVal, XsStringSeqVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple
index.
- fromTriples(PlanTriplePatternSeq, String, String, PlanTripleOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple
index.
- fromTriples(PlanTriplePatternSeq, XsStringVal, XsStringSeqVal, PlanTripleOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Reads rows by matching patterns in the triple
index.
- fromView(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured
view over TDE-indexed rows or a predefined view over range
indexes.
- fromView(XsStringVal, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured
view over TDE-indexed rows or a predefined view over range
indexes.
- fromView(String, String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured
view over TDE-indexed rows or a predefined view over range
indexes.
- fromView(XsStringVal, XsStringVal, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured
view over TDE-indexed rows or a predefined view over range
indexes.
- fromView(String, String, String, PlanSystemColumn)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured
view over TDE-indexed rows or a predefined view over range
indexes.
- fromView(XsStringVal, XsStringVal, XsStringVal, PlanSystemColumn)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function reads a row set from a configured
view over TDE-indexed rows or a predefined view over range
indexes.
- FUNCTIONAL_PROPERTY
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- gDay(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:gDay
server data type.
- gDay(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a day as a string and constructs an
xs:gDay value
- gDay(XMLGregorianCalendar)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a day as a XMLGregorianCalendar value and
constructs an xs:gDay value
- gDaySeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of days as a string and
constructs an xs:gDay sequence
- gDaySeq(XMLGregorianCalendar...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of days as a
XMLGregorianCalendar value and constructs an xs:gDay sequence
- gDaySeq(XsGDayVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gDay values and
constructs an xs:gDay sequence
- ge(ServerExpression, ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if the value of the
left expression is greater than or equal to the value of the right
expression.
- generateId(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string that uniquely identifies a
given node.
- GenerateIndexConfig - Class in com.marklogic.client.pojo.util
-
Generates a MarkLogic index configuration file
in JSON format describing the indexes required by the annotations
on the specific classes.
- GenerateIndexConfig()
- Constructor for class com.marklogic.client.pojo.util.GenerateIndexConfig
-
- generateOutput(DocumentRecord)
- Method in interface com.marklogic.client.datamovement.ExportToWriterListener.OutputListener
-
Given the DocumentRecord, generate the desired
String output to send to the writer.
- generateOutput(String)
- Method in interface com.marklogic.client.datamovement.UrisToWriterListener.OutputListener
-
- generateView(PlanBuilder.PreparePlan, String, String, T)
- Method in interface com.marklogic.client.row.RowManager
-
Generates generates a view that encapsulates a
plan.
- generateViewAs(PlanBuilder.PreparePlan, String, String, Class<T>)
- Method in interface com.marklogic.client.row.RowManager
-
Generates generates a view that encapsulates a
plan.
- GenericDocumentManager - Interface in
com.marklogic.client.document
-
A Generic Document Manager supports database
operations on documents with an unknown format.
- GenericReadHandle - Interface in com.marklogic.client.io.marker
-
A Generic Read Handle can represent content of
an unknown format read from the database.
- GenericWriteHandle - Interface in
com.marklogic.client.io.marker
-
A Generic Write Handle can represent content of
an unknown format written to the database.
- geo
- Variable in class com.marklogic.client.expression.CtsQueryBuilder
-
Builds expressions with geo server
functions.
- geo
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with geo server
functions.
- geoAttributePair(StructuredQueryBuilder.Element, StructuredQueryBuilder.Attribute, StructuredQueryBuilder.Attribute)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent element with child latitude
and longitude attributes to match with a geospatial query.
- geoElement(StructuredQueryBuilder.Element)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies an element whose text has the
latitude and longitude coordinates to match with a geospatial
query.
- geoElement(StructuredQueryBuilder.Element, StructuredQueryBuilder.Element)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent element with a child element
whose text has the latitude and longitude coordinates to match with
a geospatial query.
- geoElementPair(StructuredQueryBuilder.Element, StructuredQueryBuilder.Element, StructuredQueryBuilder.Element)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent element with child latitude
and longitude elements to match with a geospatial query.
- GeoExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the geo
server library for a row pipeline.
- geohashDecode(String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Given a geohash string, return the bounding box
for that hash.
- geohashDecode(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Given a geohash string, return the bounding box
for that hash.
- geohashDecodePoint(String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Given a geohash string, return the point for
that hash.
- geohashDecodePoint(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Given a geohash string, return the point for
that hash.
- geohashEncode(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compute a set of covering geohashes for the
given region, to the given level of precision.
- geohashEncode(ServerExpression, long)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compute a set of covering geohashes for the
given region, to the given level of precision.
- geohashEncode(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compute a set of covering geohashes for the
given region, to the given level of precision.
- geohashEncode(ServerExpression, long, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compute a set of covering geohashes for the
given region, to the given level of precision.
- geohashEncode(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compute a set of covering geohashes for the
given region, to the given level of precision.
- geohashNeighbors(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Given a geohash string, return hashes for the
neighbors.
- geohashPrecisionDimensions(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Given a geohash string, return the height and
width for the given precision.
- geohashSubhashes(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Given a geohash string, return the 32
subhashes.
- geohashSubhashes(ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Given a geohash string, return the 32
subhashes.
- geohashSubhashes(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Given a geohash string, return the 32
subhashes.
- geoJSONProperty(StructuredQueryBuilder.JSONProperty)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a json property whose text has the
point format latitude and longitude coordinates to match with a
geospatial query.
- geoJSONProperty(StructuredQueryBuilder.JSONProperty, StructuredQueryBuilder.JSONProperty)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent json property with a child
json property whose text has the latitude and longitude coordinates
to match with a geospatial query.
- geoJSONPropertyPair(StructuredQueryBuilder.JSONProperty, StructuredQueryBuilder.JSONProperty, StructuredQueryBuilder.JSONProperty)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a parent json property with child
latitude and longitude json properties to match with a geospatial
query.
- geoPair(String, String)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
For use in a
geospatial
query, reference a pair of
properties.
- geoPath(String)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
For use in a
geospatial
query, reference a geo property which
has a corresponding Geospatial Path Range Index configured in the
database.
- geoPath(StructuredQueryBuilder.PathIndex)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a path with the latitude and
longitude to match with a geospatial query.
- geoRegionPath(StructuredQueryBuilder.PathIndex)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a path with regions to match with a
geospatial query.
- geoRegionPath(StructuredQueryBuilder.PathIndex, StructuredQueryBuilder.CoordinateSystem)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a path with regions to match with a
geospatial query.
- geospatial(StructuredQueryBuilder.GeospatialIndex, String[], StructuredQueryBuilder.Region...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.Region...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.Region...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, element pair, element
attribute, pair, or path specifying a geospatial point that appears
within one of the criteria regions.
- geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Region...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, element pair, element
attribute, pair, or path specifying a geospatial point that appears
within one of the criteria regions.
- geospatial(StructuredQueryBuilder.GeospatialIndex, StructuredQueryBuilder.FragmentScope, String[], Double, StructuredQueryBuilder.Region...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, element pair, element
attribute, pair, or path specifying a geospatial point that appears
within one of the criteria regions.
- geospatial(StructuredQueryBuilder.GeospatialRegionIndex, StructuredQueryBuilder.GeospatialOperator, StructuredQueryBuilder.Region...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a path specifying a geospatial region,
which is indexed via geospatial region index, that has the
relationship given by the operator with at least one of the
criteria regions.
- geospatial(StructuredQueryBuilder.GeospatialRegionIndex, StructuredQueryBuilder.GeospatialOperator, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Region...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a path specifying a geospatial region,
which is indexed via geospatial region index, that has the
relationship given by the operator with at least one of the
criteria regions.
- geospatial(StructuredQueryBuilder.GeospatialRegionIndex, StructuredQueryBuilder.GeospatialOperator, StructuredQueryBuilder.FragmentScope, String[], Double, StructuredQueryBuilder.Region...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a path specifying a geospatial region,
which is indexed via geospatial region index, that has the
relationship given by the operator with at least one of the
criteria regions.
- geospatialConstraint(String, StructuredQueryBuilder.Region...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the
constraint whose geospatial point appears within one of the
criteria regions.
- GeospatialConstraintQuery(String, StructuredQueryBuilder.Region...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.GeospatialConstraintQuery
-
- GeospatialLatitude - Annotation Type in
com.marklogic.client.pojo.annotation
-
Use this annotation in combination with
GeospatialLongitude
on a sibling property to specify that a Geospatial Element Pair
Index is needed for these pojo properties.
- GeospatialLongitude - Annotation Type in
com.marklogic.client.pojo.annotation
-
Use this annotation in combination with
GeospatialLatitude
on a sibling property to specify that a Geospatial Element Pair
Index is needed for these pojo properties.
- GeospatialPathIndexProperty - Annotation
Type in com.marklogic.client.pojo.annotation
-
Use this annotation to specify that a Geospatial
Path Index is needed for this pojo property.
- geospatialPathReference(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
- geospatialPathReference(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
- geospatialPathReference(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
- geospatialPathReference(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
- geospatialPathReference(String, String, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
- geospatialPathReference(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a geospatial path range
index, for use as a parameter to cts:value-tuples.
- geospatialRegionConstraint(String, StructuredQueryBuilder.GeospatialOperator, StructuredQueryBuilder.Region...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the
constraint whose geospatial region appears within one of the
criteria regions.
- GeospatialRegionConstraintQuery(String, StructuredQueryBuilder.GeospatialOperator, StructuredQueryBuilder.Region...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.GeospatialRegionConstraintQuery
-
- geospatialRegionPathReference(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(String, String, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(String, String, ServerExpression, long)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(String, String, ServerExpression, long, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(String, String, ServerExpression, long, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionPathReference(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Create a reference to a geospatial region path
index, for use as a parameter to cts:geospatial-region-query and
other query operations on geospatial region indexes.
- geospatialRegionQuery(ServerExpression, String, CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
- geospatialRegionQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
- geospatialRegionQuery(ServerExpression, String, ServerExpression, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
- geospatialRegionQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
- geospatialRegionQuery(ServerExpression, String, ServerExpression, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
- geospatialRegionQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Construct a query to match regions in documents
that satisfy a specified relationship relative to other
regions.
- get(H)
- Method in interface com.marklogic.client.eval.EvalResult
-
Use a handle to retrieve the contents of this
result.
- get(ServerExpression, String)
- Method in interface com.marklogic.client.expression.MapExpr
-
Get a value from a map.
- get(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MapExpr
-
Get a value from a map.
- get(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns the element at the k-th index of the
vector.
- get(RequestParameters, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads resource content by calling a GET
service.
- get(RequestParameters, Transaction, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads resource content by calling a GET
service.
- get(RequestParameters)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads multiple resource content by calling a GET
service.
- get(RequestParameters, Transaction)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Reads multiple resource content by calling a GET
service.
- get()
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the XML document structure.
- get()
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
Returns the root node of the JSON tree.
- get()
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the XML document structure.
- get() -
Method in class com.marklogic.client.io.BytesHandle
-
Returns the byte array for the handle
content.
- get() -
Method in class com.marklogic.client.io.DOMHandle
-
Returns the DOM document for the content.
- get() -
Method in class com.marklogic.client.io.FileHandle
-
Returns the file for the handle content.
- get()
- Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the input source for the content.
- get()
- Method in class com.marklogic.client.io.InputStreamHandle
-
Returns an input stream for a resource read from
the database.
- get()
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Returns the content.
- get()
- Method in class com.marklogic.client.io.JacksonHandle
-
Returns the root node of the JSON tree.
- get()
- Method in class com.marklogic.client.io.JacksonParserHandle
-
JsonParser allows streaming access to content as
it arrives.
- get() -
Method in class com.marklogic.client.io.JAXBHandle
-
Returns the root object of the JAXB structure
for the content.
- get(Class<T>)
- Method in class com.marklogic.client.io.JAXBHandle
-
Returns the root object of the JAXB structure
for the content cast to a more specific class.
- get()
- Method in interface com.marklogic.client.io.marker.ContentHandle
-
Returns the content.
- get()
- Method in class com.marklogic.client.io.OutputStreamHandle
-
Returns the output stream sender that writes the
content.
- get()
- Method in class com.marklogic.client.io.ReaderHandle
-
Returns a character reader for reading
content.
- get()
- Method in class com.marklogic.client.io.SourceHandle
-
Returns the transform source that produces the
content.
- get()
- Method in class com.marklogic.client.io.StringHandle
-
Returns the string for the content.
- get()
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Returns an XML Event Reader reading a resource
from the database as a series of StAX events.
- get()
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Returns an XML Stream Reader for reading a
resource from the database as a StAX pull stream.
- get(String, Class<T>)
- Method in class com.marklogic.client.query.AggregateResult
-
Returns the value cast to the specified
type.
- get(String, Class<T>)
- Method in class com.marklogic.client.query.CountedDistinctValue
-
Returns the value cast to the specified
type.
- get(T)
- Method in interface com.marklogic.client.query.ExtractedItem
-
Get the item using the specified handle.
- get(Class<T>)
- Method in class com.marklogic.client.query.TypedDistinctValue
-
Returns the value as an instance of the
specified class.
- get(Object)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the URI for a prefix.
- get(String)
- Method in interface com.marklogic.client.util.NameMap
-
Returns the value of the string name.
- get(QName, Class<T>)
- Method in interface com.marklogic.client.util.NameMap
-
Returns the value of the QName, cast to the
supplied type.
- get(String, Class<T>)
- Method in interface com.marklogic.client.util.NameMap
-
Returns the value of the string name, cast to
the supplied type.
- get(Object)
- Method in class com.marklogic.client.util.RequestParameters
-
Gets the values for a parameter name.
- getActiveJob(String)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Gets the job ticket for an active job that has
not been stopped by calling stopJob method.
- getAggregate(String)
- Method in class com.marklogic.client.io.TuplesHandle
-
- getAggregate(String)
- Method in class com.marklogic.client.io.ValuesHandle
-
- getAggregate(String)
- Method in interface com.marklogic.client.query.TuplesResults
-
Returns the aggregate result for the named
aggregate function.
- getAggregate()
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the name of the aggregate function
applied to this query.
- getAggregate(String)
- Method in interface com.marklogic.client.query.ValuesResults
-
Returns the aggregate result for the named
aggregate function.
- getAggregatePath()
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the aggregate path.
- getAggregateResolutionTime()
- Method in interface com.marklogic.client.query.ValuesMetrics
-
Returns the facet resolution time in
milliseconds.
- getAggregates()
- Method in class com.marklogic.client.io.TuplesHandle
-
- getAggregates()
- Method in class com.marklogic.client.io.ValuesHandle
-
- getAggregates()
- Method in interface com.marklogic.client.query.TuplesResults
-
Returns an array of the aggregates.
- getAggregates()
- Method in interface com.marklogic.client.query.ValuesResults
-
Returns an array of the aggregates.
- getAllPrefixes()
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns all bound prefixes.
- getAllPrefixes()
- Method in interface com.marklogic.client.util.IterableNamespaceContext
-
Returns all bound prefixes.
- getAllSnippetText()
- Method in interface com.marklogic.client.query.MatchLocation
-
Returns the entire text only of the snippet,
excluding any highlight tags.
- getAlternateHost()
- Method in interface com.marklogic.client.datamovement.Forest
-
The alternate host name associated with the
forest in the MarkLogic server.
- getAnyAtomicTypeItems()
- Method in interface com.marklogic.client.type.XsAnyAtomicTypeSeqVal
-
- getAnySimpleTypeItems()
- Method in interface com.marklogic.client.type.XsAnySimpleTypeSeqVal
-
- getAnyURIItems()
- Method in interface com.marklogic.client.type.XsAnyURISeqVal
-
- getApiKey()
- Method in class com.marklogic.client.DatabaseClientFactory.MarkLogicCloudAuthContext
-
- getArrayDepth()
- Method in class com.marklogic.client.datamovement.JSONSplitter.ArrayVisitor
-
Get the current array depth in the JSON
tree.
- getAs(Class<T>)
- Method in interface com.marklogic.client.eval.EvalResult
-
An io shortcut method to get the contents as an
object of the specified type, which must be a registered
type.
- getAs(Class<T>)
- Method in interface com.marklogic.client.query.ExtractedItem
-
Get the item using the handle registered for the
specified class.
- getAttributeCount()
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getAttributeLocalName(int)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getAttributeName(int)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getAttributeNamespace(int)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getAttributePrefix(int)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getAttributeType(int)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getAttributeValue(int)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getAttributeValue(String, String)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getAuthorization()
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Gets the object with the SAML assertions token
and expiration when specified during construction of the
SAMLAuthContext or renewed by the renewer callback.
- getAuthorizationToken()
- Method in interface com.marklogic.client.DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth
-
Gets the SAML assertions token
- getAuthorizer()
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Gets the authorizer callback when specified
during construction of the SAMLAuthContext.
- getBase()
- Method in interface com.marklogic.client.type.PlanSparqlOptions
-
- getBase64BinaryItems()
- Method in interface com.marklogic.client.type.XsBase64BinarySeqVal
-
- getBasePath()
- Method in interface com.marklogic.client.DatabaseClient
-
- getBasePath()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
- getBaseUri()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getBatchCount()
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
The total number of batches of rows retrieved
from the view.
- getBatcher()
- Method in interface com.marklogic.client.datamovement.JobTicket
-
- getBatcher()
- Method in exception com.marklogic.client.datamovement.QueryBatchException
-
- getBatcher()
- Method in interface com.marklogic.client.datamovement.QueryEvent
-
- getBatcher()
- Method in interface com.marklogic.client.datamovement.WriteBatch
-
- getBatchFailureListeners()
- Method in class com.marklogic.client.datamovement.ExportListener
-
- getBatchFailureListeners()
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Get the array of WriteFailureListener instances
registered via onBatchFailure including the
HostAvailabilityListener registered by default.
- getBatchRecordNumber()
- Method in interface com.marklogic.client.datamovement.WriteEvent
-
Within the context of the batch, the numeric
position of this document.
- getBatchRetries()
- Method in interface com.marklogic.client.datamovement.RowBatchFailureListener.RowBatchFailureEvent
-
The number of retries so far for this batch of
rows.
- getBatchSize()
- Method in interface com.marklogic.client.datamovement.Batcher
-
- getBatchSuccessListeners()
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Get the array of WriteBatchListener instances
registered via onBatchSuccess.
- getBigDecimal()
- Method in interface com.marklogic.client.type.XsDecimalVal
-
- getBigInteger()
- Method in interface com.marklogic.client.type.XsIntegerVal
-
- getBindings()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Get the child SPARQLBindings instance (normally
populated by calls to withBinding methods).
- getBm25LengthWeight()
- Method in interface com.marklogic.client.type.PlanSearchOptions
-
- getBoolean()
- Method in interface com.marklogic.client.eval.EvalResult
-
This result parsed to a Boolean.
- getBoolean(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:boolean
schema data type as a Java boolean primitive value.
- getBoolean(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:boolean
schema data type as a Java boolean primitive value.
- getBoolean()
- Method in interface com.marklogic.client.type.XsBooleanVal
-
- getBooleanItems()
- Method in interface com.marklogic.client.type.XsBooleanSeqVal
-
- getBox()
- Method in interface com.marklogic.client.query.FacetHeatmapValue
-
Returns the box associated with the heatmap as
an array.
- getBuilder()
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the JDOM structure builder for XML
content.
- getByte(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:byte
schema data type as a Java byte primitive value.
- getByte(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:byte
schema data type as a Java byte primitive value.
- getByte()
- Method in interface com.marklogic.client.type.XsByteVal
-
- getByte()
- Method in interface com.marklogic.client.type.XsUnsignedByteVal
-
- getByteItems()
- Method in interface com.marklogic.client.type.XsByteSeqVal
-
- getByteLength()
- Method in interface com.marklogic.client.document.ContentDescriptor
-
Returns the length of the content in bytes as
returned by the server.
- getByteLength()
- Method in class com.marklogic.client.io.BaseHandle
-
- getBytes()
- Method in interface com.marklogic.client.type.XsBase64BinaryVal
-
- getBytes()
- Method in interface com.marklogic.client.type.XsHexBinaryVal
-
- getCalendar()
- Method in interface com.marklogic.client.type.XsDateTimeVal
-
- getCalendar()
- Method in interface com.marklogic.client.type.XsDateVal
-
- getCalendar()
- Method in interface com.marklogic.client.type.XsTimeVal
-
- getCapability()
- Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
gets the capability of this permission
- getCertificate()
- Method in class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
- getCertificatePassword()
- Method in class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
- getClearPass()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getClient()
- Method in interface com.marklogic.client.datamovement.BatchEvent
-
The DatabaseClient used to send or retrieve this
batch.
- getClient()
- Method in exception com.marklogic.client.datamovement.QueryBatchException
-
The DatabaseClient used to retrieve this batch
(if it's a job based on a QueryDefinition).
- getClient()
- Method in interface com.marklogic.client.datamovement.QueryEvent
-
The DatabaseClient used to retrieve this batch
(if it's a job based on a QueryDefinition).
- getClientImplementation()
- Method in interface com.marklogic.client.DatabaseClient
-
Returns the client object from the library that
implements communication with the server.
- getCollections()
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the collections for the
document as read from the server or modified locally.
- getCollections()
- Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the array of collections to which the
query is limited.
- getColumnNames()
- Method in interface com.marklogic.client.row.RowSet
-
Identifies the columns in the row set.
- getColumnTypes()
- Method in interface com.marklogic.client.row.RowSet
-
Identifies the data types of the columns.
- getConfidence()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the confidence messsure associated with
the document.
- getConnectionType()
- Method in interface com.marklogic.client.DatabaseClient
-
How the client connects to MarkLogic.
- getConnectionType()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Identifies whether the client connects directly
with a MarkLogic host or by means of a gateway such as a load
balancer.
- getConnectionType()
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Identify whether the DataMovementManager
connects directly to each MarkLogic host with a forest for the
database or whether the DataMovementManager uses a gateway such as
a load balancer to communicate with the MarkLogic hosts.
- getConstrainingQueryDefinition()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getConstraint(String, T)
- Method in class com.marklogic.client.io.SearchHandle
-
- getConstraint(String, T)
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the named constraint used in the search
(if requested).
- getConstraintIterator(T)
- Method in class com.marklogic.client.io.SearchHandle
-
- getConstraintIterator(T)
- Method in interface com.marklogic.client.query.SearchResults
-
Returns an iterator over the constraints used in
the search (if requested).
- getConstraintNames()
- Method in class com.marklogic.client.io.SearchHandle
-
- getConstraintNames()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of constraint names used in
the search (if requested).
- getContainer(String)
- Method in interface com.marklogic.client.row.RowRecord
-
- getContainer(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
- getContainer(String, T)
- Method in interface com.marklogic.client.row.RowRecord
-
- getContainer(PlanExprCol, T)
- Method in interface com.marklogic.client.row.RowRecord
-
- getContainerAs(String, Class<T>)
- Method in interface com.marklogic.client.row.RowRecord
-
- getContainerAs(PlanExprCol, Class<T>)
- Method in interface com.marklogic.client.row.RowRecord
-
- getContent()
- Method in interface com.marklogic.client.datamovement.WriteEvent
-
The content written to the server.
- getContent(T)
- Method in interface com.marklogic.client.document.DocumentRecord
-
Given a handle, populates the handle with the
document contents directly from the server (or the transformed
contents if a ServerTransform was used).
- getContent()
- Method in interface com.marklogic.client.document.DocumentWriteOperation
-
The handle with the content as set by your call
to
add
or
add
.
- getContent(R)
- Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns a handle on the content.
- getContent(String, T)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the content of a column with a document or
other content node value.
- getContent(PlanExprCol, T)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the content of a column with a document or
other content node value.
- getContentAs(Class<T>)
- Method in interface com.marklogic.client.document.DocumentRecord
-
Reads the document content from the multipart
response into the representation specified by the IO class.
- getContentAs(String, Class<T>)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the content of a column with a document or
other content node value.
- getContentAs(PlanExprCol, Class<T>)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the content of a column with a document or
other content node value.
- getContentClass()
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- getContentClass()
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
- getContentClass()
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.BytesHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.DOMHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.FileHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.InputSourceHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.InputStreamHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.JacksonHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.JacksonParserHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.JAXBHandle
-
- getContentClass()
- Method in interface com.marklogic.client.io.marker.ContentHandle
-
Returns the class of the handled content, which
may be a base class of the actual class of a content object.
- getContentClass()
- Method in class com.marklogic.client.io.ReaderHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.SourceHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.StringHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- getContentClass()
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- getContentFormat()
- Method in interface com.marklogic.client.document.DocumentManager
-
Gets the default format of the managed
documents
- getContentFormat(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Identifies the format where a column has a
document or other content node value in the row instead of an
atomic value.
- getContentFormat(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Identifies the format where a column has a
document or other content node value in the row instead of an
atomic value.
- getContentMax()
- Method in interface com.marklogic.client.util.RequestLogger
-
Returns how much content is copied to the
log.
- getContentMimetype(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Identifies the format where a column has a
document or other content node value in the row instead of an
atomic value.
- getContentMimetype(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Identifies the format where a column has a
document or other content node value in the row instead of an
atomic value.
- getCookies()
- Method in interface com.marklogic.client.Transaction
-
Returns any cookies sent in the response to open
the transaction.
- getCoordinateSystem()
- Method in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
- getCount()
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
The number of JsonNodes found so far.
- getCount()
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Returns the number of splits.
- getCount()
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Used to return the number of objects in the
stream.
- getCount()
- Method in interface com.marklogic.client.datamovement.Splitter
-
- getCount()
- Method in class com.marklogic.client.datamovement.UnarySplitter
-
Returns the number of splits.
- getCount()
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Returns the number of splits.
- getCount()
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Returns the number of splits.
- getCount()
- Method in class com.marklogic.client.query.CountedDistinctValue
-
Returns the frequency associated with this
value.
- getCount()
- Method in interface com.marklogic.client.query.FacetValue
-
Returns the count of items for that facet
value.
- getCount()
- Method in class com.marklogic.client.query.Tuple
-
Returns the frequency of this tuple in the
database.
- getCriteria()
- Method in interface com.marklogic.client.query.RawCtsQueryDefinition
-
Returns the query criteria, that is the query
string.
- getCriteria()
- Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Returns the query criteria, that is the query
string.
- getCriteria()
- Method in interface com.marklogic.client.query.StringQueryDefinition
-
Returns the query criteria, that is the query
string.
- getCriteria()
- Method in class com.marklogic.client.query.StructuredQueryBuilder.AbstractStructuredQuery
-
- getCriteria()
- Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Returns the query criteria, that is the query
string.
- getCsvMapper()
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
The CsvMapper configured for the current
instance.
- getCsvSchema()
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
The CsvSchema configured for the current
instance.
- getCurrentUser()
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the name of the current user.
- getCursorPosition()
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the cursor position for the suggest
call.
- getDatabase()
- Method in interface com.marklogic.client.DatabaseClient
-
- getDatabase()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the database for clients created with a
DatabaseClientFactory.Bean object.
- getDatabaseName()
- Method in interface com.marklogic.client.datamovement.Forest
-
The database name associated with the forest in
the MarkLogic server.
- getDatatype(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Identifies the server data type for a
column.
- getDatatype(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Identifies the server data type for a
column.
- getDatatype()
- Method in interface com.marklogic.client.semantics.SPARQLBinding
-
- getDatatypeStyle()
- Method in interface com.marklogic.client.row.RowManager
-
Returns whether data types should be emitted in
each row (the default) or in the header in the response for
requests made with the row manager.
- getDateItems()
- Method in interface com.marklogic.client.type.XsDateSeqVal
-
- getDateTimeItems()
- Method in interface com.marklogic.client.type.XsDateTimeSeqVal
-
- getDayTimeDurationItems()
- Method in interface com.marklogic.client.type.XsDayTimeDurationSeqVal
-
- getDebug()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getDecimalItems()
- Method in interface com.marklogic.client.type.XsDecimalSeqVal
-
- getDeduplicated()
- Method in interface com.marklogic.client.type.PlanSparqlOptions
-
- getDefaultDocBatchSize()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Returns defaultDocBatchSize, which is calculated
according to server status
- getDefaultDocumentReadTransform()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns the name of the default transform for
reading documents.
- getDefaultDocumentReadTransformAll()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the default transform for
reading documents applies to all users or only users with the
rest-reader role.
- getDefaultExtension()
- Method in enum com.marklogic.client.io.Format
-
Returns the default extension for the
format.
- getDefaultGraphUris()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getDefaultMimetype()
- Method in enum com.marklogic.client.io.Format
-
Returns the default mime type for the
format.
- getDefaultMimetype()
- Method in interface com.marklogic.client.semantics.GraphManager
-
Get the mimetype set by calling
setDefaultMimetype.
- getDefaultNamespaceURI()
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the namespace URI bound to the empty
prefix.
- getDefaultWriteSchema()
- Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the default schema for validating the
input source while writing to the database.
- getDescription()
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the description of the extension.
- getDescription()
- Method in class com.marklogic.client.alerting.RuleDefinition
-
Returns the rule's definition.
- getDescriptor()
- Method in interface com.marklogic.client.document.DocumentRecord
-
Returns a descriptor for the document content
including the document version if enabled on the server.
- getDirection()
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the direction of the results in this
values query.
- getDirectory()
- Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Returns the directory that should prefix the
document uri.
- getDirectory()
- Method in interface com.marklogic.client.query.QueryDefinition
-
Returns the directory to which the query is
limited.
- getDisposition()
- Method in interface com.marklogic.client.datamovement.RowBatchFailureListener.RowBatchFailureEvent
-
Whether the RowBatcher should retry the attempt
to retrieve the batch of rows, skip the batch of rows, or stop the
job.
- getDocs(QueryBatch)
- Method in class com.marklogic.client.datamovement.ExportListener
-
- getDocToUriBatchRatio()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Returns docToUriBatchRatio set to the
QueryBatcher
- getDocumentMetadata()
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- getDocumentRepair()
- Method in interface com.marklogic.client.document.XMLDocumentManager
-
Returns the repair policy for XML documents
written by the manager.
- getDocumentUri(T)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
- getDocumentUriAfter()
- Method in class com.marklogic.client.datamovement.PathSplitter
-
Get documentUriAfter, which is the path of the
directory to process
- getDoNotPrompt()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getDouble(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:double
schema data type as a Java double primitive value.
- getDouble(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:double
schema data type as a Java double primitive value.
- getDouble()
- Method in interface com.marklogic.client.type.XsDoubleVal
-
- getDoubleItems()
- Method in interface com.marklogic.client.type.XsDoubleSeqVal
-
- getDoublePrecision()
- Method in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
- getDuration()
- Method in interface com.marklogic.client.type.XsDayTimeDurationVal
-
- getDuration()
- Method in interface com.marklogic.client.type.XsYearMonthDurationVal
-
- getDurationItems()
- Method in interface com.marklogic.client.type.XsDurationSeqVal
-
- getEndpointConstants()
- Method in interface com.marklogic.client.dataservices.IOEndpoint.CallContext
-
Gets the definition for constant inputs to the
endpoint.
- getEndpointPath()
- Method in interface com.marklogic.client.dataservices.IOEndpoint
-
Identifies the path of the endpoint in the
modules database on the server.
- getEndpointState()
- Method in interface com.marklogic.client.dataservices.IOEndpoint.CallContext
-
Gets the current snapshot of the mutable state
of the endpoint.
- getEntryFilter()
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Returns the entryFilter set to splitter.
- getErrorHandler()
- Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the error handler for errors discovered
while parsing the input source.
- getErrorMessage()
- Method in interface com.marklogic.client.DatabaseClient.ConnectionResult
-
- getExpiry()
- Method in interface com.marklogic.client.DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth
-
Gets the expiration time stamp specified for the
SAML assertions token
- getExtension()
- Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Returns the extension that should suffix the
document uri.
- getExtensionFormats()
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Returns the extensionFormats set to
splitter.
- getExtracted()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
- getExtractResolutionTime()
- Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the extract resolution time in
milliseconds.
- getFacetNames()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns a list of the facet names returned in
this search.
- getFacetNames()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of facet names returned by
this search.
- getFacetResolutionTime()
- Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the facet resolution time in
milliseconds.
- getFacetResult(String)
- Method in class com.marklogic.client.io.SearchHandle
-
Returns the named facet results.
- getFacetResult(String)
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the facet results for the named
facet.
- getFacetResults()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of facet results for this
search.
- getFacetResults()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of facet results.
- getFacetValues()
- Method in interface com.marklogic.client.query.FacetResult
-
Returns an array of the facet values.
- getFactory()
- Method in class com.marklogic.client.io.DOMHandle
-
Returns the factory for building DOM
documents.
- getFactory()
- Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the factory for parsing SAX
events.
- getFactory()
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Returns the factory for parsing StAX
events.
- getFactory()
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Returns the factory for parsing StAX
streams.
- getFailedBatches()
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
The number of batches that the RowBatcher failed
to retrieve from the view.
- getFailedJobBatches()
- Method in interface com.marklogic.client.datamovement.RowBatchFailureListener.RowBatchFailureEvent
-
The total number of batches skipped so far
during the job.
- getFailedRequest()
- Method in exception com.marklogic.client.MarkLogicServerException
-
- getFailureBatchesCount()
- Method in interface com.marklogic.client.datamovement.JobReport
-
WriteBatcher
: gets the number of batches that the job failed to write
QueryBatcher
: gets the number of batches that the job failed to retrieve (same
as getFailureEventsCount)
- getFailureEventsCount()
- Method in interface com.marklogic.client.datamovement.JobReport
-
WriteBatcher
: gets the number of documents that were sent but failed to
write
QueryBatcher
: gets the number of batches that the job failed to retrieve (same
as getFailureBatchesCount)
- getFailureListeners()
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Gets the callback functions for errors.
- getFirst()
- Method in class com.marklogic.client.datamovement.PeekingIterator
-
- getFirstSnippet(T)
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the content of the first snippet for the
matched result document as a convenience, especially for a raw
snippet that contains the entire result document.
- getFirstSnippetAs(Class<T>)
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Reads the content of the first snippet for the
matched result document in the representation specified by the IO
class.
- getFirstSnippetText()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the text of the first snippet as a
convenience, especially for a raw snippet that contains an entire
document in JSON or text format.
- getFitness()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the fitness of the document.
- getFloat(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:float
schema data type as a Java float primitive value.
- getFloat(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:float
schema data type as a Java float primitive value.
- getFloat()
- Method in interface com.marklogic.client.type.XsFloatVal
-
- getFloatItems()
- Method in interface com.marklogic.client.type.XsFloatSeqVal
-
- getForest()
- Method in exception com.marklogic.client.datamovement.QueryBatchException
-
The forest queried for this event if this job is
based on a QueryDefinition.
- getForest()
- Method in interface com.marklogic.client.datamovement.QueryEvent
-
The forest queried for this event if this job is
based on a QueryDefinition.
- getForestBatchNumber()
- Method in exception com.marklogic.client.datamovement.QueryBatchException
-
Within the context of this forest within the
job, the numeric position of this batch.
- getForestBatchNumber()
- Method in interface com.marklogic.client.datamovement.QueryEvent
-
Within the context of this forest within the
job, the numeric position of this batch.
- getForestConfig()
- Method in interface com.marklogic.client.datamovement.Batcher
-
- getForestId()
- Method in interface com.marklogic.client.datamovement.Forest
-
The id for the forest as provided by the
MarkLogic server.
- getForestName()
- Method in interface com.marklogic.client.datamovement.Forest
-
The name of the forest as provided by the
MarkLogic server.
- getForestResultsSoFar()
- Method in exception com.marklogic.client.datamovement.QueryBatchException
-
Within the context of this forest within the
job, the number of uris processed including the uris in this event
if this is a QueryBatch.
- getForestResultsSoFar()
- Method in interface com.marklogic.client.datamovement.QueryEvent
-
Within the context of this forest within the
job, the number of uris processed including the uris in this event
if this is a QueryBatch.
- getFormat()
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Returns the document format set to
splitter.
- getFormat()
- Method in interface com.marklogic.client.document.ContentDescriptor
-
Returns the format of the content.
- getFormat()
- Method in interface com.marklogic.client.document.DocumentRecord
-
Returns the format of the document in the
server
- getFormat()
- Method in interface com.marklogic.client.eval.EvalResult
-
The format of this result from the Content-Type
header provided by the REST API eval endpoint.
- getFormat()
- Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the format of the content.
- getFormat()
- Method in class com.marklogic.client.io.BaseHandle
-
- getFormat()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the format associated with this
document
- getFrequency()
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the frequency of the results.
- getFromDataType(String)
- Static method in enum com.marklogic.client.io.Format
-
Returns the format based on a document data type
as used in Data Services.
- getFromMimetype(String)
- Static method in enum com.marklogic.client.io.Format
-
Returns the format implied by the mime
type
- getGDayItems()
- Method in interface com.marklogic.client.type.XsGDaySeqVal
-
- getGMonthDayItems()
- Method in interface com.marklogic.client.type.XsGMonthDaySeqVal
-
- getGMonthItems()
- Method in interface com.marklogic.client.type.XsGMonthSeqVal
-
- getGrantType()
- Method in class com.marklogic.client.DatabaseClientFactory.MarkLogicCloudAuthContext
-
- getGYearItems()
- Method in interface com.marklogic.client.type.XsGYearSeqVal
-
- getGYearMonthItems()
- Method in interface com.marklogic.client.type.XsGYearMonthSeqVal
-
- getHandle()
- Method in interface com.marklogic.client.query.RawCtsQueryDefinition
-
Returns the handle for the JSON or XML
representation of the query.
- getHandle()
- Method in interface com.marklogic.client.query.RawQueryDefinition
-
Returns the handle for the JSON or XML
representation of the query.
- getHandle()
- Method in interface com.marklogic.client.row.RawPlanDefinition
-
Returns the handle for the JSON representation
of the AST for the plan.
- getHandle()
- Method in interface com.marklogic.client.row.RawQueryDSLPlan
-
Returns the handle for the text of the
JavaScript representation of the Query DSL.
- getHandle()
- Method in interface com.marklogic.client.row.RawSPARQLSelectPlan
-
Returns the handle for the text of the SPARQL
query.
- getHandle()
- Method in interface com.marklogic.client.row.RawSQLPlan
-
Returns the handle for the text of the SQL
query.
- getHandledClasses()
- Method in interface com.marklogic.client.io.marker.ContentHandleFactory
-
Returns classes that the handle always
supports;
- getHandleRegistry()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the registry for associating IO
representation classes with handle factories.
- getHandleRegistry()
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Returns the default registry with factories for
creating handles as adapters for IO representations.
- getHeaders()
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
The headers of the csv file.
- getHexBinaryItems()
- Method in interface com.marklogic.client.type.XsHexBinarySeqVal
-
- getHost()
- Method in interface com.marklogic.client.DatabaseClient
-
- getHost()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the host for clients created with a
DatabaseClientFactory.Bean object.
- getHost()
- Method in interface com.marklogic.client.datamovement.Forest
-
The host name associated with the forest in the
MarkLogic server.
- getHostId()
- Method in interface com.marklogic.client.Transaction
-
Returns the host identifier for the transaction
that binds this transaction with the host e-node for the
transaction.
- getHostUnavailableExceptions()
- Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
- getId()
- Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the ID of the message.
- getId()
- Method in class com.marklogic.client.io.SearchHandle.Warning
-
Returns the ID of the warning.
- getId(T)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Get the value of the id field (the field marked
with the @Id annotation).
- getIncludeDefaultRulesets()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getInitiator()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getInputAfter()
- Method in interface com.marklogic.client.datamovement.Splitter.UriMaker
-
Get inputAfter of the UriMaker, which could be
base directory
- getInstance(Batcher)
- Static method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
Returns the first HostAvailabilityListener
instance registered with the Batcher.
- getInstance(Batcher)
- Static method in class com.marklogic.client.datamovement.NoResponseListener
-
Returns the NoResponseListener instance
registered with the Batcher.
- getInt(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:int schema
data type as a Java int primitive value.
- getInt(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:int schema
data type as a Java int primitive value.
- getInt()
- Method in interface com.marklogic.client.type.XsIntVal
-
- getInt()
- Method in interface com.marklogic.client.type.XsUnsignedIntVal
-
- getIntegerItems()
- Method in interface com.marklogic.client.type.XsIntegerSeqVal
-
- getIntItems()
- Method in interface com.marklogic.client.type.XsIntSeqVal
-
- getIriItems()
- Method in interface com.marklogic.client.type.SemIriSeqVal
-
- getItems()
- Method in interface com.marklogic.client.datamovement.Batch
-
The documents read by WriteBatcher or the uris
retrieved by QueryBatcher.
- getItems()
- Method in interface com.marklogic.client.type.ItemSeqVal
-
- getJobBatchNumber()
- Method in interface com.marklogic.client.datamovement.BatchEvent
-
Within the context of the job, the numeric
position of this batch.
- getJobBatchNumber()
- Method in exception com.marklogic.client.datamovement.QueryBatchException
-
Within the context of the job, the numeric
position of this batch.
- getJobBatchNumber()
- Method in interface com.marklogic.client.datamovement.QueryEvent
-
Within the context of the job, the numeric
position of this batch.
- getJobEndTime()
- Method in interface com.marklogic.client.datamovement.Batcher
-
Gets the time at which the Batcher was
stopped
- getJobEndTime()
- Method in interface com.marklogic.client.datamovement.JobReport
-
- getJobId()
- Method in interface com.marklogic.client.datamovement.Batcher
-
- getJobId()
- Method in interface com.marklogic.client.datamovement.JobTicket
-
- getJobName()
- Method in interface com.marklogic.client.datamovement.Batcher
-
- getJobRecordNumber()
- Method in interface com.marklogic.client.datamovement.WriteEvent
-
Within the context of the job, the numric
position of this document.
- getJobReport(JobTicket)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Get a snapshot report of the state of the job
when the call is made.
- getJobResultsSoFar()
- Method in exception com.marklogic.client.datamovement.QueryBatchException
-
Within the context of the job, the number of
uris processed including the uris in this event if this is a
QueryBatch.
- getJobResultsSoFar()
- Method in interface com.marklogic.client.datamovement.QueryEvent
-
Within the context of the job, the number of
uris processed including the uris in this event if this is a
QueryBatch.
- getJobStartTime()
- Method in interface com.marklogic.client.datamovement.Batcher
-
Gets the time at which the Batcher was
started
- getJobStartTime()
- Method in interface com.marklogic.client.datamovement.JobReport
-
- getJobTicket()
- Method in interface com.marklogic.client.datamovement.Batcher
-
After the job has been started, returns the
JobTicket generated when the job was started.
- getJobTicket()
- Method in interface com.marklogic.client.datamovement.BatchEvent
-
The ticket for this job.
- getJobTicket()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
After the job has been started, returns the
JobTicket generated when the job was started.
- getJobTicket()
- Method in exception com.marklogic.client.datamovement.QueryBatchException
-
The ticket for this job.
- getJobTicket()
- Method in interface com.marklogic.client.datamovement.QueryEvent
-
The ticket for this job.
- getJobTicket()
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
After the job has been started, returns the
JobTicket generated when the job was started.
- getJobType()
- Method in interface com.marklogic.client.datamovement.JobTicket
-
- getJobWritesSoFar()
- Method in interface com.marklogic.client.datamovement.WriteBatch
-
In the context of this job, the number of
documents written so far.
- getKeyTab()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getKind()
- Method in interface com.marklogic.client.query.ExtractedResult
-
The xquery type of the extracted data.
- getKind(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Identifies whether the value of a column is an
atomic value, a document or other content structure, or a
null.
- getKind(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Identifies whether the value of a column is an
atomic value, a document or other content structure, or a
null.
- getKrbOptions()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosAuthContext
-
- getLabel()
- Method in interface com.marklogic.client.query.FacetValue
-
Returns the label associated with that facet
value.
- getLang()
- Method in interface com.marklogic.client.type.RdfLangStringVal
-
- getLangStringItems()
- Method in interface com.marklogic.client.type.RdfLangStringSeqVal
-
- getLanguageTag()
- Method in interface com.marklogic.client.semantics.SPARQLBinding
-
- getLastUriForForest()
- Method in exception com.marklogic.client.datamovement.QueryBatchException
-
Within the context of this forest within the
job, the last uri processed including the uris in this event if
this is a QueryBatch.
- getLastUriForForest()
- Method in interface com.marklogic.client.datamovement.QueryEvent
-
Within the context of this forest within the
job, the last uri processed including the uris in this event if
this is a QueryBatch.
- getLatitude()
- Method in interface com.marklogic.client.query.StructuredQueryBuilder.Point
-
- getLatitude()
- Method in class com.marklogic.client.query.StructuredQueryBuilder.PointImpl
-
- getLength()
- Method in interface com.marklogic.client.document.DocumentRecord
-
Returns the length of the document
content.
- getLength()
- Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the length of the content in
bytes.
- getLimit()
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the maximum number of suggestions to
fetch.
- getLimit()
- Method in interface com.marklogic.client.type.PlanSampleByOptions
-
- getLocalName()
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getLong(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:long
schema data type as a Java long primitive value.
- getLong(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:long
schema data type as a Java long primitive value.
- getLong()
- Method in interface com.marklogic.client.type.XsLongVal
-
- getLong()
- Method in interface com.marklogic.client.type.XsUnsignedLongVal
-
- getLongItems()
- Method in interface com.marklogic.client.type.XsLongSeqVal
-
- getLongitude()
- Method in interface com.marklogic.client.query.StructuredQueryBuilder.Point
-
- getLongitude()
- Method in class com.marklogic.client.query.StructuredQueryBuilder.PointImpl
-
- getLowerBound()
- Method in interface com.marklogic.client.datamovement.RowBatchFailureListener.RowBatchFailureEvent
-
The lower boundary for the requested batch of
rows (useful primarily for logging).
- getLowerBound()
- Method in interface com.marklogic.client.datamovement.RowBatchSuccessListener.RowBatchResponseEvent
-
The lower boundary for the batch of rows (useful
primarily for logging).
- getMapper()
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Provides access to the ObjectMapper used
internally so you can configure it to fit your JSON.
- getMapper()
- Method in class com.marklogic.client.io.JacksonParserHandle
-
Provides access to the ObjectMapper used
internally so you can configure it to fit your JSON.
- getMarshaller()
- Method in class com.marklogic.client.io.JAXBHandle
-
Returns the marshaller that converts a tree data
structure from Java objects to XML, reusing any existing
marshaller.
- getMarshaller(boolean)
- Method in class com.marklogic.client.io.JAXBHandle
-
Returns the marshaller that converts a tree data
structure from Java objects to XML.
- getMatchLocations()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns an array of match locations.
- getMatchResults()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of summaries for the matched
documents.
- getMatchResults()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the match results.
- getMaxBatches()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Returns the maximum number of Batches for the
current job.
- getMaxDocToUriBatchRatio()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Returns maxDocToUriBatchRatio, which is
calculated according to server status
- getMaxRetries()
- Method in interface com.marklogic.client.datamovement.RowBatchFailureListener.RowBatchFailureEvent
-
The number of retries before RowBatcher skips
the batch.
- getMaxUriBatchSize()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Returns maxUriBatchSize, which is calculated
according to server status
- getMessage()
- Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the text of the message.
- getMessage()
- Method in class com.marklogic.client.io.SearchHandle.Warning
-
Returns the text of the warning message.
- getMessage()
- Method in exception com.marklogic.client.MarkLogicServerException
-
- getMetadata()
- Method in class com.marklogic.client.alerting.RuleDefinition
-
Gets the metadata object associated with this
rule
- getMetadata()
- Method in interface com.marklogic.client.datamovement.WriteEvent
-
The metadata written to the server.
- getMetadata(T)
- Method in interface com.marklogic.client.document.DocumentRecord
-
Given a handle, populates the handle with the
structured metadata directly from the REST API.
- getMetadata()
- Method in interface com.marklogic.client.document.DocumentWriteOperation
-
The handle with the metadata as set by your call
to
add
or
add
.
- getMetadata()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the metadata associated with this
document.
- getMetadata(T)
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the metadata extracted from the result
document.
- getMetadataAs(Class<T>)
- Method in interface com.marklogic.client.document.DocumentRecord
-
Reads the metadata from the multipart response
into the representation specified by the IO class.
- getMetadataAs(Class<T>)
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Reads the metadata extracted from the matched
result document in the representation specified by the IO
class.
- getMetadataCategories()
- Method in interface com.marklogic.client.document.DocumentManager
-
Returns the categories of metadata to read,
write, patch, or search.
- getMetadataExtraction()
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Returns the metadata extraction policy.
- getMetadataValues()
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the metadata-values for
the document as read from the server or modified locally.
- getMethod()
- Method in class com.marklogic.client.admin.ResourceExtensionsManager.MethodParameters
-
Returns the method for the parameters.
- getMetrics()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns the metrics associated with this
search.
- getMetrics()
- Method in class com.marklogic.client.io.TuplesHandle
-
- getMetrics()
- Method in class com.marklogic.client.io.ValuesHandle
-
- getMetrics()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the search metrics.
- getMetrics()
- Method in interface com.marklogic.client.query.TuplesResults
-
Returns performance metrics about the
query.
- getMetrics()
- Method in interface com.marklogic.client.query.ValuesResults
-
Returns performance metrics about the
query.
- getMimetype()
- Method in interface com.marklogic.client.document.ContentDescriptor
-
Returns the mimetype of the content.
- getMimetype()
- Method in interface com.marklogic.client.document.DocumentRecord
-
Returns the mime-type ("Content-Type" header) of
the document as specified by the server (uses the server's
mime-type mapping for file extensions)
- getMimetype()
- Method in interface com.marklogic.client.extensions.ResourceServices.ServiceResult
-
Returns the mimetype of the content.
- getMimetype()
- Method in class com.marklogic.client.io.BaseHandle
-
- getMimeType()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the mime type associated with this
document.
- getMinHosts()
- Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
- getName()
- Method in class com.marklogic.client.alerting.RuleDefinition
-
Gets the name of the rule.
- getName()
- Method in class com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier.Builtin
-
Returns the name of the built-in.
- getName()
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getName()
- Method in class com.marklogic.client.document.ServerTransform
-
Gets the name of the invoked transform.
- getName()
- Method in class com.marklogic.client.extensions.ResourceManager
-
Returns the name of the resource.
- getName()
- Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the name of the message.
- getName()
- Method in class com.marklogic.client.io.TuplesHandle
-
- getName()
- Method in class com.marklogic.client.io.ValuesHandle
-
- getName()
- Method in class com.marklogic.client.query.AggregateResult
-
Returns the name of this aggregate.
- getName()
- Method in interface com.marklogic.client.query.FacetResult
-
Returns the facet name.
- getName()
- Method in interface com.marklogic.client.query.FacetValue
-
Returns the name of the facet value.
- getName()
- Method in interface com.marklogic.client.query.TuplesResults
-
Returns the name of the tuples.
- getName()
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the name of the values constraint.
- getName()
- Method in interface com.marklogic.client.query.ValuesResults
-
Returns the name of the values.
- getName()
- Method in interface com.marklogic.client.semantics.SPARQLBinding
-
- getName()
- Method in class com.marklogic.client.semantics.SPARQLRuleset
-
- getNamedGraphUris()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getNamespaceContext()
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getNamespaceContext()
- Method in interface com.marklogic.client.util.NameMap
-
Returns the namespace context (if any) that
declares the namespace bindings used to convert prefixed string
names into QNames.
- getNamespaceCount()
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getNamespacePrefix(int)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getNamespaces()
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Returns the namespaces available for the paths
of a patch against XML documents.
- getNamespaces()
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Gets the namespace bindings used for the
query.
- getNamespaceURI()
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getNamespaceURI(int)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getNamespaceURI(String)
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getNamespaceURI(String)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the URI for a namespace binding.
- getNonDocumentFormat()
- Method in interface com.marklogic.client.document.DocumentManager
-
- getNonNegativeIntegerItems()
- Method in interface com.marklogic.client.type.XsNonNegativeIntegerSeqVal
-
- getNumber()
- Method in interface com.marklogic.client.eval.EvalResult
-
This result parsed to a Number.
- getNumericItems()
- Method in interface com.marklogic.client.type.XsNumericSeqVal
-
- getOpenReplicaHost()
- Method in interface com.marklogic.client.datamovement.Forest
-
The replica host name associated with the forest
in the MarkLogic server.
- getOperationType()
- Method in interface com.marklogic.client.document.DocumentWriteOperation
-
- getOptimize()
- Method in interface com.marklogic.client.row.RowManager
-
- getOptimizeLevel()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getOptionsMap()
- Method in class com.marklogic.client.query.QueryOptionsListBuilder.OptionsList
-
- getOptionsName()
- Method in class com.marklogic.client.io.ValuesListHandle
-
Returns the name of the query options used for
this query.
- getOptionsName()
- Method in interface com.marklogic.client.query.SearchQueryDefinition
-
Returns the name of the query options used for
this query.
- getOptionsName()
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the name of the query options used for
this query.
- getOptionsName()
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the name of the options node used for
this values query.
- getOptionsName()
- Method in interface com.marklogic.client.query.ValuesListDefinition
-
Returns the name of the options node associated
with this query.
- getOther(String)
- Static method in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
This method creates a CoordinateSystem with the
specified string and sets doublePrecision to false
- getOther(String, boolean)
- Static method in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
This method creates a CoordinateSystem with the
specified string and sets doublePrecision to the specified
isDoublePrecision boolean
- getOutputFormat()
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the dom4j output format for serializing
XML content.
- getOutputter()
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Returns the JDOM serializer for XML
content.
- getPageLength()
- Method in interface com.marklogic.client.document.DocumentManager
-
Get the maximum number of records to return in a
page from calls to
search
- getPageLength()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns the page length for this search.
- getPageLength()
- Method in interface com.marklogic.client.pojo.PojoRepository
-
The number of instances per page returned when
calling
readAll
or
search
(Default: 50).
- getPageLength()
- Method in interface com.marklogic.client.query.QueryManager
-
Returns the maximum number of documents that can
appear in any page of query results.
- getPageLength()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the maximum number of results in the
search response page.
- getPageLength()
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
- getPageNumber()
- Method in interface com.marklogic.client.Page
-
The page number within the count of all possible
pages.
- getPageSize()
- Method in interface com.marklogic.client.Page
-
The page size which is the maximum number of
items allowed in one page.
- getParser()
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
Returns the parser used to construct element
objects from JSON.
- getPassword()
- Method in class com.marklogic.client.DatabaseClientFactory.BasicAuthContext
-
- getPassword()
- Method in class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- getPath()
- Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
gets the path of this module/asset
- getPath()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the path of the match.
- getPath()
- Method in interface com.marklogic.client.query.MatchLocation
-
Returns the path to the matching location in the
document.
- getPermissions()
- Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
gets the list of permissions assigned to this
module, beyond the default permissions.
- getPermissions()
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the permissions on the
document as read from the server or modified locally.
- getPermissions(String)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Retrieve permissions for a graph.
- getPermissions(String, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Retrieve permissions for a graph.
- getPlan()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns the query plan associated with this
search.
- getPlan(T)
- Method in class com.marklogic.client.io.SearchHandle
-
- getPlan()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the query plan.
- getPlan(T)
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the plan for the search (if
requested).
- getPort()
- Method in interface com.marklogic.client.DatabaseClient
-
- getPort()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the port for clients created with a
DatabaseClientFactory.Bean object.
- getPreferredHost()
- Method in interface com.marklogic.client.datamovement.Forest
-
Returns the host your application should talk to
for this forest.
- getPreferredHosts()
- Method in interface com.marklogic.client.datamovement.ForestConfiguration
-
A utility method to return the list of hosts a
Batcher should use when talking to this database.
- getPreferredHostType()
- Method in interface com.marklogic.client.datamovement.Forest
-
Returns the preferred host type for this
forest.
- getPrefix()
- Method in interface com.marklogic.client.datamovement.XMLSplitter.StartElementReader
-
- getPrefix(String)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the prefix for a namespace
binding.
- getPrefixes(String)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns all prefixes with a namespace
binding.
- getPrimaryClient()
- Method in interface com.marklogic.client.datamovement.Batcher
-
Gets the primary DatabaseClient associated with
the batcher
- getPrincipal()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getPrintStream()
- Method in interface com.marklogic.client.util.RequestLogger
-
Returns the underlying PrintStream used for
logging.
- getProgressAsString()
- Method in interface com.marklogic.client.datamovement.ProgressListener.ProgressUpdate
-
Gets a loggable string with the information for
the progress update.
- getProgressAsString()
- Method in class com.marklogic.client.datamovement.ProgressListener.SimpleProgressUpdate
-
- getProperties()
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns a container for the properties of the
document as read from the server or modified locally.
- getProvider()
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the name of the organization providing
the extension.
- getQName()
- Method in interface com.marklogic.client.type.XsQNameVal
-
- getQNameItems()
- Method in interface com.marklogic.client.type.XsQNameSeqVal
-
- getQuality()
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Returns the quality of the document.
- getQualityWeight()
- Method in interface com.marklogic.client.type.PlanSearchOptions
-
Changed in release 7.0.0 to return a float, as
the server requires a float and throws an error on a double.
- getQuery(T)
- Method in class com.marklogic.client.io.SearchHandle
-
- getQuery(T)
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the cts:query used in the search (if
requested).
- getQueryBatch()
- Method in interface com.marklogic.client.datamovement.ProgressListener.ProgressUpdate
-
Gets the query batcher producing the
results.
- getQueryBatch()
- Method in class com.marklogic.client.datamovement.ProgressListener.SimpleProgressUpdate
-
- getQueryBuilder()
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Get a PojoQueryBuilder for the type managed by
this PojoRepository.
- getQueryCriteria()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns the query definition used for the search
represented by this handle.
- getQueryCriteria()
- Method in class com.marklogic.client.io.TuplesHandle
-
Returns the tuples query definition used to
identify this set of tuples.
- getQueryCriteria()
- Method in class com.marklogic.client.io.ValuesHandle
-
- getQueryCriteria()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the search query definition associated
with this query.
- getQueryCriteria()
- Method in interface com.marklogic.client.query.TuplesResults
-
Returns the query used to locate these
tuples.
- getQueryCriteria()
- Method in interface com.marklogic.client.query.ValuesResults
-
Return the query definition for this set of
results.
- getQueryDefinition()
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the query definition associated with
this values query.
- getQueryFailureListeners()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Get the array of QueryFailureListener instances
registered via onBatchFailure including the
HostAvailabilityListener registered by default.
- getQueryJobCompletionListeners()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Get the array of QueryBatcherListener instances
registered via onJobCompletion.
- getQueryOptionValidation()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server validates query
options before storing them.
- getQueryResolutionTime()
- Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the query resolution time in
milliseconds.
- getQueryStrings()
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the array of strings set for this
SuggestDefinition.
- getQueryValidation()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server validates queries
before running them.
- getReader()
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Returns the dom4j reader for XML content.
- getReadTransform()
- Method in interface com.marklogic.client.document.DocumentManager
-
Returns the transform for read requests that
don't specify a transform.
- getRefreshKrb5Config()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getRelevanceInfo()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Get relevance info for a particular
result.
- getRelevanceInfo(T)
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the relevance information for the
result.
- getRenewer()
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Gets the renewer callback when specified during
construction of the SAMLAuthContext.
- getRenewTGT()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getReports()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of any reports associated with
this search.
- getReports()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of reports returned by this
search.
- getReportTimestamp()
- Method in interface com.marklogic.client.datamovement.JobReport
-
Gets the timestamp at which this instance of
JobReport was created
- getRequestHost()
- Method in interface com.marklogic.client.datamovement.Forest
-
The request host name associated with the forest
in the MarkLogic server.
- getRequestLogger()
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Returns the logger for debugging client
requests.
- getResolver()
- Method in class com.marklogic.client.io.DOMHandle
-
Returns the resolver for resolving references
while parsing the document.
- getResolver()
- Method in class com.marklogic.client.io.InputSourceHandle
-
Returns the resolver for resolving references
while parsing the input source.
- getResolver()
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Returns the resolver for resolving references
while parsing the event reader source.
- getResolver()
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Returns the resolver for resolving references
while parsing the event reader source.
- getResourceName()
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Returns the name of the resource.
- getResponseTransform()
- Method in interface com.marklogic.client.query.SearchQueryDefinition
-
Returns the transform that modifies responses to
this query on the server.
- getRoleName()
- Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
gets the role name for this permission.
- getRowEstimate()
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
After the job is started, provides an estimate
of the total number of rows to be exported from the view.
- getRowManager()
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Gets the RowManager for retrieving rows.
- getRowNum()
- Method in class com.marklogic.client.datamovement.TypedRow
-
- getRowsDoc()
- Method in interface com.marklogic.client.datamovement.RowBatchSuccessListener.RowBatchResponseEvent
-
The batch of rows retrieved for a view as an
instance of the Java class adapted by the sample handle passed to
the factory that constructs the RowBatcher.
- getRowStructureStyle()
- Method in interface com.marklogic.client.row.RowManager
-
Returns whether each row should have an array or
object structure in the response for requests made with the row
manager.
- getRulesets()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getScore()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the score associated with the
document.
- getScoreMethod()
- Method in interface com.marklogic.client.type.PlanSearchOptions
-
- getScriptLanguage()
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the script language for this resource
extension, either XQUERY (default) or JAVASCRIPT.
- getSearchView()
- Method in interface com.marklogic.client.document.DocumentManager
-
Returns the view types included in a
SearchReadHandle populated by calls to
search
- getSecurityContext()
- Method in interface com.marklogic.client.DatabaseClient
-
- getSecurityContext()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Returns the security context for clients created
with a DatabaseClientFactory.Bean object - BasicAuthContext,
DigestAuthContext or KerberosAuthContext
- getServerMessage()
- Method in exception com.marklogic.client.MarkLogicServerException
-
Gets the error message (if any) specific to the
error on the server.
- getServerMessageCode()
- Method in exception com.marklogic.client.MarkLogicServerException
-
Gets the error code (if any) specific to the
error on the server.
- getServerRequestLogging()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns whether the server logs requests to the
error log on the server.
- getServerStackTrace()
- Method in exception com.marklogic.client.MarkLogicServerException
-
Gets the stack trace (if any) specific to the
error on the server.
- getServerStatus()
- Method in exception com.marklogic.client.MarkLogicServerException
-
Gets the HTTP status message (if any) associated
with the error on the server.
- getServerStatusCode()
- Method in exception com.marklogic.client.MarkLogicServerException
-
Gets the HTTP status code (if any) associated
with the error on the server.
- getServerTimestamp()
- Method in interface com.marklogic.client.datamovement.QueryBatch
-
The server timestamp at which this query was run
(if this job is running withConsistentSnapshot()).
- getServerTimestamp()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
If withConsistentSnapshot
was used
before starting the job, will return the MarkLogic server timestamp
associated with the snapshot.
- getServerTimestamp()
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
If withConsistentSnapshot
was used
before starting the job, will return the MarkLogic server timestamp
associated with the snapshot.
- getServerTimestamp()
- Method in class com.marklogic.client.io.BaseHandle
-
- getSessionId()
- Method in interface com.marklogic.client.SessionState
-
Provides the identifier used for the server
state (for instance, for use in logging).
- getSessionState()
- Method in interface com.marklogic.client.dataservices.IOEndpoint.CallContext
-
Returns an identifier for an endpoint to use
when accessing a session cache on the server.
- getShort(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:short
schema data type as a Java short primitive value.
- getShort(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:short
schema data type as a Java short primitive value.
- getShort()
- Method in interface com.marklogic.client.type.XsShortVal
-
- getShort()
- Method in interface com.marklogic.client.type.XsUnsignedShortVal
-
- getShortItems()
- Method in interface com.marklogic.client.type.XsShortSeqVal
-
- getSimilarDocumentUris()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the uris for documents similar to the
result (if requested).
- getSnippetIterator(T)
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns an iterator over the snippets matched
for the result.
- getSnippetResolutionTime()
- Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the snippet resolution time in
milliseconds.
- getSnippets()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns an array of snippets.
- getSnippets()
- Method in interface com.marklogic.client.query.MatchLocation
-
Returns the array of elements in the
snippet.
- getSnippetTransformType()
- Method in class com.marklogic.client.io.SearchHandle
-
Identifies whether results have default, raw
document, customer, or no snippets.
- getSnippetTransformType()
- Method in interface com.marklogic.client.query.SearchResults
-
The type of transform used to produce the result
snippets.
- getSparql()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Get the SPARQL query or update statement
- getSplitFilename()
- Method in interface com.marklogic.client.datamovement.Splitter.UriMaker
-
Get splitFilename of the UriMaker, which should
include name and extension.
- getSplitters()
- Method in class com.marklogic.client.datamovement.PathSplitter
-
Get the splitterMap of the PathSplitter
- getSSLContext()
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Gets the SSL context when using SSL.
- getSSLContext()
- Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
Returns the SSLContext for an SSL client.
- getSSLHostnameVerifier()
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Gets the hostname verifier when using SSL.
- getSSLHostnameVerifier()
- Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
- getStart()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns the start page for this search.
- getStart() -
Method in interface com.marklogic.client.Page
-
The start position of this page within all
possible items.
- getStart()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the offset of the first result in the
search reponse page.
- getStartTime()
- Method in interface com.marklogic.client.datamovement.ProgressListener.ProgressUpdate
-
Gets the time when the processing started.
- getStartTime()
- Method in class com.marklogic.client.datamovement.ProgressListener.SimpleProgressUpdate
-
- getStatusCode()
- Method in interface com.marklogic.client.DatabaseClient.ConnectionResult
-
- getStoreKey()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getStorePass()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getString()
- Method in interface com.marklogic.client.eval.EvalResult
-
This result directly as a string.
- getString(String)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:string
schema data type as a Java String literal value.
- getString(PlanExprCol)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an xs:string
schema data type as a Java String literal value.
- getString()
- Method in interface com.marklogic.client.type.RdfLangStringVal
-
- getString()
- Method in interface com.marklogic.client.type.SemIriVal
-
- getString()
- Method in interface com.marklogic.client.type.XsAnyURIVal
-
- getString()
- Method in interface com.marklogic.client.type.XsStringVal
-
- getString()
- Method in interface com.marklogic.client.type.XsUntypedAtomicVal
-
- getStringCriteria()
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Returns the text of the suggestion call.
- getStringItems()
- Method in interface com.marklogic.client.type.XsStringSeqVal
-
- getStringQueries()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns the list of string queries, if specified
by the query options.
- getStringQueries()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the string query input (if provided and
requested).
- getSuccessBatchesCount()
- Method in interface com.marklogic.client.datamovement.JobReport
-
WriteBatcher
: gets the number of batches written to the database
QueryBatcher
: gets the number of batches retrieved from the database
- getSuccessEventsCount()
- Method in interface com.marklogic.client.datamovement.JobReport
-
WriteBatcher
: gets the number of documents written to the database
QueryBatcher
: gets the number of items retrieved from the database
- getSuccessListeners()
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Gets the callback functions for successfully
retrieved rows.
- getSuspendTimeForHostUnavailable()
- Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
- getTargetUri()
- Method in interface com.marklogic.client.datamovement.WriteEvent
-
The uri written to the server.
- getTemporalCollection()
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
The temporal collection configured for temporal
document inserts
- getTemporalDocumentURI()
- Method in interface com.marklogic.client.document.DocumentWriteOperation
-
The logical temporal document URI of the
document as set by your call to one of the 'add' methods which adds
a document to a
DocumentWriteSet
- getTemporalSystemTime()
- Method in interface com.marklogic.client.bitemporal.TemporalDescriptor
-
Returns the temporal system time when the
document was written or deleted.
- getText()
- Method in interface com.marklogic.client.query.MatchSnippet
-
Returns the string value of the run of text in
this part of the snippet.
- getThreadCount()
- Method in interface com.marklogic.client.datamovement.Batcher
-
- getTicketCache()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getTimeItems()
- Method in interface com.marklogic.client.type.XsTimeSeqVal
-
- getTimeSoFarInSeconds()
- Method in interface com.marklogic.client.datamovement.ProgressListener.ProgressUpdate
-
Gets the time taken by processing up to this
update.
- getTimeSoFarInSeconds()
- Method in class com.marklogic.client.datamovement.ProgressListener.SimpleProgressUpdate
-
- getTimestamp()
- Method in interface com.marklogic.client.datamovement.BatchEvent
-
The client-side timestamp when this batch
completed writing or reading.
- getTitle()
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the title of the extension.
- getToken()
- Method in class com.marklogic.client.DatabaseClientFactory.OAuthContext
-
- getToken()
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Gets the SAML authentication token
- getTokenDuration()
- Method in class com.marklogic.client.DatabaseClientFactory.MarkLogicCloudAuthContext
-
- getTokenEndpoint()
- Method in class com.marklogic.client.DatabaseClientFactory.MarkLogicCloudAuthContext
-
- getTotalPages()
- Method in interface com.marklogic.client.Page
-
The number of pages covering all possible
items.
- getTotalResults()
- Method in interface com.marklogic.client.datamovement.ProgressListener.ProgressUpdate
-
Gets the total number of results in this
update.
- getTotalResults()
- Method in class com.marklogic.client.datamovement.ProgressListener.SimpleProgressUpdate
-
- getTotalResults()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns the total number of results in this
search.
- getTotalResults()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns an estimate of the total number of
results, which is accurate for unfiltered queries.
- getTotalSize()
- Method in interface com.marklogic.client.Page
-
The total count (most likely an
estimate) of all
possible items in the set.
- getTotalTime()
- Method in interface com.marklogic.client.query.SearchMetrics
-
Returns the total time taken by the query in
milliseconds.
- getTotalTime()
- Method in interface com.marklogic.client.query.ValuesMetrics
-
Returns the total time taken by the query in
milliseconds.
- getTraceLabel()
- Method in interface com.marklogic.client.row.RowManager
-
- getTransactionId()
- Method in interface com.marklogic.client.Transaction
-
Returns the identifier for the
transaction.
- getTransform()
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- getTransformer()
- Method in class com.marklogic.client.io.SourceHandle
-
Returns a transformer for modifying the
content.
- getTrustManager()
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Gets the trust manager when using SSL.
- getTrustManager()
- Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
- getTryFirstPass()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getTuples()
- Method in class com.marklogic.client.io.TuplesHandle
-
Returns an array of the Tuples returned by this
query.
- getTuples()
- Method in interface com.marklogic.client.query.TuplesResults
-
Returns an array of Tuples.
- getType()
- Method in interface com.marklogic.client.eval.EvalResult
-
The
EvalResult.Type
of this result from the X-Primitive header provided by the REST API
eval endpoint.
- getType()
- Method in class com.marklogic.client.io.SearchHandle.Report
-
Returns the type of the message.
- getType()
- Method in class com.marklogic.client.io.ValuesHandle
-
- getType()
- Method in class com.marklogic.client.query.TypedDistinctValue
-
Returns the type of the value.
- getType()
- Method in interface com.marklogic.client.query.ValuesResults
-
Returns the type of the values.
- getUnmarshaller()
- Method in class com.marklogic.client.io.JAXBHandle
-
Returns the unmarshaller that converts a tree
data structure from XML to Java objects, reusing any existing
unmarshaller.
- getUnmarshaller(boolean)
- Method in class com.marklogic.client.io.JAXBHandle
-
Returns the unmarshaller that converts a tree
data structure from XML to Java objects.
- getUnsignedByteItems()
- Method in interface com.marklogic.client.type.XsUnsignedByteSeqVal
-
- getUnsignedIntItems()
- Method in interface com.marklogic.client.type.XsUnsignedIntSeqVal
-
- getUnsignedLongItems()
- Method in interface com.marklogic.client.type.XsUnsignedLongSeqVal
-
- getUnsignedShortItems()
- Method in interface com.marklogic.client.type.XsUnsignedShortSeqVal
-
- getUntypedAtomicItems()
- Method in interface com.marklogic.client.type.XsUntypedAtomicSeqVal
-
- getUpdatePermissions()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Get any permissions set on this instance.
- getUpdatePolicy()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Returns the policy for updating or deleting
documents in the database.
- getUpperBound()
- Method in interface com.marklogic.client.datamovement.RowBatchFailureListener.RowBatchFailureEvent
-
The upper boundary for the requested batch of
rows (useful primarily for logging).
- getUpperBound()
- Method in interface com.marklogic.client.datamovement.RowBatchSuccessListener.RowBatchResponseEvent
-
The upper boundary for the batch of rows (useful
primarily for logging).
- getUri()
- Method in interface com.marklogic.client.bitemporal.TemporalDescriptor
-
Returns the URI identifier for the database
document.
- getUri()
- Method in class com.marklogic.client.datamovement.TypedRow
-
- getUri()
- Method in interface com.marklogic.client.document.DocumentDescriptor
-
Returns the URI identifier for the database
document.
- getUri()
- Method in interface com.marklogic.client.document.DocumentRecord
-
Returns the uri (unique identifier) of the
document in the server
- getUri()
- Method in interface com.marklogic.client.document.DocumentWriteOperation
-
- getUri()
- Method in interface com.marklogic.client.query.MatchDocumentSummary
-
Returns the URI of the document.
- getUriMaker()
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Get the UriMaker of the splitter
- getUriMaker()
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Get the UriMaker of the splitter
- getUriMaker()
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Get the UriMaker of the splitter
- getUriMaker()
- Method in class com.marklogic.client.datamovement.UnarySplitter
-
Get the UriMaker of the splitter
- getUriMaker()
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Get the UriMaker of the splitter
- getUriMaker()
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Get the UriMaker of the splitter
- getUrisReadyListeners()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Get the array of QueryBatchListener instances
registered via onUrisReady.
- getUriTransformer()
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Returns the uriTransformer set to
splitter.
- getUseFirstPass()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getUseKeyTab()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getUser()
- Method in class com.marklogic.client.DatabaseClientFactory.BasicAuthContext
-
- getUser()
- Method in class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- getUseTicketCache()
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- getUsingGraphUris()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getUsingNamedGraphUris()
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- getValue()
- Method in class com.marklogic.client.query.AggregateResult
-
Returns the value of this aggregate as a
string.
- getValue()
- Method in interface com.marklogic.client.semantics.SPARQLBinding
-
- getValueAs(String, Class<T>)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an atomic schema
data type.
- getValueAs(PlanExprCol, Class<T>)
- Method in interface com.marklogic.client.row.RowRecord
-
Gets the value of a column with an atomic schema
data type.
- getValueOf(String)
- Static method in enum com.marklogic.client.io.DocumentMetadataHandle.Capability
-
- getValues()
- Method in class com.marklogic.client.io.ValuesHandle
-
- getValues()
- Method in class com.marklogic.client.query.Tuple
-
Returns an array of all the values in this
tuple.
- getValues()
- Method in interface com.marklogic.client.query.ValuesResults
-
Returns an array of the values.
- getValuesMap()
- Method in class com.marklogic.client.io.QueryOptionsListHandle
-
Returns a HashMap of the named query options
from the server.
- getValuesMap()
- Method in class com.marklogic.client.io.ValuesListHandle
-
Returns a HashMap of the named lexicon
configurations.
- getValuesMap()
- Method in interface com.marklogic.client.query.QueryOptionsListResults
-
Returns a HashMap of the named query options
from the server.
- getValuesMap()
- Method in interface com.marklogic.client.query.ValuesListResults
-
Returns the map of value results.
- getValuesResolutionTime()
- Method in interface com.marklogic.client.query.ValuesMetrics
-
Returns the query resolution time in
milliseconds.
- getVersion()
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Returns the version identifier for the extension
implementation.
- getVersion()
- Method in interface com.marklogic.client.document.DocumentDescriptor
-
Returns the version for the database
document.
- getView()
- Method in interface com.marklogic.client.query.QueryManager
-
Returns the type of view results produced by
queries.
- getView()
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Returns the view for this values query.
- getVisitor()
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Get the visitor used in JSONSplitter
class.
- getVisitor()
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Get the visitor used in XMLSplitter class.
- getWarnings()
- Method in class com.marklogic.client.io.SearchHandle
-
Returns an array of any warnings associated with
this search.
- getWarnings()
- Method in interface com.marklogic.client.query.SearchResults
-
Returns the array of warnings returned by this
search.
- getWriteTransform()
- Method in interface com.marklogic.client.document.DocumentManager
-
Returns the transform for write requests that
don't specify a transform.
- getXMLGregorianCalendar()
- Method in interface com.marklogic.client.type.XsGDayVal
-
- getXMLGregorianCalendar()
- Method in interface com.marklogic.client.type.XsGMonthDayVal
-
- getXMLGregorianCalendar()
- Method in interface com.marklogic.client.type.XsGMonthVal
-
- getXMLGregorianCalendar()
- Method in interface com.marklogic.client.type.XsGYearMonthVal
-
- getXMLGregorianCalendar()
- Method in interface com.marklogic.client.type.XsGYearVal
-
- getXPathProcessor()
- Method in class com.marklogic.client.io.DOMHandle
-
Get the processor used to evaluate XPath
expressions.
- getYearMonthDurationItems()
- Method in interface com.marklogic.client.type.XsYearMonthDurationSeqVal
-
- glob(ServerExpression, String)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns true if the specified input glob the
specified pattern, otherwise returns false.
- glob(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns true if the specified input glob the
specified pattern, otherwise returns false.
- gMonth(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:gMonth server data type.
- gMonth(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a month as a string and constructs an
xs:gMonth value
- gMonth(XMLGregorianCalendar)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a month as a XMLGregorianCalendar value
and constructs an xs:gMonth value
- gMonthDay(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:gMonthDay server data type.
- gMonthDay(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a day and month as a string and constructs
an xs:gMonthDay value
- gMonthDay(XMLGregorianCalendar)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a day and month as a XMLGregorianCalendar
value and constructs an xs:gMonthDay value
- gMonthDaySeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of days and months as a string
and constructs an xs:gMonthDay sequence
- gMonthDaySeq(XMLGregorianCalendar...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of days and months as a
XMLGregorianCalendar value and constructs an xs:gMonthDay
sequence
- gMonthDaySeq(XsGMonthDayVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gMonthDay values and
constructs an xs:gMonthDay sequence
- gMonthSeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of months as a string and
constructs an xs:gMonth sequence
- gMonthSeq(XMLGregorianCalendar...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of months as a
XMLGregorianCalendar value and constructs an xs:gMonth
sequence
- gMonthSeq(XsGMonthVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gMonth values and
constructs an xs:gMonth sequence
- graphCol(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies the graph for a triple providing one
or more columns for a row.
- graphCol(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies the graph for a triple providing one
or more columns for a row.
- GraphManager - Interface in com.marklogic.client.semantics
-
A manager for CRUD operations on semantic graphs
which reside in MarkLogic Server.
- GraphPermissions - Interface in com.marklogic.client.semantics
-
A Map of permissions for a graph, where the keys
are roles and the values are the Set of capabilities available to
that role (one of READ, UPDATE, or EXECUTE).
- graphql(JSONWriteHandle, T)
- Method in interface com.marklogic.client.row.RowManager
-
Executes a GraphQL query against the database
and returns the results as a JSON object.
- graphqlAs(JSONWriteHandle, Class<T>)
- Method in interface com.marklogic.client.row.RowManager
-
Executes a GraphQL query against the database
and returns the results as a JSON object.
- group(PlanExprColSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies the grouping keys for a
group as a list of zero or more columns.
- group(String...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
- groupBy(PlanExprColSeq)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method collapses a group of rows into a
single row.
- groupBy(PlanExprColSeq, PlanAggregateColSeq)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method collapses a group of rows into a
single row.
- groupByUnion(PlanGroupSeq)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
Constructs multiple groups over a single row set
in a single pass.
- groupByUnion(PlanGroupSeq, PlanAggregateColSeq)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
Constructs multiple groups over a single row set
in a single pass.
- groupConcat(String, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
This function concatenates the non-null values
of the column for the rows in the group or row set.
- groupConcat(PlanColumn, PlanExprCol)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
This function concatenates the non-null values
of the column for the rows in the group or row set.
- groupConcat(String, String, PlanGroupConcatOptionSeq)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
This function concatenates the non-null values
of the column for the rows in the group or row set.
- groupConcat(PlanColumn, PlanExprCol, PlanGroupConcatOptionSeq)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
This function concatenates the non-null values
of the column for the rows in the group or row set.
- groupConcatOptions(String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Specifies options for aggregating the values of
a column for the rows belonging to each group by concatenating the
values into a single string value.
- groupConcatOptions(PlanValueOption)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Specifies options for aggregating the values of
a column for the rows belonging to each group by concatenating the
values into a single string value.
- groupConcatOptions(String, PlanValueOption)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Specifies options for aggregating the values of
a column for the rows belonging to each group by concatenating the
values into a single string value.
- groupKey(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
- groupKey(PlanColumn, PlanExprCol)
- Method in class com.marklogic.client.expression.PlanBuilder
-
- groupSeq(PlanGroup...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
- groupToArrays(PlanNamedGroupSeq)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
- groupToArrays(PlanNamedGroupSeq, PlanAggregateColSeq)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
- GSONHandle - Class in com.marklogic.client.extra.gson
-
A GSONHandle represents JSON content as a GSON
JsonElement for reading or writing.
- GSONHandle()
- Constructor for class com.marklogic.client.extra.gson.GSONHandle
-
Zero-argument constructor.
- GSONHandle(JsonElement)
- Constructor for class com.marklogic.client.extra.gson.GSONHandle
-
Provides a handle on JSON content as a
tree.
- gt(ServerExpression, ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if the value of the
left expression is greater than the value of the right
expression.
- gYear(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:gYear server data type.
- gYear(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a year as a string and constructs an
xs:gYear value
- gYear(XMLGregorianCalendar)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a year as a XMLGregorianCalendar value and
constructs an xs:gYear value
- gYearMonth(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:gYearMonth server data type.
- gYearMonth(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a month and year as a string and
constructs an xs:gYearMonth value
- gYearMonth(XMLGregorianCalendar)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a month and year as a XMLGregorianCalendar
value and constructs an xs:gYearMonth value
- gYearMonthSeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of months and years as a string
and constructs an xs:gYearMonth sequence
- gYearMonthSeq(XMLGregorianCalendar...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of months and years as a
XMLGregorianCalendar value and constructs an xs:gYearMonth
sequence
- gYearMonthSeq(XsGYearMonthVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gYearMonth values and
constructs an xs:gYearMonth sequence
- gYearSeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of years as a string and
constructs an xs:gYear sequence
- gYearSeq(XMLGregorianCalendar...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of years as a
XMLGregorianCalendar value and constructs an xs:gYear
sequence
- gYearSeq(XsGYearVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:gYear values and
constructs an xs:gYear sequence
- JacksonCSVSplitter - Class in com.marklogic.client.datamovement
-
The JacksonCSVSplitter class uses the Jackson
CSV parser without attempting to abstract it capabilities.
- JacksonCSVSplitter()
- Constructor for class com.marklogic.client.datamovement.JacksonCSVSplitter
-
- JacksonCSVSplitter.UriMaker - Interface
in com.marklogic.client.datamovement
-
UriMaker which generates URI for each split
file
- JacksonDatabindHandle<T> - Class in
com.marklogic.client.io
-
An adapter for using the Jackson Open Source
library for JSON; represents JSON content for reading or writing as
objects of the specified POJO class.
- JacksonDatabindHandle(Class<T>)
- Constructor for class com.marklogic.client.io.JacksonDatabindHandle
-
Specify the type of content this
JacksonDatabindHandle will manage.
- JacksonDatabindHandle(T)
- Constructor for class com.marklogic.client.io.JacksonDatabindHandle
-
Provides a handle on POJO content.
- JacksonHandle - Class in com.marklogic.client.io
-
An adapter for using the Jackson Open Source
library for JSON; represents JSON content as a Jackson JsonNode for
reading or writing.
- JacksonHandle()
- Constructor for class com.marklogic.client.io.JacksonHandle
-
Zero-argument constructor.
- JacksonHandle(JsonNode)
- Constructor for class com.marklogic.client.io.JacksonHandle
-
Provides a handle on JSON content as a Jackson
tree.
- JacksonParserHandle - Class in com.marklogic.client.io
-
An adapter for using the streaming capabilities
of the Jackson Open Source library.
- JacksonParserHandle()
- Constructor for class com.marklogic.client.io.JacksonParserHandle
-
- JAVASCRIPT
- Static variable in class com.marklogic.client.admin.ExtensionMetadata
-
Convenience constant to provide something
shorter than ExtensionMetadata.ScriptLanguage.JAVASCRIPT
- javascript(String)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this server-side eval with
javascript-syntax source code.
- javascript(TextWriteHandle)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this server-side eval call with
javascript-syntax source code.
- JAXBHandle<C> - Class in com.marklogic.client.io
-
A JAXB Handle roundtrips a POJO (a Java data
structure) to and from a database document.
- JAXBHandle(JAXBContext)
- Constructor for class com.marklogic.client.io.JAXBHandle
-
Initializes the JAXB handle with the JAXB
context for the classes of the marshalled or unmarshalled
structure.
- JAXBHandle(JAXBContext, Class<C>)
- Constructor for class com.marklogic.client.io.JAXBHandle
-
Initializes the JAXB handle with the JAXB
context for the classes of the marshalled or unmarshalled
structure.
- JDOMHandle - Class in com.marklogic.client.extra.jdom
-
A JDOM Handle represents XML content as a JDOM
document for reading or writing.
- JDOMHandle()
- Constructor for class com.marklogic.client.extra.jdom.JDOMHandle
-
Zero-argument constructor.
- JDOMHandle(Document)
- Constructor for class com.marklogic.client.extra.jdom.JDOMHandle
-
Provides a handle on XML content as a JDOM
document structure.
- JobReport - Interface in com.marklogic.client.datamovement
-
A Job report is used to report status on a
WriteBatcher
or a
QueryBatcher
job at any point of time after it is started and provide a snapshot
of the job's status at that time.
- JobTicket - Interface in com.marklogic.client.datamovement
-
JobTicket is used to uniquely identify a
job.
- JobTicket.JobType - Enum in com.marklogic.client.datamovement
-
- joinCrossProduct(PlanBuilder.ModifyPlan)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set that
concatenates every left row with every right row.
- joinCrossProduct(PlanBuilder.ModifyPlan, boolean)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set that
concatenates every left row with every right row.
- joinCrossProduct(PlanBuilder.ModifyPlan, ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set that
concatenates every left row with every right row.
- joinDoc(String, String)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This function specifies a document column to add
to the rows by reading the documents for an existing source column
having a value of a document uri (which can be used to read other
documents) or a fragment id (which can be used to read the source
documents for rows).
- joinDoc(PlanColumn, PlanColumn)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This function specifies a document column to add
to the rows by reading the documents for an existing source column
having a value of a document uri (which can be used to read other
documents) or a fragment id (which can be used to read the source
documents for rows).
- joinDocAndUri(String, String, String)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method adds an uri column and a document
column to rows based on an existing source column having a value of
a document uri (which can be used to read other documents) or a
fragment id (which can be used to read the source documents for
rows).
- joinDocAndUri(PlanColumn, PlanColumn, PlanColumn)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method adds an uri column and a document
column to rows based on an existing source column having a value of
a document uri (which can be used to read other documents) or a
fragment id (which can be used to read the source documents for
rows).
- joinDocCols(PlanDocColsIdentifier, String)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This function populates the view with the uri,
doc, collections, metadata, permissions, and / or quality document
descriptor columns for database document values.
- joinDocCols(PlanDocColsIdentifier, PlanColumn)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This function populates the view with the uri,
doc, collections, metadata, permissions, and / or quality document
descriptor columns for database document values.
- joinDocUri(String, String)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method adds a uri column to rows based on
an existing fragment id column to identify the source document for
each row.
- joinDocUri(PlanColumn, PlanColumn)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method adds a uri column to rows based on
an existing fragment id column to identify the source document for
each row.
- joinFullOuter(PlanBuilder.ModifyPlan)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
- joinFullOuter(PlanBuilder.ModifyPlan, PlanJoinKey...)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
- joinFullOuter(PlanBuilder.ModifyPlan, PlanJoinKeySeq)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
- joinFullOuter(PlanBuilder.ModifyPlan, PlanJoinKeySeq, boolean)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
- joinFullOuter(PlanBuilder.ModifyPlan, PlanJoinKeySeq, ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from both the
left and right row sets.
- joinInner(PlanBuilder.ModifyPlan)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method returns all rows from multiple
tables where the join condition is met.
- joinInner(PlanBuilder.ModifyPlan, PlanJoinKey...)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method returns all rows from multiple
tables where the join condition is met.
- joinInner(PlanBuilder.ModifyPlan, PlanJoinKeySeq)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method returns all rows from multiple
tables where the join condition is met.
- joinInner(PlanBuilder.ModifyPlan, PlanJoinKeySeq, boolean)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method returns all rows from multiple
tables where the join condition is met.
- joinInner(PlanBuilder.ModifyPlan, PlanJoinKeySeq, ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method returns all rows from multiple
tables where the join condition is met.
- joinKeySeq(PlanJoinKey...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a sequence from multiple key values
to pass as a parameter to an operation.
- joinLeftOuter(PlanBuilder.ModifyPlan)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
- joinLeftOuter(PlanBuilder.ModifyPlan, PlanJoinKey...)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
- joinLeftOuter(PlanBuilder.ModifyPlan, PlanJoinKeySeq)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
- joinLeftOuter(PlanBuilder.ModifyPlan, PlanJoinKeySeq, boolean)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
- joinLeftOuter(PlanBuilder.ModifyPlan, PlanJoinKeySeq, ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method yields one output row set with the
rows from an inner join as well as the other rows from the left row
set.
- json
- Variable in class com.marklogic.client.expression.CtsQueryBuilder
-
Builds expressions with json server
functions.
- json
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with json server
functions.
- jsonArray(ServerExpression...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
This function constructs a JSON array during row
processing.
- jsonBoolean(boolean)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON boolean node
with the specified value.
- jsonBoolean(ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON boolean node
with the specified value.
- jsonDocument(ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON document with
the root content, which must be exactly one JSON object or array
node.
- JSONDocumentManager - Interface in
com.marklogic.client.document
-
A JSON Document Manager supports database
operations on JSON documents.
- JSONErrorParser - Class in com.marklogic.client.io
-
This class is provided as a convenience method
for parsing MarkLogic errors that are serialized as JSON.
- JSONErrorParser()
- Constructor for class com.marklogic.client.io.JSONErrorParser
-
- JsonExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the json
server library for a row pipeline.
- jsonNull()
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON null node.
- jsonNumber(double)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON number node with
the specified value.
- jsonNumber(ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON number node with
the specified value.
- jsonObject(PlanJsonProperty...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
This function constructs a JSON object with the
specified properties.
- jsonProperty(String)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a JSON property to match with a
query.
- jsonPropertyChildGeospatialQuery(String, String, CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(String, String, ServerExpression, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(String, String, ServerExpression, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- jsonPropertyChildGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific children representing latitude and longitude
values for a point contained within the given geographic box,
circle, or polygon, or equal to the given point.
- jsonPropertyGeospatialQuery(String, CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
- jsonPropertyGeospatialQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
- jsonPropertyGeospatialQuery(String, ServerExpression, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
- jsonPropertyGeospatialQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
- jsonPropertyGeospatialQuery(String, ServerExpression, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
- jsonPropertyGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
whose content represents a point contained within the given
geographic box, circle, or polygon, or equal to the given
point.
- jsonPropertyPairGeospatialQuery(String, String, String, CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(String, String, String, ServerExpression, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(String, String, String, ServerExpression, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- jsonPropertyPairGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching json properties by name
which has specific property children representing latitude and
longitude values for a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- jsonPropertyRangeQuery(String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(String, String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(String, String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
- jsonPropertyRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by
name with a range-index entry equal to a given value.
- jsonPropertyReference(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a JSON property value
lexicon, for use as a parameter to cts:value-tuples.
- jsonPropertyReference(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a JSON property value
lexicon, for use as a parameter to cts:value-tuples.
- jsonPropertyReference(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a JSON property value
lexicon, for use as a parameter to cts:value-tuples.
- jsonPropertyReference(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a JSON property value
lexicon, for use as a parameter to cts:value-tuples.
- jsonPropertyScopeQuery(String, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by
name with the content constrained by the given cts:query in the
second parameter.
- jsonPropertyScopeQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching JSON properties by
name with the content constrained by the given cts:query in the
second parameter.
- jsonPropertyValueQuery(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with value equal the given value.
- jsonPropertyValueQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with value equal the given value.
- jsonPropertyValueQuery(String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with value equal the given value.
- jsonPropertyValueQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with value equal the given value.
- jsonPropertyValueQuery(String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with value equal the given value.
- jsonPropertyValueQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with value equal the given value.
- jsonPropertyWordQuery(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with text content containing a given phrase.
- jsonPropertyWordQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with text content containing a given phrase.
- jsonPropertyWordQuery(String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with text content containing a given phrase.
- jsonPropertyWordQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with text content containing a given phrase.
- jsonPropertyWordQuery(String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with text content containing a given phrase.
- jsonPropertyWordQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching JSON properties by name
with text content containing a given phrase.
- JSONReadHandle - Interface in com.marklogic.client.io.marker
-
A JSON Read Handle can represent JSON content
read from the database.
- JSONSplitter<T extends JSONWriteHandle>
- Class in com.marklogic.client.datamovement
-
The JSONSplitter is used to split large JSON
file into separate payloads for writing to the database.
- JSONSplitter(JSONSplitter.Visitor<T>)
- Constructor for class com.marklogic.client.datamovement.JSONSplitter
-
Construct a JSONSplitter which splits the JSON
file according to the visitor.
- JSONSplitter.ArrayVisitor - Class in
com.marklogic.client.datamovement
-
The basic visitor only splits objects or arrays
under top array.
- JSONSplitter.UriMaker - Interface in
com.marklogic.client.datamovement
-
UriMaker which generates URI for each split
file
- JSONSplitter.Visitor<T extends
AbstractWriteHandle>
- Class in com.marklogic.client.datamovement
-
The Visitor class is used to accumulate and
inspect state during the depth-first traversal of the JSON tree and
make the decision of how to split the JSON file.
- jsonString(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON text node with
the specified value.
- jsonString(ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function constructs a JSON text node with
the specified value.
- JSONWriteHandle - Interface in com.marklogic.client.io.marker
-
A JSON Write Handle can represent JSON content
written to the database.
- N3
- Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- name(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the name of a node, as an xs:string that
is either the zero-length string, or has the lexical form of an
xs:QName.
- Name(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the xs:Name
server data type.
- namedGroup(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies the grouping keys for a
group as a named list of zero or more columns.
- namedGroup(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies the grouping keys for a
group as a named list of zero or more columns.
- namedGroup(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies the grouping keys for a
group as a named list of zero or more columns.
- namedGroup(XsStringVal, PlanExprColSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies the grouping keys for a
group as a named list of zero or more columns.
- namedGroup(String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
- namedGroup(String, PlanExprColSeq)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
- namedGroupSeq(PlanNamedGroup...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
- NameMap<V> - Interface in com.marklogic.client.util
-
A NameMap defines the interface for maps where
the key is a QName (a name qualified by a URI for global uniqueness
or for association with a domain).
- namespaceContext(EditableNamespaceContext)
- Method in interface com.marklogic.client.eval.ServerEvaluationCall
-
Initialize this call with namespaces so
variables with prefixes can be sent with their prefixes translated
to uris that will match the uris in the code to be executed on the
server.
- namespaceUri(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the namespace URI of the xs:QName of the
node specified by arg.
- namespaceUriForPrefix(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the namespace URI of one of the in-scope
namespaces for element, identified by its namespace prefix.
- namespaceUriFromQName(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the namespace URI for arg as an
xs:string.
- NCName(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:NCName server data type.
- ne(ServerExpression, ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if the value of the
left expression is not equal to the value of the right
expression.
- near(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- near(StructuredQueryDefinition...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- near(StructuredQueryDefinition...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NEAR query over the list of query
definitions with default parameters.
- near(int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NEAR query over the list of query
definitions with specified parameters.
- near(int, int, double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NEAR query over the list of query
definitions with specified parameters.
- nearQuery(CtsQueryExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
- nearQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
- nearQuery(ServerExpression, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
- nearQuery(ServerExpression, XsDoubleVal)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
- nearQuery(ServerExpression, double, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
- nearQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
- nearQuery(ServerExpression, double, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
- nearQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching all of the specified
queries, where the matches occur within the specified distance from
each other.
- NearQuery(StructuredQueryDefinition...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.NearQuery
-
- NearQuery(Integer, Integer, Double, StructuredQueryBuilder.Ordering, StructuredQueryDefinition...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.NearQuery
-
- negativeInteger(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:negativeInteger server data type.
- newArray(int)
- Method in class com.marklogic.client.io.BytesHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.DOMHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.FileHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.InputSourceHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.InputStreamHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.JacksonHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
- newArray(int)
- Method in interface com.marklogic.client.io.marker.ContentHandle
-
Constructs an array for the handled content
representation
- newArray(int)
- Method in class com.marklogic.client.io.ReaderHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.SourceHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.StringHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- newArray(int)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- newBinaryDocumentManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents with a
binary format such as images.
- newCallContext()
- Method in interface com.marklogic.client.dataservices.IOEndpoint
-
Constructs a context for the calls that
specifying the optional endpoint constants, endpoint state, and
session.
- newClient()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Creates a client for bean applications based on
the properties.
- newClient(Function<String, Object>)
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means
of a REST server with connection and authentication information
retrieved from the given propertySource
.
- newClient(String, int, DatabaseClientFactory.SecurityContext)
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means
of a REST server.
- newClient(String, int, DatabaseClientFactory.SecurityContext, DatabaseClient.ConnectionType)
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means
of a REST server.
- newClient(String, int, String, DatabaseClientFactory.SecurityContext)
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means
of a REST server.
- newClient(String, int, String, DatabaseClientFactory.SecurityContext, DatabaseClient.ConnectionType)
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means
of a REST server.
- newClient(String, int, String, String, DatabaseClientFactory.SecurityContext, DatabaseClient.ConnectionType)
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Creates a client to access the database by means
of a REST server.
- newCtsQueryDefinition(CtsQueryExpr)
- Method in class com.marklogic.client.expression.CtsQueryBuilder
-
Create a CtsQueryDefinition based on a cts
query
- newCtsQueryDefinition(CtsQueryExpr, JSONWriteHandle)
- Method in class com.marklogic.client.expression.CtsQueryBuilder
-
Create a CtsQueryDefinition based on a cts query
and query options
- newCtsSearchBuilder()
- Method in interface com.marklogic.client.query.QueryManager
-
Returns a new CtsSearchBuilder.
- newDataMovementManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for long-running asynchronous
write or query jobs.
- newDeleteDefinition()
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for deleting
documents.
- newDescriptor(String)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a document descriptor for identifying
the uri of a document, its format and mimetype, and its
version.
- newDocumentManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents with
unknown or heterogeneous formats.
- newDocumentUriTemplate(String)
- Method in interface com.marklogic.client.document.DocumentManager
-
Creates a document uri template for assigning a
uri to a document.
- newExpiringSAMLAuth(String, Instant)
- Static method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Constructs an ExpiringSAMLAuth with a SAML
assertions token and the expiration time stamp for the token.
- newExpr()
- Method in interface com.marklogic.client.expression.MapExpr
-
Constructs a new map by combining the keys from
the maps given as an argument.
- newExpr(ServerExpression)
- Method in interface com.marklogic.client.expression.MapExpr
-
Constructs a new map by combining the keys from
the maps given as an argument.
- newExtensionLibrariesManager()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for writing and reading assets
in the REST server's modules database.
- newFactory()
- Static method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Creates a factory to create a DOM4JHandle
instance for a dom4j document.
- newFactory()
- Static method in class com.marklogic.client.extra.gson.GSONHandle
-
Creates a factory to create a GSONHandle
instance for a JsonElement node.
- newFactory()
- Static method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Creates a factory to create a JDOMHandle
instance for a JDOM document.
- newFactory()
- Static method in class com.marklogic.client.io.BytesHandle
-
Creates a factory to create a BytesHandle
instance for a byte[] array.
- newFactory()
- Static method in class com.marklogic.client.io.DOMHandle
-
Creates a factory to create a DOMHandle instance
for a DOM document.
- newFactory()
- Static method in class com.marklogic.client.io.FileHandle
-
Creates a factory to create a FileHandle for a
file.
- newFactory()
- Static method in class com.marklogic.client.io.InputSourceHandle
-
Creates a factory to create a InputSourceHandle
instance for a SAX InputSource.
- newFactory()
- Static method in class com.marklogic.client.io.InputStreamHandle
-
Creates a factory to create an InputStreamHandle
instance for an input stream.
- newFactory(Class<?>...)
- Static method in class com.marklogic.client.io.JacksonDatabindHandle
-
Creates a factory to create a
JacksonDatabindHandle instance for POJO instances of the specified
classes.
- newFactory(ObjectMapper, Class<?>...)
- Static method in class com.marklogic.client.io.JacksonDatabindHandle
-
Creates a factory to create a
JacksonDatabindHandle instance for POJO instances of the specified
classes.
- newFactory()
- Static method in class com.marklogic.client.io.JacksonHandle
-
Creates a factory to create a JacksonHandle
instance for a JSON node.
- newFactory()
- Static method in class com.marklogic.client.io.JacksonParserHandle
-
Creates a factory to create a
JacksonParserHandle instance for a JsonParser.
- newFactory(Class<?>...)
- Static method in class com.marklogic.client.io.JAXBHandle
-
Creates a factory to create a JAXBHandle
instance for POJO instances of the specified classes.
- newFactory(JAXBContext, Class<?>...)
- Static method in class com.marklogic.client.io.JAXBHandle
-
Creates a factory to create a JAXBHandle
instance for POJO instances of the specified classes.
- newFactory()
- Static method in class com.marklogic.client.io.ReaderHandle
-
Creates a factory to create a ReaderHandle
instance for a Reader.
- newFactory()
- Static method in class com.marklogic.client.io.SourceHandle
-
Creates a factory to create a SourceHandle
instance for a Transformer Source.
- newFactory()
- Static method in class com.marklogic.client.io.StringHandle
-
Creates a factory to create a StringHandle
instance for a string.
- newFactory()
- Static method in class com.marklogic.client.io.XMLEventReaderHandle
-
Creates a factory to create an
XMLEventReaderHandle instance for a StAX event reader.
- newFactory()
- Static method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Creates a factory to create an
XMLStreamReaderHandle instance for a StAX stream reader.
- newGraphManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for CRUD operations on
semantic graphs.
- newGraphPermissions()
- Method in interface com.marklogic.client.semantics.GraphManager
-
Get an empty GraphPermissions instance.
- newHandle()
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- newHandle()
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
- newHandle()
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- newHandle()
- Method in class com.marklogic.client.io.BytesHandle
-
- newHandle()
- Method in class com.marklogic.client.io.DOMHandle
-
- newHandle()
- Method in class com.marklogic.client.io.FileHandle
-
- newHandle()
- Method in class com.marklogic.client.io.InputSourceHandle
-
- newHandle()
- Method in class com.marklogic.client.io.InputStreamHandle
-
- newHandle()
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
- newHandle()
- Method in class com.marklogic.client.io.JacksonHandle
-
- newHandle()
- Method in class com.marklogic.client.io.JacksonParserHandle
-
- newHandle()
- Method in class com.marklogic.client.io.JAXBHandle
-
- newHandle()
- Method in interface com.marklogic.client.io.marker.BufferableContentHandle
-
- newHandle(C)
- Method in interface com.marklogic.client.io.marker.BufferableContentHandle
-
- newHandle()
- Method in interface com.marklogic.client.io.marker.ContentHandle
-
Constructs a new handle for the same content
representation, initializing the new handle with the same format
and mime type.
- newHandle(C)
- Method in interface com.marklogic.client.io.marker.ContentHandle
-
Constructs a new handle for the same content
representation, initializing the new handle with the same format
and mime type and new content.
- newHandle(Class<C>)
- Method in interface com.marklogic.client.io.marker.ContentHandleFactory
-
Instantiates a handle for an IO class recognized
by the factory.
- newHandle()
- Method in interface com.marklogic.client.io.marker.ResendableContentHandle
-
- newHandle(C)
- Method in interface com.marklogic.client.io.marker.ResendableContentHandle
-
- newHandle()
- Method in class com.marklogic.client.io.ReaderHandle
-
- newHandle()
- Method in class com.marklogic.client.io.SourceHandle
-
- newHandle()
- Method in class com.marklogic.client.io.StringHandle
-
- newHandle()
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- newHandle()
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.BytesHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.DOMHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.FileHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.InputSourceHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.InputStreamHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.JacksonHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.JAXBHandle
-
- newHandleArray(int)
- Method in interface com.marklogic.client.io.marker.BufferableContentHandle
-
Constructs an uninitialized array with the
specified length with items of the same content
representation.
- newHandleArray(int)
- Method in interface com.marklogic.client.io.marker.ResendableContentHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.ReaderHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.SourceHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.StringHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- newHandleArray(int)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- newJSONDocumentManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents
containing a JSON structure.
- newLogger(OutputStream)
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a logger for document and query
requests.
- newOkHttpClientBuilder(String, DatabaseClientFactory.SecurityContext)
- Static method in interface
com.marklogic.client.extra.okhttpclient.OkHttpClientBuilderFactory
-
- newPatchBuilder(Format)
- Method in interface com.marklogic.client.document.DocumentManager
-
For XMLDocumentManager or JSONDocumentManager,
creates a builder for specifying changes to the document and
metadata of a document.
- newPatchBuilder()
- Method in interface com.marklogic.client.document.JSONDocumentManager
-
Creates a builder for specifying changes to the
content and metadata of a JSON document.
- newPatchBuilder()
- Method in interface com.marklogic.client.document.XMLDocumentManager
-
Creates a builder for specifying changes to the
content and metadata of an XML document.
- newPlanBuilder()
- Method in interface com.marklogic.client.row.RowManager
-
Creates a builder to define a plan for
constructing and retrieving database rows.
- newPojoRepository(Class<T>, Class<ID>)
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a PojoRepository specific to the
specified class and its id type.
- newProgressUpdate(QueryBatch, long, long, double)
- Method in class com.marklogic.client.datamovement.ProgressListener
-
A subclass can override this to provide a
different implementation of ProgressUpdate.
- newQueryBatcher(CtsQueryDefinition)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
- newQueryBatcher(StructuredQueryDefinition)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
- newQueryBatcher(RawStructuredQueryDefinition)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
- newQueryBatcher(StringQueryDefinition)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
- newQueryBatcher(RawCombinedQueryDefinition)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to
retrieve uris that match this query.
- newQueryBatcher(RawCtsQueryDefinition)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to
retrieve uris that match this Cts query.
- newQueryBatcher(Iterator<String>)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new QueryBatcher instance configured to
retrieve uris from this Iterator.
- newQueryDefinition()
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Instantiate a new SPARQLQueryDefinition.
- newQueryDefinition(String)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Instantiate a new SPARQLQueryDefinition with
provided SPARQL.
- newQueryDefinition(TextWriteHandle)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Instantiate a new SPARQLQueryDefinition with the
SPARQL from the provided TextWriteHandle.
- newQueryManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager to query for database
documents.
- newQueryOptionsManager()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing,
and deleting query options.
- newRawCombinedQueryDefinition(StructureWriteHandle)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML
representation.
- newRawCombinedQueryDefinition(StructureWriteHandle, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML
representation.
- newRawCombinedQueryDefinitionAs(Format, Object)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML
representation provided as an object of an IO class.
- newRawCombinedQueryDefinitionAs(Format, Object, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a combined query from a JSON or XML
representation provided as an object of an IO class.
- newRawCtsQueryDefinition(CtsQueryWriteHandle)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a serialized cts query from a JSON or
XML representation.
- newRawCtsQueryDefinition(CtsQueryWriteHandle, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a serialized cts query from a JSON or
XML representation.
- newRawCtsQueryDefinitionAs(Format, Object)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a serialized cts query from a JSON or
XML representation provided as an object of an IO class.
- newRawCtsQueryDefinitionAs(Format, Object, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a serialized cts query from a JSON or
XML representation provided as an object of an IO class.
- newRawPlanDefinition(JSONWriteHandle)
- Method in interface com.marklogic.client.row.RowManager
-
Defines a plan from a JSON serialization of the
plan AST (Abstract Syntax Tree).
- newRawQueryByExampleDefinition(StructureWriteHandle)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or
XML representation.
- newRawQueryByExampleDefinition(StructureWriteHandle, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or
XML representation.
- newRawQueryByExampleDefinitionAs(Format, Object)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or
XML representation provided as an object of an IO class.
- newRawQueryByExampleDefinitionAs(Format, Object, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a simple query by example from a JSON or
XML representation provided as an object of an IO class.
- newRawQueryDSLPlan(TextWriteHandle)
- Method in interface com.marklogic.client.row.RowManager
-
Defines a plan from a Query DSL in a JavaScript
serialization.
- newRawSPARQLSelectPlan(TextWriteHandle)
- Method in interface com.marklogic.client.row.RowManager
-
Defines a plan from a SPARQL SELECT query.
- newRawSQLPlan(TextWriteHandle)
- Method in interface com.marklogic.client.row.RowManager
-
Defines a plan from an SQL query.
- newRawStructuredQueryDefinition(StructureWriteHandle)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML
representation.
- newRawStructuredQueryDefinition(StructureWriteHandle, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML
representation.
- newRawStructuredQueryDefinitionAs(Format, Object)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML
representation provided as an object of an IO class.
- newRawStructuredQueryDefinitionAs(Format, Object, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Defines a structured query from a JSON or XML
representation provided as an object of an IO class.
- newResourceExtensionsManager()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing,
and deleting resource service extensions.
- newRowBatcher(ContentHandle<T>)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new RowBatcher instance to export all
of the rows from a view in batches.
- newRowManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager to retrieve rows from the
database.
- newRuleManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for building rules and
rules-matching applications.
- newServerConfigManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for configuring the REST
server for the database.
- newServerEval()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a ServerEvaluationCall for eval and
invoke of server-side xquery or javascript code.
- newSessionState()
- Method in interface com.marklogic.client.dataservices.IOEndpoint
-
Generates an identifier for an endpoint to use
when accessing a session cache on the server.
- newSPARQLQueryManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a manager for executing SPARQL queries
and retrieving results.
- newStringDefinition()
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a string and
the default query options.
- newStringDefinition(String)
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a string and
on named query options saved previously.
- newStructuredQueryBuilder()
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a structure
that identifies clauses and conjunctions and the default query
options.
- newStructuredQueryBuilder(String)
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition based on a structure
and on named query options saved previously.
- newSuggestDefinition()
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a suggestion definition based on a
single string for completion, using the default options node.
- newSuggestDefinition(String)
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a suggestion definition based on a query
options name.
- newSuggestDefinition(String, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a suggestion definition based on a
single string for completion, using the default options node.
- newTextDocumentManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents
containing unstructured text.
- newTransformExtensionsManager()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Creates a manager for listing, reading, writing,
and deleting transform extensions.
- newValuesDefinition(String)
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving values
based on a named constraint on an index and the default query
options.
- newValuesDefinition(String, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving values
based on a named constraint and on named query options saved
previously.
- newValuesListDefinition()
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving the
list of available named lexicon configurations from the default
query options.
- newValuesListDefinition(String)
- Method in interface com.marklogic.client.query.QueryManager
-
Creates a query definition for retrieving the
list of available named lexicon configurations from the named query
options.
- newWriteBatcher()
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Create a new WriteBatcher instance.
- newWriteSet()
- Method in interface com.marklogic.client.document.DocumentManager
-
- newXMLDocumentManager()
- Method in interface com.marklogic.client.DatabaseClient
-
Creates a document manager for documents
containing XML.
- next()
- Method in class com.marklogic.client.datamovement.PeekingIterator
-
- next()
- Method in interface com.marklogic.client.dataservices.OutputCaller.BulkOutputCaller
-
Provides synchronous access to output.
- next()
- Method in interface com.marklogic.client.eval.EvalResultIterator
-
- next() - Method
in interface com.marklogic.client.Page
-
Returns the next element in the internal
iterator, which is separate from any new iterator created by calls
to iterator().
- next()
- Method in interface com.marklogic.client.query.ExtractedResult
-
Returns the next element in the internal
iterator, which is separate from any new iterator created by calls
to iterator().
- nextContent(T)
- Method in interface com.marklogic.client.document.DocumentPage
-
Convenience method combines the functionality of
Page.next() and DocumentRecord.getContent().
- nilled(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Summary: Returns an xs:boolean indicating
whether the argument node is "nilled".
- NMTOKEN(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:NMTOKEN server data type.
- NO_CONTENT
- Static variable in interface com.marklogic.client.util.RequestLogger
-
Indicates that no content is copied to the log
(the default).
- nodeCollections(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns any collections for the node's document
in the database.
- nodeKind(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an xs:string representing the node's
kind: either "document", "element", "attribute", "text",
"namespace", "processing-instruction", "binary", or
"comment".
- nodeMetadata(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the metadata value of a given
node.
- nodeMetadataValue(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the metadata value of a node for a
particular key.
- nodeMetadataValue(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the metadata value of a node for a
particular key.
- nodeName(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an expanded-QName for node kinds that
can have names.
- NodeOperation - Enum in com.marklogic.client.datamovement
-
Different operations to traverse the tree
DESCENT tells the application to go down the tree SKIP tells the
application to skip current branch PROCESS tells the application to
process current branch
- nodePermissions(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the permissions to a node's
document.
- nodePermissions(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the permissions to a node's
document.
- nodePermissions(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the permissions to a node's
document.
- nodeUri(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns the document-uri property of the
parameter or its ancestor.
- nonNegativeInteger(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:nonNegativeInteger server data type.
- nonPositiveInteger(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:nonPositiveInteger server data type.
- NoResponseListener - Class in com.marklogic.client.datamovement
-
NoResponseListener is a default listener like
HostAvailabilityListener that is automatically registered with the
QueryBatcher and WriteBatcher instances.
- NoResponseListener(DataMovementManager)
- Constructor for class com.marklogic.client.datamovement.NoResponseListener
-
- normalize(ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns the vector passed in, normalized to a
length of 1.
- normalizedString(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:normalizedString server data type.
- normalizeSpace(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the specified string with normalized
whitespace, which strips off any leading or trailing whitespace and
replaces any other sequences of more than one whitespace characters
with a single space character (#x20).
- normalizeUnicode(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Return the argument normalized according to the
normalization criteria for a normalization form identified by the
value of normalizationForm.
- normalizeUnicode(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Return the argument normalized according to the
normalization criteria for a normalization form identified by the
value of normalizationForm.
- normalizeUnicode(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Return the argument normalized according to the
normalization criteria for a normalization form identified by the
value of normalizationForm.
- not(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the effective boolean value is
false, and false if the effective boolean value is true.
- not(ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns true if neither of the
specified boolean expressions return true.
- not(StructuredQueryDefinition)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- not(StructuredQueryDefinition)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a NOT query for a query
definition.
- not64(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
NOT a 64-bit integer value.
- notExistsJoin(PlanBuilder.ModifyPlan)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- notExistsJoin(PlanBuilder.ModifyPlan, PlanJoinKey...)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- notExistsJoin(PlanBuilder.ModifyPlan, PlanJoinKeySeq)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- notExistsJoin(PlanBuilder.ModifyPlan, PlanJoinKeySeq, boolean)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- notExistsJoin(PlanBuilder.ModifyPlan, PlanJoinKeySeq, ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method is a filtering join that filters
based on whether the join exists or not but doesn't add any
columns.
- notIn(StructuredQueryDefinition, StructuredQueryDefinition)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- notIn(StructuredQueryDefinition, StructuredQueryDefinition)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Defines a not-in query for the positive and
negative query definitions.
- notInQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching the first sub-query,
where those matches do not occur within 0 distance of the other
query.
- notQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query specifying the matches not
specified by its sub-query.
- NotQuery(StructuredQueryDefinition)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.NotQuery
-
- NQUADS
- Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- NTRIPLES
- Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- nullif(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a NULL value if the two specified values
are equal.
- number(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the value indicated by arg or, if arg is
not specified, the context item after atomization, converted to an
xs:double.
- numeric(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:numeric server data type.
- Page<T> - Interface in com.marklogic.client
-
A generic interface for pagination through large
sets of items of type <T>.
- param(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function creates a placeholder for a
literal value in an expression or as the offset or max for a
limit.
- param(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function creates a placeholder for a
literal value in an expression or as the offset or max for a
limit.
- parseDateTime(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseDateTime(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseDateTime(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseDateTime(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseDateTime(ServerExpression, String, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseDateTime(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseDateTime(ServerExpression, String, String, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseDateTime(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseFailedRequest(int, InputStream)
- Method in class com.marklogic.client.io.JSONErrorParser
-
- parseWkt(String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns a sequence of geospatial regions parsed
from Well-Known Text format.
- parseWkt(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns a sequence of geospatial regions parsed
from Well-Known Text format.
- parseYymmdd(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseYymmdd(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseYymmdd(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseYymmdd(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseYymmdd(ServerExpression, String, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseYymmdd(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseYymmdd(ServerExpression, String, String, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- parseYymmdd(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Parses a string containing date, time or
dateTime using the supplied picture argument and returns a dateTime
value.
- partOfSpeech(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the part of speech for a cts:token, if
any.
- patch(String, String, DocumentPatchHandle)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Modifies the content of a temporal JSON or XML
document in the temporal collection.
- patch(String, String, DocumentPatchHandle, Transaction)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Modifies the content of a temporal JSON or XML
document in the temporal collection.
- patch(String, String, String, String, DocumentPatchHandle)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Patches a temporal document by taking the
content from the sourceDocumentURI present in the
temporalDocumentURI collection with the patch handle and creates a
new version identified by the uri in the temporalCollection.
- patch(String, String, String, String, DocumentPatchHandle, Transaction)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Patches a temporal document by taking the
content from the sourceDocumentURI present in the
temporalDocumentURI collection with the patch handle and creates a
new version identified by the uri in the temporalCollection.
- patch(String, DocumentPatchHandle)
- Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a document
within an open database transaction on the server.
- patch(String, DocumentPatchHandle, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a document
within an open database transaction on the server.
- patch(DocumentDescriptor, DocumentPatchHandle)
- Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a
document.
- patch(DocumentDescriptor, DocumentPatchHandle, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a document
within an open database transaction on the server.
- patch(String, PatchBuilder)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
Builds a patch operation including a sequence of
inserts, replaces, replace-inserts and deletes.
- patch(PlanExprCol, PatchBuilder)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
Builds a patch operation including a sequence of
inserts, replaces, replace-inserts and deletes.
- patchAs(String, Object)
- Method in interface com.marklogic.client.document.DocumentManager
-
Modifies the metadata or content of a document
within an open database transaction on the server.
- patchBuilder(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Create a patch builder which can be used to
chain patch operations.
- patchBuilder(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Create a patch builder which can be used to
chain patch operations.
- patchBuilder(String, Map<String, String>)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Create a patch builder which can be used to
chain patch operations.
- patchBuilder(XsStringVal, Map<String, String>)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Create a patch builder which can be used to
chain patch operations.
- PatchBuilder - Interface in com.marklogic.client.type
-
Manually constructed by first adding the methods
to PlanBuilder in optic-defs.json (which is the wrong place) and
then moving them to this manually created interface, and then
removing the methods from optic-defs.json.
- path(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string whose value corresponds to the
path of the node.
- path(ServerExpression, boolean)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string whose value corresponds to the
path of the node.
- path(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a string whose value corresponds to the
path of the node.
- pathGeospatialQuery(String, CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(String, ServerExpression, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(String, ServerExpression, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- pathGeospatialQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching path expressions whose
content represents a point contained within the given geographic
box, circle, or polygon, or equal to the given point.
- pathIndex(String)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Identifies a path index to match with a
query.
- PathIndexProperty
- Annotation Type in com.marklogic.client.pojo.annotation
-
Use this annotation to specify that a Path Index
(required for range queries) is needed for this pojo
property.
- PathIndexProperty.ScalarType - Enum in
com.marklogic.client.pojo.annotation
-
- pathLanguage(DocumentPatchBuilder.PathLanguage)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies the language for this patch to
use
- pathRangeQuery(String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
- pathRangeQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
- pathRangeQuery(String, String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
- pathRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
- pathRangeQuery(String, String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
- pathRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents where the
content addressed by an XPath expression satisfies the specified
relationship (=, <, >, etc.) with respect to the input
criteria values.
- pathReference(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
- pathReference(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
- pathReference(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
- pathReference(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
- pathReference(String, String, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
- pathReference(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a reference to a path value lexicon, for
use as a parameter to cts:value-tuples.
- PathSplitter - Class in com.marklogic.client.datamovement
-
The PathSplitter utility class splits the Stream
of paths into a Stream of AbstractWriteHandles or
DocumentWriteOperations suitable for writing in batches.
- PathSplitter()
- Constructor for class com.marklogic.client.datamovement.PathSplitter
-
Create a new PathSplitter with set
splitterMap.
- pattern(PlanTriplePositionSeq, PlanTriplePositionSeq, PlanTriplePositionSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function builds the parameters for the
op:from-triples function.
- pattern(PlanTriplePositionSeq, PlanTriplePositionSeq, PlanTriplePositionSeq, PlanSystemColumnSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function builds the parameters for the
op:from-triples function.
- patternSeq(PlanTriplePattern...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a sequence from multiple pattern
values to pass as a parameter to an operation.
- PeekingIterator<T> - Class in com.marklogic.client.datamovement
-
- PeekingIterator(Iterator<T>)
- Constructor for class com.marklogic.client.datamovement.PeekingIterator
-
- percentile(ServerExpression, double)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns a sequence of percentile(s) given a
sequence of percentage(s).
- percentile(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns a sequence of percentile(s) given a
sequence of percentage(s).
- percentRank(ServerExpression, String)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set as a
percentage of the data set.
- percentRank(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set as a
percentage of the data set.
- percentRank(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set as a
percentage of the data set.
- percentRank(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set as a
percentage of the data set.
- period(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a period value, for use as a parameter
to cts:period-range-query or cts:period-compare-query.
- period(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Creates a period value, for use as a parameter
to cts:period-range-query or cts:period-compare-query.
- period(Calendar, Calendar)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- period(String, String)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
- periodCompareQuery(String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents that have
relevant pair of period values.
- periodCompareQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents that have
relevant pair of period values.
- periodCompareQuery(String, String, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents that have
relevant pair of period values.
- periodCompareQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching documents that have
relevant pair of period values.
- periodRangeQuery(String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a
period value with an operator.
- periodRangeQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a
period value with an operator.
- periodRangeQuery(String, String, CtsPeriodExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a
period value with an operator.
- periodRangeQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a
period value with an operator.
- periodRangeQuery(String, String, ServerExpression, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a
period value with an operator.
- periodRangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching axis by name with a
period value with an operator.
- periodSeq(CtsPeriodExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsPeriodExpr
items.
- Permission()
- Constructor for class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
- permission(String, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Convenience method for constructing a permission
that can then be used e.g.
- permission(String, Capability...)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Create a GraphPermissions builder object with
the specified role and capabilities.
- permission(String, Capability...)
- Method in interface com.marklogic.client.semantics.GraphPermissions
-
Add the specified role and capabilities to this
GraphPermissions object.
- permission(String, Capability...)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
For use with SPARQL update, where specified
permissions will apply to any records created by the update.
- pi()
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the value of pi.
- PlanAggregateCol - Interface in com.marklogic.client.type
-
An instance of a column populated by an
aggregate expression in a row pipeline.
- PlanAggregateColSeq - Interface in
com.marklogic.client.type
-
A sequence of columns populated by an aggregate
expressions in a row pipeline.
- PlanBuilder - Class in com.marklogic.client.expression
-
Builds the plan for a row pipeline to execute on
the server.
- PlanBuilder(CtsExpr, FnExpr, GeoExpr, JsonExpr, MapExpr, MathExpr, RdfExpr, SemExpr, SpellExpr, SqlExpr, VecExpr, XdmpExpr, XsExpr, RdtExpr)
- Constructor for class com.marklogic.client.expression.PlanBuilder
-
- PlanBuilder.AccessPlan - Interface in
com.marklogic.client.expression
-
Provides functions and operations in the access
phase of the plan for executing a row pipeline on the server.
- PlanBuilder.ExportablePlan - Interface in
com.marklogic.client.expression
-
Provides functions and operations in the
exportable phase of the plan for executing a row pipeline on the
server.
- PlanBuilder.ModifyPlan - Interface in
com.marklogic.client.expression
-
Provides functions and operations in the modify
phase of the plan for executing a row pipeline on the server.
- PlanBuilder.Plan - Interface in com.marklogic.client.expression
-
Provides functions and operations in the final
phase of the plan for executing a row pipeline on the server.
- PlanBuilder.PreparePlan - Interface in
com.marklogic.client.expression
-
Provides functions and operations in the prepare
phase of the plan for executing a row pipeline on the server.
- PlanBuilderBase - Interface in com.marklogic.client.expression
-
Defines base methods for PlanBuilder.
- PlanBuilderBase.AccessPlanBase -
Interface in com.marklogic.client.expression
-
Defines base methods for AccessPlan.
- PlanBuilderBase.ExportablePlanBase -
Interface in com.marklogic.client.expression
-
Defines base methods for ExportablePlan.
- PlanBuilderBase.ModifyPlanBase -
Interface in com.marklogic.client.expression
-
Defines base methods for ModifyPlan.
- PlanBuilderBase.PlanBase - Interface in
com.marklogic.client.expression
-
Defines base methods for Plan.
- PlanBuilderBase.PreparePlanBase -
Interface in com.marklogic.client.expression
-
Defines base methods for PreparePlan.
- PlanCase - Interface in com.marklogic.client.type
-
An instance of a when or else argument to a case
expression in a row pipeline.
- PlanCaseSeq - Interface in com.marklogic.client.type
-
A sequence of when arguments to a case
expression in a row pipeline.
- PlanColumn - Interface in com.marklogic.client.type
-
An instance of a column expression returned by a
col() call in a row pipeline.
- PlanColumnSeq - Interface in com.marklogic.client.type
-
A sequence of column expressions returned by
col() calls for a row pipeline.
- PlanCondition - Interface in com.marklogic.client.type
-
An instance of a conditional expression.
- PlanConditionSeq - Interface in com.marklogic.client.type
-
A sequence of conditional expressions.
- PlanDocColsIdentifier - Interface in
com.marklogic.client.type
-
- PlanDocColsIdentifierSeq - Interface in
com.marklogic.client.type
-
- PlanDocDescriptor - Interface in com.marklogic.client.type
-
- PlanDocDescriptorSeq - Interface in
com.marklogic.client.type
-
- PlanExprCol - Interface in com.marklogic.client.type
-
An instance of a column expression returned by
an as() or col() call in a row pipeline.
- PlanExprColSeq - Interface in com.marklogic.client.type
-
A sequence of column expressions returned by
as() or col() calls in a row pipeline.
- PlanFunction - Interface in com.marklogic.client.type
-
An instance of a function used for map() or
reduce() post-processing of a row pipeline on the server.
- PlanFunctionSeq - Interface in com.marklogic.client.type
-
A sequence of functions used for map() or
reduce() post-processing of a row pipeline on the server.
- PlanGroup - Interface in com.marklogic.client.type
-
An instance of a group returned by a group()
call in a row pipeline.
- PlanGroupConcatOption - Interface in
com.marklogic.client.type
-
An instance of a PlanValueOption or separator
string for a group concat aggregate expression in a row
pipeline.
- PlanGroupConcatOptionSeq - Interface in
com.marklogic.client.type
-
A sequence of PlanValueOption or separator
strings for a group concat aggregate expression in a row
pipeline.
- PlanGroupSeq - Interface in com.marklogic.client.type
-
A sequence of group expressions returned by
group() calls in a row pipeline.
- PlanJoinKey - Interface in com.marklogic.client.type
-
An instance of a join key equivalence expression
returned by an on() call in a row pipeline.
- PlanJoinKeySeq - Interface in com.marklogic.client.type
-
A sequence of join key equivalence expressions
returned by on() calls in a row pipeline.
- PlanJsonProperty - Interface in com.marklogic.client.type
-
An instance of a JSON property returned by a
prop() call or passed as an argument to a jsonObject() call in a
row pipeline.
- PlanJsonPropertySeq - Interface in
com.marklogic.client.type
-
A sequence of JSON properties returned by prop()
calls or passed as an argument to a jsonObject() call in a row
pipeline.
- PlanNamedGroup - Interface in com.marklogic.client.type
-
An instance of a group returned by a
namedGroup() call in a row pipeline.
- PlanNamedGroupSeq - Interface in com.marklogic.client.type
-
A sequence of group expressions returned by
namedGroup() calls in a row pipeline.
- PlanNamespaceBindings - Interface in
com.marklogic.client.type
-
- PlanNamespaceBindingsSeq - Interface in
com.marklogic.client.type
-
- PlanParamBindingSeqVal - Interface in
com.marklogic.client.type
-
A sequence of literal values to pass as
arguments to bind() calls to assign to placeholder parameters for a
row pipeline.
- PlanParamBindingVal - Interface in
com.marklogic.client.type
-
An instance of a literal value passed as an
argument to a bind() call to assign to a placeholder parameter for
a row pipeline.
- PlanParamExpr - Interface in com.marklogic.client.type
-
An instance of a placeholder parameter returned
by a call to the param() function that can represent a literal
value in expressions and can be passed on a bind() call to be
assigned a literal value when invoking a row pipeline.
- PlanParamSeqExpr - Interface in com.marklogic.client.type
-
A sequence of placeholder parameters returned by
calls to param() functions that can represent literal values in
expressions and can be passed on bind() calls to be assigned
literal values when invoking a row pipeline.
- PlanPrefixer - Interface in com.marklogic.client.type
-
An instance of a convenience that can prepend a
base URL when creating iteral semantic IRI values for use in triple
patterns for a row pipeline.
- PlanPrefixerSeq - Interface in com.marklogic.client.type
-
A sequence of conveniences that can prepend a
base URL when creating iteral semantic IRI values for use in triple
patterns for a row pipeline.
- PlanRowColTypes - Interface in com.marklogic.client.type
-
- PlanRowColTypesSeq - Interface in
com.marklogic.client.type
-
- PlanSampleByOptions - Interface in
com.marklogic.client.type
-
An option controlling the sampling of rows from
view, triple, or lexicon indexes for a row pipeline.
- PlanSchemaDef - Interface in com.marklogic.client.type
-
- PlanSchemaDefSeq - Interface in com.marklogic.client.type
-
- PlanSearchOptions - Interface in com.marklogic.client.type
-
An option controlling the scoring and weighting
of fromSearch() for a row pipeline.
- PlanSearchOptions.ScoreMethod - Enum in
com.marklogic.client.type
-
- PlanSortKey - Interface in com.marklogic.client.type
-
An instance of a column - potentially with a
sort direction specified by an asc() or desc() call - for an
orderBy() operation in a row pipeline.
- PlanSortKeySeq - Interface in com.marklogic.client.type
-
A sequence of columns - potentially with a sort
direction specified by an asc() or desc() call - for an orderBy()
operation in a row pipeline.
- PlanSparqlOptions - Interface in com.marklogic.client.type
-
An option controlling whether to check for
duplicate triples (which is more expensive) or to supply a base IRI
for triples IRIs.
- PlanSystemColumn - Interface in com.marklogic.client.type
-
An instance of a fragment id, graph id, or other
system column for a row pipeline.
- PlanSystemColumnSeq - Interface in
com.marklogic.client.type
-
A sequence of fragment id, graph id, or other
system columns for a row pipeline.
- PlanTransformDef - Interface in com.marklogic.client.type
-
- PlanTransformDefSeq - Interface in
com.marklogic.client.type
-
- PlanTripleOption - Enum in com.marklogic.client.type
-
An option controlling whether to check for
duplicate triples (which is more expensive) or to process all
triples when reading triples for a row pipeline.
- PlanTriplePattern - Interface in com.marklogic.client.type
-
An instance of a pattern for projecting rows
from triples in a row pipeline.
- PlanTriplePatternSeq - Interface in
com.marklogic.client.type
-
A sequence of patterns for projecting rows from
triples in a row pipeline.
- PlanTriplePosition - Interface in
com.marklogic.client.type
-
An instance of a literal value or column for a
position within a pattern for projecting rows from triples in a row
pipeline.
- PlanTriplePositionSeq - Interface in
com.marklogic.client.type
-
A sequence of literal values or columns for
positions within patterns for projecting rows from triples in a row
pipeline.
- PlanValueOption - Enum in com.marklogic.client.type
-
An option controlling whether to calculate over
all values including duplicates or over distinct values for an
aggregate expression in a row pipeline.
- PlanValueOptionSeq - Interface in
com.marklogic.client.type
-
A sequence of options controlling whether to
calculate over all values including duplicates or over distinct
values for aggregate expressions in a row pipeline.
- point(double, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a point value.
- point(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
- point(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a point value.
- point(double, double)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- point(double, double)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial point.
- PointImpl(double, double)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.PointImpl
-
- pointLatitude(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a point's latitude value.
- pointLongitude(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a point's longitude value.
- pointSeq(CtsPointExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsPointExpr
items.
- PojoPage<T> - Interface in com.marklogic.client.pojo
-
Enables pagination over objects retrieved from
the server and deserialized by PojoRepository read and search
methods.
- PojoQueryBuilder<T> - Interface in
com.marklogic.client.pojo
-
Specific to pojos yet similar to
StructuredQueryBuilder, this class generates structured
queries.
- PojoQueryBuilder.Operator - Enum in
com.marklogic.client.pojo
-
- PojoQueryDefinition - Interface in
com.marklogic.client.pojo
-
- PojoRepository<T,ID extends
java.io.Serializable> - Interface in com.marklogic.client.pojo
-
PojoRepository is the central class for the Pojo
Facade.
- polygon(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a geospatial polygon value.
- polygon(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
- polygon(StructuredQueryBuilder.Point...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
- polygon(StructuredQueryBuilder.Point...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies a geospatial region as an arbitrary
polygon.
- PolygonImpl(StructuredQueryBuilder.Point...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.PolygonImpl
-
- polygonSeq(CtsPolygonExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsPolygonExpr
items.
- position(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer value representing the
starting position of a string within the search string.
- position(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer value representing the
starting position of a string within the search string.
- position(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer value representing the
starting position of a string within the search string.
- position(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer value representing the
starting position of a string within the search string.
- positiveInteger(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:positiveInteger server data type.
- post(RequestParameters, AbstractWriteHandle, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies content by calling a POST service.
- post(RequestParameters, AbstractWriteHandle, Transaction, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies content by calling a POST service.
- post(RequestParameters, W[], R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies content by calling a POST service.
- post(RequestParameters, W[], Transaction, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies content by calling a POST service.
- post(RequestParameters, AbstractWriteHandle)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies multiple content by calling a POST
service.
- post(RequestParameters, AbstractWriteHandle, Transaction)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies multiple content by calling a POST
service.
- post(RequestParameters, W[])
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies multiple content by calling a POST
service.
- post(RequestParameters, W[], Transaction)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Applies multiple content by calling a POST
service.
- pow(ServerExpression, double)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns x^y.
- pow(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns x^y.
- predicateSeq(PlanTriplePosition...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a sequence from multiple predicate
values to pass as a parameter to an operation.
- PREFIX
- Static variable in class com.marklogic.client.DatabaseClientBuilder
-
- prefixer(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function factory returns a new function
that takes a name parameter and returns a sem:iri, prepending the
specified base URI onto the name.
- prefixer(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function factory returns a new function
that takes a name parameter and returns a sem:iri, prepending the
specified base URI onto the name.
- prefixFromQName(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:NCName representing the prefix of
arg.
- prepare(int)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method prepares the specified plan for
execution as an optional final step before execution.
- prepare(XsIntVal)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method prepares the specified plan for
execution as an optional final step before execution.
- process(ContentHandler)
- Method in class com.marklogic.client.io.InputSourceHandle
-
Reads the input source, sending SAX events to
the supplied content handler.
- processError(int, Throwable, IOEndpoint.CallContext)
- Method in interface com.marklogic.client.dataservices.ExecCaller.BulkExecCaller.ErrorListener
-
- processError(int, Throwable, IOEndpoint.CallContext, BufferableHandle[])
- Method in interface com.marklogic.client.dataservices.InputCaller.BulkInputCaller.ErrorListener
-
The signature for the lambda or other
implementation of the callback that specifies the disposition of a
failed call.
- processError(int, Throwable, IOEndpoint.CallContext, BufferableHandle[])
- Method in interface com.marklogic.client.dataservices.InputOutputCaller.BulkInputOutputCaller.ErrorListener
-
The signature for the lambda or other
implementation of the callback that specifies the disposition of a
failed call.
- processError(int, Throwable, IOEndpoint.CallContext)
- Method in interface com.marklogic.client.dataservices.OutputCaller.BulkOutputCaller.ErrorListener
-
- processEvent(QueryBatch)
- Method in class com.marklogic.client.datamovement.ApplyTransformListener
-
The standard BatchListener action called by
QueryBatcher.
- processEvent(T)
- Method in interface com.marklogic.client.datamovement.BatchListener
-
The method called by QueryBatcher or
WriteBatcher to run your custom code on this batch.
- processEvent(QueryBatch)
- Method in class com.marklogic.client.datamovement.DeleteListener
-
The standard BatchListener action called by
QueryBatcher.
- processEvent(QueryBatch)
- Method in class com.marklogic.client.datamovement.ExportListener
-
This is the method QueryBatcher calls for
ExportListener to do its thing.
- processEvent(QueryBatch)
- Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
- processEvent(QueryBatch)
- Method in class com.marklogic.client.datamovement.ExtractRowsViaTemplateListener
-
This is the method QueryBatcher calls for
ExtractRowsViaTemplateListener to do its thing.
- processEvent(QueryBatch)
- Method in class com.marklogic.client.datamovement.ProgressListener
-
Batches arrive in random order, so a
ProgressUpdate is created and sent to each Consumer only if the
value of "getJobResultsSoFar" on the QueryBatch exceeds the number
of results seen so far.
- processEvent(QueryBatcher)
- Method in interface com.marklogic.client.datamovement.QueryBatcherListener
-
The method called by QueryBatcher to run your
custom code at the QueryBatcher level.
- processEvent(QueryBatch)
- Method in interface com.marklogic.client.datamovement.QueryBatchListener
-
The method called by QueryBatcher or
WriteBatcher to run your custom code on this batch.
- processEvent(QueryBatch)
- Method in class com.marklogic.client.datamovement.UrisToWriterListener
-
- processEvent(WriteBatch)
- Method in interface com.marklogic.client.datamovement.WriteBatchListener
-
The method called by WriteBatcher to run your
custom code on this batch.
- processFailure(T, Throwable)
- Method in interface com.marklogic.client.datamovement.BatchFailureListener
-
The method called when a failure occurs.
- processFailure(T)
- Method in interface com.marklogic.client.datamovement.FailureListener
-
- processFailure(WriteBatch, Throwable)
- Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
This implements the WriteFailureListener
interface
- processFailure(QueryBatchException)
- Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
This implements the QueryFailureListener
interface
- processFailure(QueryBatchException)
- Method in interface com.marklogic.client.datamovement.QueryFailureListener
-
- processFailure(RowBatchFailureListener.RowBatchFailureEvent, Throwable)
- Method in interface com.marklogic.client.datamovement.RowBatchFailureListener
-
- processFailure(WriteBatch, Throwable)
- Method in interface com.marklogic.client.datamovement.WriteFailureListener
-
- ProgressListener - Class in com.marklogic.client.datamovement
-
Reports on progress as batches are processed by
sending an instance of the nested ProgressUpdate interface to
instances of java.util.function.Consumer.
- ProgressListener()
- Constructor for class com.marklogic.client.datamovement.ProgressListener
-
- ProgressListener(Consumer<ProgressListener.ProgressUpdate>...)
- Constructor for class com.marklogic.client.datamovement.ProgressListener
-
Use this constructor for when the total number
of results isn't known ahead of time.
- ProgressListener(long, Consumer<ProgressListener.ProgressUpdate>...)
- Constructor for class com.marklogic.client.datamovement.ProgressListener
-
Use this constructor for when the total number
of results is known ahead of time.
- ProgressListener.ProgressUpdate -
Interface in com.marklogic.client.datamovement
-
Captures data of interest for a progress
update.
- ProgressListener.SimpleProgressUpdate -
Class in com.marklogic.client.datamovement
-
Simple implementation of ProgressUpdate; only
real thing of interest in here is how it generates the progress as
a string for display purposes.
- prop(String, ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies the key expression and
value content for a JSON property of a JSON object constructed by
the op:json-object function.
- prop(ServerExpression, ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies the key expression and
value content for a JSON property of a JSON object constructed by
the op:json-object function.
- properties(StructuredQueryDefinition)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Associates a query with the properties of
documents (as opposed to the content of documents).
- propertiesConstraint(String, StructuredQueryDefinition)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Associates a query with the properties of
documents (as opposed to the content of documents) with the
specified constraint.
- PropertiesConstraintQuery(String, StructuredQueryDefinition)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.PropertiesConstraintQuery
-
- propertiesFragmentQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query that matches all documents where
query matches document-properties.
- PropertiesQuery(StructuredQueryDefinition)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.PropertiesQuery
-
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Calendar)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document
update, wipe or delete till the expiryTime provided
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Calendar, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document
update, wipe or delete till the expiryTime provided and saves the
serialized copy of the current version in the path given
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Duration)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document
update, wipe or delete for the specified duration.
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Duration, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document
update, wipe or delete till the expiryTime provided and saves the
serialized copy of the current version in the path given
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Duration, Transaction)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document
update, wipe or delete for the specified duration.
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Calendar, Transaction)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document
update, wipe or delete till the expiryTime provided
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Duration, String, Transaction)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document
update, wipe or delete till the expiryTime provided and saves the
serialized copy of the current version in the path given
- protect(String, String, TemporalDocumentManager.ProtectionLevel, Calendar, String, Transaction)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Protects the temporal document from document
update, wipe or delete till the expiryTime provided and saves the
serialized copy of the current version in the path given
- put(String, XsAnyAtomicTypeVal)
- Method in class com.marklogic.client.datamovement.TypedRow
-
- put(RequestParameters, AbstractWriteHandle, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Writes content by calling a PUT service.
- put(RequestParameters, AbstractWriteHandle, Transaction, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Writes content by calling a PUT service.
- put(RequestParameters, W[], R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Writes multiple content by calling a PUT
service.
- put(RequestParameters, W[], Transaction, R)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Writes multiple content by calling a PUT
service.
- put(QName, BigDecimal)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a BigDecimal
value.
- put(QName, BigInteger)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a BigInteger
value.
- put(QName, Boolean)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a boolean
value.
- put(QName, Byte)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a byte value.
- put(QName, byte[])
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a byte array
value.
- put(QName, Calendar)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a Calendar value,
which can express a date, a time, or a datetime.
- put(QName, Double)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a double
value.
- put(QName, Duration)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a Duration value,
which can also express a year-month or day-millisecond
duration.
- put(QName, Float)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a float value.
- put(QName, Integer)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to an int value.
- put(QName, Long)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a long value.
- put(QName, NodeList)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a NodeList value,
which can accommodate subelements or mixed content.
- put(QName, Short)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a short value.
- put(QName, String)
- Method in interface com.marklogic.client.io.DocumentMetadataHandle.DocumentProperties
-
Sets a document property to a string
value.
- put(String, String)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Adds a namespace binding between a prefix and a
URI.
- put(String, V)
- Method in interface com.marklogic.client.util.NameMap
-
Specifies the value of the string name.
- put(String, String)
- Method in class com.marklogic.client.util.RequestParameters
-
Set a parameter to a single value.
- put(String, String...)
- Method in class com.marklogic.client.util.RequestParameters
-
Sets a parameter to a list of values.
- put(String, List<String>)
- Method in class com.marklogic.client.util.RequestParameters
-
Sets the values of a parameter name, returning
the previous values if any.
- putAll(Map<? extends String, ? extends String>)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Adds all namespace bindings from a map.
- putAll(Map<? extends String, ? extends List<String>>)
- Method in class com.marklogic.client.util.RequestParameters
-
Adds existing parameter names and values.
- radians(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns numeric expression converted from
degrees to radians.
- rand(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Return a random number.
- random()
- Method in interface com.marklogic.client.expression.SemExpr
-
Returns a random double between 0 and 1.
- random()
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a random unsigned integer between 0 and
a number up to 64 bits long.
- random(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns a random unsigned integer between 0 and
a number up to 64 bits long.
- range(String, PojoQueryBuilder.Operator, Object...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Query a Path Range Index configured in the
database for a pojo property.
- range(String, String[], PojoQueryBuilder.Operator, Object...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Query a Path Range Index configured in the
database for a pojo property.
- range(StructuredQueryBuilder.RangeIndex, String, StructuredQueryBuilder.Operator, Object...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property,
field, or path whose value that has the correct datatyped
comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.Operator, Object...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property,
field, or path whose value that has the correct datatyped
comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.FragmentScope, StructuredQueryBuilder.Operator, Object...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property,
field, or path whose value that has the correct datatyped
comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String[], StructuredQueryBuilder.Operator, Object...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property,
field, or path whose value that has the correct datatyped
comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String[], double, StructuredQueryBuilder.Operator, Object...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property,
field, or path whose value that has the correct datatyped
comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, String[], StructuredQueryBuilder.Operator, Object...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property,
field, or path whose value that has the correct datatyped
comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, String[], double, StructuredQueryBuilder.Operator, Object...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property,
field, or path whose value that has the correct datatyped
comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.FragmentScope, String[], StructuredQueryBuilder.Operator, Object...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property,
field, or path whose value that has the correct datatyped
comparison with one of the criteria values.
- range(StructuredQueryBuilder.RangeIndex, String, String, StructuredQueryBuilder.FragmentScope, String[], double, StructuredQueryBuilder.Operator, Object...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property,
field, or path whose value that has the correct datatyped
comparison with one of the criteria values.
- RANGE
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- rangeConstraint(String, StructuredQueryBuilder.Operator, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the
constraint whose value that has the correct datatyped comparison
with one of the criteria values.
- RangeConstraintQuery(String, StructuredQueryBuilder.Operator, String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.RangeConstraintQuery
-
- rangeOptions(String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Converts the list of options used for a range
query to an array as a convenience.
- rangeQuery(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
- rangeQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
- rangeQuery(ServerExpression, String, String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
- rangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
- rangeQuery(ServerExpression, String, String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
- rangeQuery(ServerExpression, ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a cts:query matching specified nodes
with a range-index entry compared to a given value.
- rank(ServerExpression, String)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set.
- rank(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set.
- rank(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set.
- rank(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the rank of a value in a data set.
- RAW
- Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to "raw"
- RawCombinedQueryDefinition - Interface in
com.marklogic.client.query
-
A RawCombinedQueryDefinition provides access to
a combined query in a JSON or XML representation.
- RawCtsQueryDefinition - Interface in
com.marklogic.client.query
-
A RawCtsQueryDefinition allows you to create a
query with a serialized cts query in a JSON or XML
representation.
- RAWDOUBLE
- Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to "raw/double"
- RawPlan - Interface in com.marklogic.client.row
-
An abstraction for a serialization of a plan
such as an AST in JSON format, a Query DSL in JavaScript syntax, or
a SQL or SPARQL SELECT query.
- RawPlanDefinition - Interface in com.marklogic.client.row
-
A Raw Plan Definition provides access to a plan
in a JSON serialization of the exported AST (Abstract Syntax Tree)
for the plan.
- RawQueryByExampleDefinition - Interface
in com.marklogic.client.query
-
A RawQueryByExampleDefinition provides access to
a simple query by example in an JSON or XML representation.
- RawQueryDefinition - Interface in
com.marklogic.client.query
-
A RawQueryDefinition provides access to a query
in a JSON or XML representation.
- RawQueryDSLPlan - Interface in com.marklogic.client.row
-
A Raw Query DSL Plan provides access to a plan
expressed in JavaScript syntax.
- RawSPARQLSelectPlan - Interface in
com.marklogic.client.row
-
A Raw SPARQL Select Plan provides access to a
plan expressed as a SPARQL SELECT statement.
- RawSQLPlan - Interface in com.marklogic.client.row
-
A Raw SQL Plan provides access to a plan
expressed as an SQL SELECT statement.
- RawStructuredQueryDefinition - Interface
in com.marklogic.client.query
-
A RawStructuredQueryDefinition provides access
to a structured query in a JSON or XML representation.
- rdf
- Variable in class com.marklogic.client.expression.CtsQueryBuilder
-
Builds expressions with rdf server
functions.
- rdf
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with rdf server
functions.
- RdfExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the rdf
server library for a row pipeline and constructs client values with
rdf.* server types.
- RDFJSON
- Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- RdfLangStringSeqVal - Interface in
com.marklogic.client.type
-
An instance of an RDF language string
value.
- RdfLangStringVal - Interface in com.marklogic.client.type
-
A sequence of RDF language string values.
- RDFMimeTypes - Class in com.marklogic.client.semantics
-
- RDFMimeTypes()
- Constructor for class com.marklogic.client.semantics.RDFMimeTypes
-
- RDFS
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- RDFS_FULL
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- RDFS_PLUS
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- RDFS_PLUS_FULL
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- RDFTypes - Enum in com.marklogic.client.semantics
-
- RdfValue - Interface in com.marklogic.client.expression
-
RdfValue takes Java values and constructs atomic
values and sequences of atomic values with an rdf data type The
typed values can then be passed to expression functions for
execution on the server.
- RDFXML
- Static variable in class com.marklogic.client.semantics.RDFMimeTypes
-
- rdt
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with ordt server
functions.
- RdtExpr - Interface in com.marklogic.client.expression
-
The RdtExpr instance provides functions that
build expressions for redacting the values of a column.
- read(ExtensionLibraryDescriptor, Class<T>)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset as an
object of an IO class.
- read(String, T)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset into a
handle.
- read(ExtensionLibraryDescriptor, T)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset into a
handle.
- read(String, T, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary database document in the representation provided by the
handle To call read(), an application must authenticate as
rest-reader, rest-writer, or rest-admin.
- read(String, T, ServerTransform, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary database document as transformed on the server.
- read(DocumentDescriptor, T, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary database document in the representation provided by the
handle To call read(), an application must authenticate as
rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, T, ServerTransform, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary database document as transformed on the server.
- read(String, DocumentMetadataReadHandle, T, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the
content of a binary database document in the representations
provided by the handles To call read(), an application must
authenticate as rest-reader, rest-writer, or rest-admin.
- read(String, DocumentMetadataReadHandle, T, ServerTransform, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the
content of a binary database document as transformed on the
server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the
content of a binary database document in the representations
provided by the handles To call read(), an application must
authenticate as rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the
content of a binary database document as transformed on the
server.
- read(String, T, long, long, Transaction)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary document for an open database transaction in the
representation provided by the handle To call read(), an
application must authenticate as rest-reader, rest-writer, or
rest-admin.
- read(String, T, ServerTransform, long, long, Transaction)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary document for an open database transaction as transformed on
the server.
- read(DocumentDescriptor, T, long, long, Transaction)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary document for an open database transaction in the
representation provided by the handle To call read(), an
application must authenticate as rest-reader, rest-writer, or
rest-admin.
- read(DocumentDescriptor, T, ServerTransform, long, long, Transaction)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary document for an open database transaction as transformed on
the server.
- read(String, DocumentMetadataReadHandle, T, long, long, Transaction)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the
content of a binary document for an open database transaction in
the representations provided by the handles To call read(), an
application must authenticate as rest-reader, rest-writer, or
rest-admin.
- read(String, DocumentMetadataReadHandle, T, ServerTransform, long, long, Transaction)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the
content of a binary document for an open database transaction as
transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, long, long, Transaction)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the
content of a binary document for an open database transaction in
the representations provided by the handles To call read(), an
application must authenticate as rest-reader, rest-writer, or
rest-admin.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform, long, long, Transaction)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads metadata and a range of bytes from the
content of a binary document for an open database transaction as
transformed on the server.
- read(String, T)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in
the representation provided by the handle To call read(), an
application must authenticate as rest-reader, rest-writer, or
rest-admin.
- read(String, T, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database as
transformed on the server.
- read(DocumentDescriptor, T)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in
the representations provided by the handles To call read(), an
application must authenticate as rest-reader, rest-writer, or
rest-admin.
- read(DocumentDescriptor, T, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database as
transformed on the server.
- read(String, DocumentMetadataReadHandle, T)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the
database in the representations provided by the handles To call
read(), an application must authenticate as rest-reader,
rest-writer, or rest-admin.
- read(String, DocumentMetadataReadHandle, T, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the
database as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the
database in the representations provided by the handles To call
read(), an application must authenticate as rest-reader,
rest-writer, or rest-admin.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the
database as transformed on the server.
- read(String, T, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database
transaction in the representation provided by the handle To call
read(), an application must authenticate as rest-reader,
rest-writer, or rest-admin.
- read(String, T, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database
transaction as transformed on the server.
- read(DocumentDescriptor, T, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database
transaction in the representation provided by the handle To call
read(), an application must authenticate as rest-reader,
rest-writer, or rest-admin.
- read(DocumentDescriptor, T, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from an open database
transaction as transformed on the server.
- read(String, DocumentMetadataReadHandle, T, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an
open database transaction in the representations provided by the
handles To call read(), an application must authenticate as
rest-reader, rest-writer, or rest-admin.
- read(String, DocumentMetadataReadHandle, T, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an
open database transaction as transformed on the server.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an
open database transaction in the representations provided by the
handles To call read(), an application must authenticate as
rest-reader, rest-writer, or rest-admin.
- read(DocumentDescriptor, DocumentMetadataReadHandle, T, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from an
open database transaction as transformed on the server.
- read(String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents
matching the provided uris.
- read(long, String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents
matching the provided uris.
- read(ServerTransform, String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents
matching the provided uris.
- read(long, ServerTransform, String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents
matching the provided uris.
- read(Transaction, String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents
matching the provided uris.
- read(ServerTransform, Transaction, String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database a list of documents
matching the provided uris.
- read(ID)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Read one persisted pojo by id and unmarshall its
data into a new pojo instance.
- read(ID, Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, read one persisted
pojo by id and unmarshall its data into a new pojo instance.
- read(ID[])
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Read multiple persisted pojos by id and
unmarshall their data into new pojo instances.
- read(ID[], Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, read multiple
persisted pojos and unmarshall their data into new pojo
instances.
- read(String, T)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Read triples from the server.
- read(String, T, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Read triples from the server.
- readAll(long)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Read one page of persisted pojos of the type
managed by this PojoRepository and unmarshall their data into new
pojo instances.
- readAll(long, Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, read one page of
persisted pojos of the type managed by this PojoRepository and
unmarshall their data into new pojo instances.
- readAs(String, Class<T>)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Reads the contents of a library asset as an
object of an IO class.
- readAs(String, Class<T>, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary database document in the representation specified by the IO
class.
- readAs(String, DocumentMetadataReadHandle, Class<T>, long, long)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Reads a range of bytes from the content of a
binary database document in the representation specified by the IO
class.
- readAs(String, Class<T>)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in
the representation specified by the IO class.
- readAs(String, Class<T>, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document content from the database in
the representation specified by the IO class.
- readAs(String, DocumentMetadataReadHandle, Class<T>)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the
database in the representation specified by the IO class.
- readAs(String, DocumentMetadataReadHandle, Class<T>, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata and content from the
database in the representation specified by the IO class.
- readAs(String, Class<T>)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Read triples from the server as the specified
type.
- readAs(String, Class<T>, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Read triples from the server as the specified
type.
- readConfiguration()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Reads the values of the properties from the
server into this object.
- ReaderHandle - Class in com.marklogic.client.io
-
A Reader Handle represents a character content
as a reader for reading to or writing from the database.
- ReaderHandle()
- Constructor for class com.marklogic.client.io.ReaderHandle
-
Zero-argument constructor.
- ReaderHandle(Reader)
- Constructor for class com.marklogic.client.io.ReaderHandle
-
Initializes the handle with a character reader
for the content.
- readForestConfig()
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Update the ForestConfiguration with the latest
from the server.
- readJavascriptTransform(String, T)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in
Javascript.
- readJavascriptTransformAs(String, Class<T>)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in
Javascript in a textual representation provided as an object of an
IO class.
- readMetadata(String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database the metadata for a list
of documents matching the provided uris.
- readMetadata(Transaction, String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads from the database the metadata for a list
of documents matching the provided uris.
- readMetadata(String, T)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata from the database in
the representation provided by the handle To call readMetadata(),
an application must authenticate as rest-reader, rest-writer, or
rest-admin.
- readMetadata(String, T, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reads the document metadata from an open
database transaction in the representation provided by the handle
To call readMetadata(), an application must authenticate as
rest-reader, rest-writer, or rest-admin.
- readOptions(String, T)
- Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Fetch a query options configuration from the
REST Server by name.
- readOptionsAs(String, Format, Class<T>)
- Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Fetch a query options configuration from the
REST Server by name.
- readRule(String, T)
- Method in interface com.marklogic.client.alerting.RuleManager
-
Reads a rule from the server into the provided
handle.
- readRuleAs(String, Class<T>)
- Method in interface com.marklogic.client.alerting.RuleManager
-
Reads a rule from the server in an XML
representation provided as an object of an IO class.
- readServices(String, T)
- Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Reads the XQuery implementation of the services
for a resource.
- readServicesAs(String, Class<T>)
- Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Reads the XQuery implementation of the services
for a resource in a textual representation provided as an object of
an IO class.
- readStatus(T)
- Method in interface com.marklogic.client.Transaction
-
Reads the status for the transaction including
whether the transaction has timed out.
- readXQueryTransform(String, T)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in
XQuery.
- readXQueryTransformAs(String, Class<T>)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in
XQuery in a textual representation provided as an object of an IO
class.
- readXSLTransform(String, T)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in
XSLT.
- readXSLTransformAs(String, Class<T>)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Reads the source for a transform implemented in
XSLT in an XML representation provided as an object of an IO
class.
- receiveAs()
- Method in class com.marklogic.client.alerting.RuleDefinition
-
- receiveAs()
- Method in class com.marklogic.client.alerting.RuleDefinitionList
-
- receiveAs()
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- receiveAs()
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
- receiveAs()
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.BytesHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.DOMHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.FileHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.InputSourceHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.InputStreamHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.JAXBHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.QueryOptionsListHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.ReaderHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.SearchHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.SourceHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.StringHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.TuplesHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.ValuesHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.ValuesListHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- receiveAs()
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.alerting.RuleDefinition
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.alerting.RuleDefinitionList
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- receiveContent(byte[])
- Method in class com.marklogic.client.io.BytesHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.DOMHandle
-
- receiveContent(File)
- Method in class com.marklogic.client.io.FileHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.InputSourceHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.InputStreamHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.JacksonHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.JAXBHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.QueryOptionsListHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.ReaderHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.SearchHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.SourceHandle
-
- receiveContent(byte[])
- Method in class com.marklogic.client.io.StringHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.TuplesHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.ValuesHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.ValuesListHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- receiveContent(InputStream)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- redactDatetime(PlanColumn, Map<String, ?>)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column with date or datetime values
either by masking part of the existing value or by generating a
random value.
- redactEmail(PlanColumn)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column with email address string that
conforms to the pattern name@domain
.
- redactEmail(PlanColumn, Map<String, ?>)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column with email address string that
conforms to the pattern name@domain
.
- redactIpv4(PlanColumn)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column with IPv4 address string that
conforms to a pattern with four blocks of 1-3 decimal digits
separated by period (.) where the value of each block of digits is
less than or equal to 255 as in 123.201.098.112
and
123.45.678.0
.
- redactIpv4(PlanColumn, Map<String, ?>)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column with IPv4 address string that
conforms to a pattern with four blocks of 1-3 decimal digits
separated by period (.) where the value of each block of digits is
less than or equal to 255 as in 123.201.098.112
and
123.45.678.0
.
- redactNumber(PlanColumn)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column by generating a random number
within a configurable range either as a numeric data type or as a
formatted string.
- redactNumber(PlanColumn, Map<String, ?>)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column by generating a random number
within a configurable range either as a numeric data type or as a
formatted string.
- redactRegex(PlanColumn, Map<String, ?>)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a string column by applying a regular
expression.
- redactUsPhone(PlanColumn)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column with a 10-digit US phone number
string by generating random numbers or replacing numbers with a
masking character.
- redactUsPhone(PlanColumn, Map<String, ?>)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column with a 10-digit US phone number
string by generating random numbers or replacing numbers with a
masking character.
- redactUsSsn(PlanColumn)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column with a 9-digit US SSN (Social
Security Number) string by generating random numbers or replacing
numbers with a masking character.
- redactUsSsn(PlanColumn, Map<String, ?>)
- Method in interface com.marklogic.client.expression.RdtExpr
-
Redacts a column with a 9-digit US SSN (Social
Security Number) string by generating random numbers or replacing
numbers with a masking character.
- reduce(PlanFunction)
- Method in interface com.marklogic.client.expression.PlanBuilder.PreparePlan
-
This method applies a function or the builtin
reducer to each row returned by the plan to produce a single result
as with the reduce() method of JavaScript Array.
- reduce(PlanFunction, String)
- Method in interface com.marklogic.client.expression.PlanBuilder.PreparePlan
-
This method applies a function or the builtin
reducer to each row returned by the plan to produce a single result
as with the reduce() method of JavaScript Array.
- reduce(PlanFunction, XsAnyAtomicTypeVal)
- Method in interface com.marklogic.client.expression.PlanBuilder.PreparePlan
-
This method applies a function or the builtin
reducer to each row returned by the plan to produce a single result
as with the reduce() method of JavaScript Array.
- referenceSeq(CtsReferenceExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsReferenceExpr
items.
- regionApproximate(ServerExpression, double)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function returns a simplified approximation
of the region, using the Douglas-Peucker algorithm.
- regionApproximate(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function returns a simplified approximation
of the region, using the Douglas-Peucker algorithm.
- regionApproximate(ServerExpression, double, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function returns a simplified approximation
of the region, using the Douglas-Peucker algorithm.
- regionApproximate(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function returns a simplified approximation
of the region, using the Douglas-Peucker algorithm.
- regionClean(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function fixes various problems with the
region or raises an error if it is not repairable.
- regionClean(ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function fixes various problems with the
region or raises an error if it is not repairable.
- regionClean(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
This function fixes various problems with the
region or raises an error if it is not repairable.
- regionContains(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if one region contains the other
region.
- regionContains(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if one region contains the other
region.
- regionContains(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if one region contains the other
region.
- regionDe9im(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Calculates the Dimensionally Extended
nine-Intersection Matrix (DE-9IM) of two geospatial regions.
- regionDe9im(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Calculates the Dimensionally Extended
nine-Intersection Matrix (DE-9IM) of two geospatial regions.
- regionDe9im(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Calculates the Dimensionally Extended
nine-Intersection Matrix (DE-9IM) of two geospatial regions.
- RegionImpl()
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.RegionImpl
-
- regionIntersects(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the target region intersects
with a region.
- regionIntersects(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the target region intersects
with a region.
- regionIntersects(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the target region intersects
with a region.
- regionRelate(ServerExpression, String, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions based on a specified
relationship.
- regionRelate(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions based on a specified
relationship.
- regionRelate(ServerExpression, String, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions based on a specified
relationship.
- regionRelate(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions based on a specified
relationship.
- regionSeq(CtsRegionExpr...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Constructs a sequence of CtsRegionExpr
items.
- register(ContentHandleFactory)
- Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Associates a factory for content handles with
the classes for IO representations known to the factory.
- register(ContentHandleFactory, Class<?>...)
- Method in interface com.marklogic.client.DatabaseClientFactory.HandleFactoryRegistry
-
Associates a factory for content handles with
the specified classes for IO representations.
- registerDefaultHandles()
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Initializes a handle registry with the default
associations between the content handles provided by the API and
the supported IO representation classes.
- registerDefaultHandles()
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Initializes a handle registry with the default
associations between the content handles provided by the API and
the supported IO representation classes.
- release()
- Method in interface com.marklogic.client.DatabaseClient
-
Closes the database client and releases
associated resources.
- release()
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Calls release() on all host-specific
DatabaseClient instances (but not on the DatabaseClient instance
used to create this DataMovementManager instance).
- remove(ServerExpression, long)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a new sequence constructed from the
value of target with the item at the position specified by the
value of position removed.
- remove(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a new sequence constructed from the
value of target with the item at the position specified by the
value of position removed.
- remove()
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
Removes (deletes) any document with a URI
matching the value of the "uri" column in at least one row in the
pipeline.
- remove(PlanColumn)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
Removes (deletes) any document with a URI
matching the value of the given column in at least one row in the
pipeline.
- remove(PlanColumn, PlanColumn)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
Removes (deletes) any temporal document with a
URI matching the value of the given column in at least one row in
the pipeline.
- remove(String)
- Method in interface com.marklogic.client.type.PatchBuilder
-
This method deletes a document from the
database.
- remove(XsStringVal)
- Method in interface com.marklogic.client.type.PatchBuilder
-
This method deletes a document from the
database.
- remove(Object)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Removes the namespace binding for a
prefix.
- remove(String)
- Method in interface com.marklogic.client.util.NameMap
-
Removes the key-value pair from the map.
- remove(Object)
- Method in class com.marklogic.client.util.RequestParameters
-
Removes a parameter name, returning its values
if any.
- RemoveAcceptEncodingConfigurator - Class
in com.marklogic.client.extra.okhttpclient
-
Can be used with
DatabaseClientFactory.addConfigurator
to remove the
"Accept-Encoding=gzip" request header that the underlying OkHttp
library adds by default.
- RemoveAcceptEncodingConfigurator()
- Constructor for class
com.marklogic.client.extra.okhttpclient.RemoveAcceptEncodingConfigurator
-
- removeConfigurators()
- Static method in class com.marklogic.client.DatabaseClientFactory
-
Removes any instances of
ClientConfigurator
that were passed in via
addConfigurator
.
- removeDuplicateVertices(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Remove duplicate (adjacent) vertices.
- removeDuplicateVertices(ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Remove duplicate (adjacent) vertices.
- removeDuplicateVertices(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Remove duplicate (adjacent) vertices.
- repeat(ServerExpression, double)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that concatenates the first
argument as many times as specified by the second argument.
- repeat(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that concatenates the first
argument as many times as specified by the second argument.
- replace(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string constructed by replacing the
specified pattern on the input string with the specified
replacement string.
- replace(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string constructed by replacing the
specified pattern on the input string with the specified
replacement string.
- replace(ServerExpression, String, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string constructed by replacing the
specified pattern on the input string with the specified
replacement string.
- replace(ServerExpression, ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a string constructed by replacing the
specified pattern on the input string with the specified
replacement string.
- replace(String, ServerExpression)
- Method in interface com.marklogic.client.type.PatchBuilder
-
Replace a node with another node.
- replace(XsStringVal, ServerExpression)
- Method in interface com.marklogic.client.type.PatchBuilder
-
Replace a node with another node.
- replaceApply(String, DocumentMetadataPatchBuilder.Call)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a replacement operation by applying a
function to an existing JSON or XML fragment.
- replaceApply(String, DocumentMetadataPatchBuilder.Cardinality, DocumentMetadataPatchBuilder.Call)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a replacement operation by applying a
function to an existing JSON or XML fragment.
- replaceCollection(String, String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the specified collection.
- replaceFragment(String, Object)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON
or XML fragment.
- replaceFragment(String, DocumentMetadataPatchBuilder.Cardinality, Object)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON
or XML fragment.
- replaceGraphs(QuadsWriteHandle)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Remove all quads from all graphs then insert
quads from the handle to the graphs specified in the quads
data.
- replaceGraphs(QuadsWriteHandle, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Remove all quads from all graphs then insert
quads from the handle to the graphs specified in the quads
data.
- replaceGraphsAs(Object)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Remove all quads from all graphs then insert
quads from the quadsData to the graphs specified in the quads
data.
- replaceGraphsAs(Object, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Remove all quads from all graphs then insert
quads from the quadsData to the graphs specified in the quads
data.
- replaceInsertChild(String, String)
- Method in interface com.marklogic.client.type.PatchBuilder
-
Replace a child if it exist, or insert if it
does not exist.
- replaceInsertChild(XsStringVal, XsStringVal)
- Method in interface com.marklogic.client.type.PatchBuilder
-
Replace a child if it exist, or insert if it
does not exist.
- replaceInsertChild(String, String, ServerExpression)
- Method in interface com.marklogic.client.type.PatchBuilder
-
Replace a child if it exist, or insert if it
does not exist.
- replaceInsertChild(XsStringVal, XsStringVal, ServerExpression)
- Method in interface com.marklogic.client.type.PatchBuilder
-
Replace a child if it exist, or insert if it
does not exist.
- replaceInsertFragment(String, String, DocumentPatchBuilder.Position, Object)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON
or XML fragment or (if the existing fragment doesn't exist) to
insert relative to a different existing JSON or XML fragment.
- replaceInsertFragment(String, String, DocumentPatchBuilder.Position, DocumentMetadataPatchBuilder.Cardinality, Object)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a fragment to replace an existing JSON
or XML fragment or (if the existing fragment doesn't exist) to
insert relative to a different existing JSON or XML fragment.
- replaceMetadataValue(String, String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing metadata-value
- replaceMetadataValueApply(String, DocumentMetadataPatchBuilder.Call)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Specifies a replacement operation by applying a
function to the metadata-value.
- replacePermission(String, DocumentMetadataHandle.Capability...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing capabilities of a
role.
- replacePermission(String, String, DocumentMetadataHandle.Capability...)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces an existing role with a new role.
- replacePropertyApply(String, DocumentMetadataPatchBuilder.Call)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Specifies a replacement operation by applying a
function to a metadata property having a simple name.
- replacePropertyApply(QName, DocumentMetadataPatchBuilder.Call)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Specifies a replacement operation by applying a
function to a metadata property having a namespaced name.
- replacePropertyValue(String, Object)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing value of a metadata
property having a simple name.
- replacePropertyValue(QName, Object)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces the existing value of a metadata
property having a namespaced name.
- replacePropertyValue(String, String, Object)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces an existing metadata property with a
new property having a simple name.
- replacePropertyValue(QName, QName, Object)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Replaces an existing metadata property with a
new property having a namespaced name.
- replaceRegex(String, String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to modify an existing
string with a regular expression
- replaceRegex(String, String, String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to modify an existing
string with a regular expression
- replaceValue(String, Object)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a value to replace the existing value
of a JSON or XML node.
- replaceValue(String, DocumentMetadataPatchBuilder.Cardinality, Object)
- Method in interface com.marklogic.client.document.DocumentPatchBuilder
-
Specifies a value to replace the existing value
of a JSON or XML node.
- replaceValue(String, ServerExpression)
- Method in interface com.marklogic.client.type.PatchBuilder
-
Replace the value of a path with a new
value.
- replaceValue(XsStringVal, ServerExpression)
- Method in interface com.marklogic.client.type.PatchBuilder
-
Replace the value of a path with a new
value.
- Report()
- Constructor for class com.marklogic.client.io.SearchHandle.Report
-
- RequestConstants - Class in com.marklogic.client
-
The RequestConstants class provides constants
for the common namespace prefixes and URIs used in the Java API
(similar to the XML constants provided by the
javax.xml.XMLConstants class).
- RequestConstants()
- Constructor for class com.marklogic.client.RequestConstants
-
- RequestLogger - Interface in com.marklogic.client.util
-
Request Logger records the requests sent to the
server.
- RequestParameters - Class in com.marklogic.client.util
-
RequestParameters supports a map with a string
as the key and a list of strings as the value, which can represent
parameters of an operation including parameters transported over
HTTP.
- RequestParameters()
- Constructor for class com.marklogic.client.util.RequestParameters
-
Zero-argument constructor.
- ResendableContentHandle<C,R> -
Interface in com.marklogic.client.io.marker
-
A Resendable Content Handle provides an adapter
for a content representation that can be read multiple times for
purposes such as resending input when retrying after a failed
request.
- resendableHandleFor(C)
- Method in interface com.marklogic.client.io.marker.BufferableContentHandle
-
Provides a handle that can resend the
content.
- resendableHandleFor(C[])
- Method in interface com.marklogic.client.io.marker.BufferableContentHandle
-
Provides an array of handles that can resend an
array of content.
- resendableHandleFor(C)
- Method in interface com.marklogic.client.io.marker.ResendableContentHandle
-
- resendableHandleFor(C)
- Method in interface com.marklogic.client.io.marker.StreamingContentHandle
-
- resolveFunction(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Specifies a JavaScript or XQuery function
installed on the server for use in post-processing in a map() or
reduce() operation.
- resolveFunction(XsQNameVal, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Specifies a JavaScript or XQuery function
installed on the server for use in post-processing in a map() or
reduce() operation.
- resolveFunction(XsQNameVal, String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Specifies a JavaScript or XQuery function
installed on the server for use in post-processing in a map() or
reduce() operation.
- resolveQName(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:QName value (that is, an expanded
QName) by taking an xs:string that has the lexical form of an
xs:QName (a string in the form "prefix:local-name" or "local-name")
and resolving it using the in-scope namespaces for a given
element.
- resolveUri(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Resolves a relative URI against an absolute
URI.
- resolveUri(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Resolves a relative URI against an absolute
URI.
- resolveUri(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Resolves a relative URI against an absolute
URI.
- resolveUri(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Resolves a relative URI against an absolute
URI.
- ResourceExtensionsManager - Interface in
com.marklogic.client.admin
-
A Resource Extensions Manager supports writing,
reading, and deleting a Resource Services extension as well as
listing the installed Resource Services extensions.
- ResourceExtensionsManager.MethodParameters
- Class in com.marklogic.client.admin
-
Method Parameters declare the parameters
accepted by the Resource Services extension.
- ResourceManager - Class in com.marklogic.client.extensions
-
ResourceManager is the base class for a client
interface to resource services.
- ResourceManager()
- Constructor for class com.marklogic.client.extensions.ResourceManager
-
- ResourceNotFoundException - Exception in
com.marklogic.client
-
Exception thrown when the server responds with
HTTP status code 404.
- ResourceNotFoundException(String)
- Constructor for exception com.marklogic.client.ResourceNotFoundException
-
- ResourceNotFoundException(String, FailedRequest)
- Constructor for exception com.marklogic.client.ResourceNotFoundException
-
- ResourceNotResendableException -
Exception in com.marklogic.client
-
Exception thrown when the server responds with
HTTP status code 503 and a Retry-After header of 1 but the request
is a PUT or POST and the payload is streaming.
- ResourceNotResendableException(String)
- Constructor for exception com.marklogic.client.ResourceNotResendableException
-
- ResourceServices - Interface in com.marklogic.client.extensions
-
A ResourceServices object supports calling the
services for a resource.
- ResourceServices.ServiceResult -
Interface in com.marklogic.client.extensions
-
ServiceResult provides one content response from
a service.
- ResourceServices.ServiceResultIterator -
Interface in com.marklogic.client.extensions
-
ServiceResultIterator provides an iterator over
content responses from the server.
- RESTAPI_NS
- Static variable in class com.marklogic.client.RequestConstants
-
The namespace URI for vocabularies implemented
by the REST API.
- RESTAPI_PREFIX
- Static variable in class com.marklogic.client.RequestConstants
-
The conventional namespace prefix for
vocabularies implemented by the REST API.
- resultDoc(PlanBuilder.Plan, T)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan using a handle to get the set of rows as a single
JSON or XML structure.
- resultDoc(PlanBuilder.Plan, T, Transaction)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan using a handle to get the set of rows as a single
JSON or XML structure and reflecting documents written or deleted
by an uncommitted transaction.
- resultDocAs(PlanBuilder.Plan, Class<T>)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan in the representation specified by the IO
class.
- resultDocAs(PlanBuilder.Plan, Class<T>, Transaction)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan in the representation specified by the IO class and
reflecting documents written or deleted by an uncommitted
transaction.
- resultRows(PlanBuilder.Plan)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan using a map interface for the column values in each
row.
- resultRows(PlanBuilder.Plan, Transaction)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan using a map interface and reflecting documents
written or deleted by an uncommitted transaction.
- resultRows(PlanBuilder.Plan, T)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan using a JSON or XML handle for each row.
- resultRows(PlanBuilder.Plan, T, Transaction)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan using a JSON or XML handle for each row and
reflecting documents written or deleted by an uncommitted
transaction.
- resultRowsAs(PlanBuilder.Plan, Class<T>)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan using a JSON or XML handle for each row and
reflecting documents written or deleted by an uncommitted
transaction.
- resultRowsAs(PlanBuilder.Plan, Class<T>, Transaction)
- Method in interface com.marklogic.client.row.RowManager
-
Constructs and retrieves a set of database rows
based on a plan using a JSON or XML handle for each row and
reflecting documents written or deleted by an uncommitted
transaction.
- retry(QueryEvent)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Retry in the same thread to query a batch that
failed.
- retry(WriteBatch)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Retry in the same thread to send a batch that
failed.
- retryListener(QueryBatch, QueryBatchListener)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Retries processing the listener to the batch of
URIs, when the batch has been successfully retrieved from the
server but applying the listener on the batch failed.
- retryWithFailureListeners(QueryEvent)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Retry in the same thread to query a batch that
failed.
- retryWithFailureListeners(WriteBatch)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Retry in the same thread to send a batch that
failed.
- returnXPathConstant(Class<?>)
- Method in class com.marklogic.client.io.DOMHandle
-
- reverse(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Reverses the order of items in a sequence.
- right(ServerExpression, double)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that is the rightmost
characters of the target string.
- right(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that is the rightmost
characters of the target string.
- rollback()
- Method in interface com.marklogic.client.Transaction
-
Cancels the transaction, reverting the database
to its state prior to the writes and deletes made in the
transaction.
- rollup(PlanExprColSeq)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function specifies a list of grouping keys
for a group and returns that group and larger groups (including all
rows) formed by dropping columns from right to left.
- rollup(String...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Specifies the keys for a sequence of groups that
provide a rollup for a row set.
- romanize(ServerExpression)
- Method in interface com.marklogic.client.expression.SpellExpr
-
Returns the romanization of the string,
substituting basic Latin letters for the letters in the string,
according to their sound.
- root(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the root of the tree to which arg
belongs.
- round(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the number with no fractional part that
is closest to the argument.
- roundHalfToEven(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
The value returned is the nearest (that is,
numerically closest) numeric to arg that is a multiple of ten to
the power of minus precision.
- roundHalfToEven(ServerExpression, long)
- Method in interface com.marklogic.client.expression.FnExpr
-
The value returned is the nearest (that is,
numerically closest) numeric to arg that is a multiple of ten to
the power of minus precision.
- roundHalfToEven(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
The value returned is the nearest (that is,
numerically closest) numeric to arg that is a multiple of ten to
the power of minus precision.
- RowBatcher<T> - Interface in com.marklogic.client.datamovement
-
Coordinates threads to export all of the rows
from a view in batches.
- RowBatchFailureListener - Interface in
com.marklogic.client.datamovement
-
Provides a callback (typically as a lambda) to
process an exception when trying to retrieve a batch of rows for a
view.
- RowBatchFailureListener.BatchFailureDisposition
- Enum in com.marklogic.client.datamovement
-
Specifies how the RowBatcher should respond to
the failure to retrieve a batch of rows.
- RowBatchFailureListener.RowBatchFailureEvent
- Interface in com.marklogic.client.datamovement
-
An exception which occurred when attempting to
retrieve a batch of rows for a view.
- RowBatchSuccessListener<T> -
Interface in com.marklogic.client.datamovement
-
Provides a callback (typically as a lambda) to
process a batch of rows retrieved for a view.
- RowBatchSuccessListener.RowBatchResponseEvent<T>
- Interface in com.marklogic.client.datamovement
-
A batch of rows retrieved for a view.
- rowID(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Constructs a row identifier from the string form
of the temporary identifier assigned to a row during
processing.
- RowManager - Interface in com.marklogic.client.row
-
A Row Manager provides database operations on
rows projected from documents.
- RowManager.RowSetPart - Enum in com.marklogic.client.row
-
Distinguishes between the header and rows that
constitute a row set.
- RowManager.RowStructure - Enum in
com.marklogic.client.row
-
Distinguishes between rows in an object
structure or array structure.
- RowRecord - Interface in com.marklogic.client.row
-
A Row Record provides an extended, read-only map
interface to the column values in a row.
- RowRecord.ColumnKind - Enum in com.marklogic.client.row
-
Distinguishes an atomic value, an array or
object container, content such as a document or other node, and a
null value.
- RowSet<T> - Interface in com.marklogic.client.row
-
A Row Set represents a set of rows produced by a
plan and read from the database.
- rshift64(ServerExpression, long)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Right-shift a 64-bit integer value.
- rshift64(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Right-shift a 64-bit integer value.
- rtrim(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Return a string that removes trailing empty
spaces in the input string.
- RuleDefinition - Class in com.marklogic.client.alerting
-
A RuleDefinition represents a set of criteria
that describe a named condition.
- RuleDefinition(String, String)
- Constructor for class com.marklogic.client.alerting.RuleDefinition
-
Make a new rule definition
- RuleDefinition()
- Constructor for class com.marklogic.client.alerting.RuleDefinition
-
Make a new rule definition, no argument
constructor.
- RuleDefinition.RuleMetadata - Interface
in com.marklogic.client.alerting
-
A RuleMetadata represents optional
client-supplied metadata that is stored alongside a
RuleDefinition.
- RuleDefinitionList - Class in com.marklogic.client.alerting
-
Models a list of RuleDefinitions.
- RuleDefinitionList()
- Constructor for class com.marklogic.client.alerting.RuleDefinitionList
-
- RuleListReadHandle - Interface in
com.marklogic.client.io.marker
-
- RuleManager - Interface in com.marklogic.client.alerting
-
Manages CRUD of rules for the REST API alerting
capability, as well as match operations against installed
rules.
- RuleReadHandle - Interface in com.marklogic.client.io.marker
-
- ruleset(String)
- Static method in class com.marklogic.client.semantics.SPARQLRuleset
-
- rulesetStore(String)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:ruleset-store function returns a set of
triples derived by applying the ruleset to the triples in the
sem:store constructor provided in store ("the triples that can be
inferred from these rules").
- rulesetStore(ServerExpression)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:ruleset-store function returns a set of
triples derived by applying the ruleset to the triples in the
sem:store constructor provided in store ("the triples that can be
inferred from these rules").
- rulesetStore(String, SemStoreExpr...)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:ruleset-store function returns a set of
triples derived by applying the ruleset to the triples in the
sem:store constructor provided in store ("the triples that can be
inferred from these rules").
- rulesetStore(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:ruleset-store function returns a set of
triples derived by applying the ruleset to the triples in the
sem:store constructor provided in store ("the triples that can be
inferred from these rules").
- rulesetStore(String, ServerExpression, String)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:ruleset-store function returns a set of
triples derived by applying the ruleset to the triples in the
sem:store constructor provided in store ("the triples that can be
inferred from these rules").
- rulesetStore(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:ruleset-store function returns a set of
triples derived by applying the ruleset to the triples in the
sem:store constructor provided in store ("the triples that can be
inferred from these rules").
- rulesetStore(String...)
- Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store with additional triples
inferred based on rules.
- rulesetStore(XsStringSeqVal, SemStoreExpr...)
- Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store with additional triples
inferred based on rules and a base store providing triples as input
for the rules.
- rulesetStore(XsStringSeqVal, SemStoreSeqExpr, String...)
- Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store with additional triples
inferred based on rules and a base store providing triples as input
for the rules.
- RuleWriteHandle - Interface in com.marklogic.client.io.marker
-
- SAME_AS
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- sameTerm(ServerExpression, String)
- Method in interface com.marklogic.client.expression.SemExpr
-
Returns true if the arguments are the same RDF
term as defined by the RDF concepts specification.
- sameTerm(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SemExpr
-
Returns true if the arguments are the same RDF
term as defined by the RDF concepts specification.
- SAMLAuthContext(String)
- Constructor for class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Constructs a context for authorization using a
SAML assertions token.
- SAMLAuthContext(DatabaseClientFactory.SAMLAuthContext.AuthorizerCallback)
- Constructor for class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Constructs a context for authorization using an
authorizer callback.
- SAMLAuthContext(DatabaseClientFactory.SAMLAuthContext.ExpiringSAMLAuth, DatabaseClientFactory.SAMLAuthContext.RenewerCallback)
- Constructor for class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Constructs a context for authorization using a
SAML assertions token and a renewer callback.
- sample(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function randomly selects one non-null
value of the column from the rows in the group or row set.
- sample(PlanColumn, PlanExprCol)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function randomly selects one non-null
value of the column from the rows in the group or row set.
- sampleBy()
- Method in interface com.marklogic.client.expression.PlanBuilder.AccessPlan
-
This function samples rows from a view or from a
pattern match on the triple index.
- sampleBy(PlanSampleByOptions)
- Method in interface com.marklogic.client.expression.PlanBuilder.AccessPlan
-
This function samples rows from a view or from a
pattern match on the triple index.
- sampleByOptions()
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
- schemaCol(String, String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Unambiguously identifies a column with the
schema name, view name, and column name.
- schemaCol(XsStringVal, XsStringVal, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Unambiguously identifies a column with the
schema name, view name, and column name.
- SchemaDefExpr - Interface in com.marklogic.client.expression
-
Defines the schema for using with the
validateDoc
operator;
- schemaDefinition(String)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Build a schema definition for use with
validateDoc
.
- search(SearchQueryDefinition, long)
- Method in interface com.marklogic.client.document.DocumentManager
-
- search(SearchQueryDefinition, long, String)
- Method in interface com.marklogic.client.document.DocumentManager
-
- search(SearchQueryDefinition, long, long)
- Method in interface com.marklogic.client.document.DocumentManager
-
- search(SearchQueryDefinition, long, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
- search(SearchQueryDefinition, long, Transaction, String)
- Method in interface com.marklogic.client.document.DocumentManager
-
- search(SearchQueryDefinition, long, SearchReadHandle)
- Method in interface com.marklogic.client.document.DocumentManager
-
- search(SearchQueryDefinition, long, SearchReadHandle, String)
- Method in interface com.marklogic.client.document.DocumentManager
-
- search(SearchQueryDefinition, long, SearchReadHandle, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
- search(SearchQueryDefinition, long, SearchReadHandle, Transaction, String)
- Method in interface com.marklogic.client.document.DocumentManager
-
- search(long, String...)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Find all persisted pojos of the type managed by
this PojoRepository also in one of the specified collections and
unmarshall their data into new pojo instances.
- search(long, Transaction, String...)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, find all persisted
pojos of the type managed by this PojoRepository also in one of the
specified collections and unmarshall their data into new pojo
instances.
- search(PojoQueryDefinition, long)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, search persisted
pojos of the type managed by this PojoRepository for matches to
this query and unmarshall their data into new pojo instances.
- search(PojoQueryDefinition, long, Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, search persisted
pojos of the type managed by this PojoRepository for matches to
this query and unmarshall their data into new pojo instances.
- search(PojoQueryDefinition, long, SearchReadHandle)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
- search(PojoQueryDefinition, long, SearchReadHandle, Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Within an open transaction, search persisted
pojos of the type managed by this PojoRepository for matches to
this query and unmarshall their data into new pojo instances.
- search(SearchQueryDefinition, T)
- Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and,
potentially, previously saved query options.
- search(SearchQueryDefinition, T, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and,
potentially, previously saved query options.
- search(SearchQueryDefinition, T, long)
- Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and,
potentially, previously saved query options starting with the
specified page listing document results.
- search(SearchQueryDefinition, T, long, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and,
potentially, previously saved query options starting with the
specified page listing document results.
- search(SearchQueryDefinition, T, Transaction)
- Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and,
potentially, previously saved query options.
- search(SearchQueryDefinition, T, Transaction, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and,
potentially, previously saved query options.
- search(SearchQueryDefinition, T, long, Transaction)
- Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and,
potentially, previously saved query options starting with the
specified page listing document results.
- search(SearchQueryDefinition, T, long, Transaction, String)
- Method in interface com.marklogic.client.query.QueryManager
-
Searches documents based on query criteria and,
potentially, previously saved query options starting with the
specified page listing document results.
- SEARCH_API_NS
- Static variable in class com.marklogic.client.query.StructuredQueryBuilder
-
- SEARCH_NS
- Static variable in class com.marklogic.client.RequestConstants
-
The namespace URI for vocabularies implemented
by the Search API.
- SEARCH_PREFIX
- Static variable in class com.marklogic.client.RequestConstants
-
The conventional namespace prefix for
vocabularies implemented by the Search API.
- SearchHandle - Class in com.marklogic.client.io
-
A SearchHandle represents a set of search
results returned by the server.
- SearchHandle()
- Constructor for class com.marklogic.client.io.SearchHandle
-
- SearchHandle.Report - Class in com.marklogic.client.io
-
Represents a report message.
- SearchHandle.Warning - Class in com.marklogic.client.io
-
Represents a warning.
- SearchMetrics - Interface in com.marklogic.client.query
-
A SearchMetrics object represents the query
metrics returned by a search.
- searchOptions()
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
- SearchQueryDefinition - Interface in
com.marklogic.client.query
-
A SearchQueryDefinition represents the common
parts of all kinds of searches that can be performed.
- SearchReadHandle - Interface in com.marklogic.client.io.marker
-
A SearchReadHandle represents the results of a
search performed over the database.
- SearchResults - Interface in com.marklogic.client.query
-
The SearchResults represent the set of results
returned by a search.
- seconds(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:decimal value between 0 and
60.999..., both inclusive, representing the seconds and fractional
seconds in the localized value of arg.
- secondsFromDateTime(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:decimal value between 0 and
60.999..., both inclusive representing the seconds and fractional
seconds in the localized value of arg.
- secondsFromDuration(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:decimal representing the seconds
component in the canonical lexical representation of the value of
arg.
- secondsFromTime(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:decimal value between 0 and
60.999..., both inclusive, representing the seconds and fractional
seconds in the localized value of arg.
- select(PlanExprCol...)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This call projects the specified columns from
the current row set and / or applies a qualifier to the columns in
the row set.
- select(PlanExprColSeq)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This call projects the specified columns from
the current row set and / or applies a qualifier to the columns in
the row set.
- select(PlanExprColSeq, String)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This call projects the specified columns from
the current row set and / or applies a qualifier to the columns in
the row set.
- select(PlanExprColSeq, XsStringVal)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This call projects the specified columns from
the current row set and / or applies a qualifier to the columns in
the row set.
- sem
- Variable in class com.marklogic.client.expression.CtsQueryBuilder
-
Builds expressions with sem server
functions.
- sem
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with sem server
functions.
- SemExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the sem
server library for a row pipeline and constructs client values with
sem.* server types.
- SemIriSeqVal - Interface in com.marklogic.client.type
-
A sequence of semantic IRI values.
- SemIriVal - Interface in com.marklogic.client.type
-
An instance of a semantic IRI value.
- SemStoreExpr - Interface in com.marklogic.client.type
-
An instance of a semantic store
expression.
- SemStoreSeqExpr - Interface in com.marklogic.client.type
-
A sequence of semantic store expressions.
- SemValue - Interface in com.marklogic.client.expression
-
SemValue takes Java values and constructs atomic
values and sequences of atomic values with a semantic data type The
typed values can then be passed to expression functions for
execution on the server.
- sendContent()
- Method in class com.marklogic.client.alerting.RuleDefinition
-
- sendContent()
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- sendContent()
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
- sendContent()
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- sendContent()
- Method in class com.marklogic.client.io.BytesHandle
-
- sendContent()
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
- sendContent()
- Method in class com.marklogic.client.io.DOMHandle
-
- sendContent()
- Method in class com.marklogic.client.io.FileHandle
-
- sendContent()
- Method in class com.marklogic.client.io.InputSourceHandle
-
- sendContent(InputSource)
- Method in class com.marklogic.client.io.InputSourceHandle
-
- sendContent()
- Method in class com.marklogic.client.io.InputStreamHandle
-
- sendContent()
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
- sendContent(T)
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
- sendContent(JsonNode)
- Method in class com.marklogic.client.io.JacksonHandle
-
- sendContent()
- Method in class com.marklogic.client.io.JacksonHandle
-
- sendContent()
- Method in class com.marklogic.client.io.JacksonParserHandle
-
- sendContent(JsonParser)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
- sendContent()
- Method in class com.marklogic.client.io.JAXBHandle
-
- sendContent()
- Method in class com.marklogic.client.io.OutputStreamHandle
-
- sendContent()
- Method in class com.marklogic.client.io.ReaderHandle
-
- sendContent()
- Method in class com.marklogic.client.io.SourceHandle
-
- sendContent()
- Method in class com.marklogic.client.io.StringHandle
-
- sendContent()
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- sendContent()
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- seq(ServerExpression...)
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
Collects a sequence of server expressions as a
new server expression for evaluation on the server.
- sequenceAggregate(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This call constructs a sequence whose items are
the values of a column for each row in the group or row set.
- sequenceAggregate(PlanColumn, PlanExprCol)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This call constructs a sequence whose items are
the values of a column for each row in the group or row set.
- sequenceAggregate(String, String, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This call constructs a sequence whose items are
the values of a column for each row in the group or row set.
- sequenceAggregate(PlanColumn, PlanExprCol, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This call constructs a sequence whose items are
the values of a column for each row in the group or row set.
- serialize(JsonParser)
- Method in class com.marklogic.client.datamovement.JSONSplitter.Visitor
-
Serialize the target object or array in
JsonParser to Strings.
- serialize(XMLStreamReader)
- Method in class com.marklogic.client.datamovement.XMLSplitter.Visitor
-
Serialize the target elements in XMLStreamReader
to Strings.
- serialize()
- Method in interface com.marklogic.client.query.CtsQueryDefinition
-
Serialize the cts query it represents in
AST(Abstract Sytax Tree) format.
- serialize()
- Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Returns the structured query definition as a
serialized XML string.
- serialize(XMLStreamWriter)
- Method in class com.marklogic.client.query.StructuredQueryBuilder.AbstractStructuredQuery
-
- serialize()
- Method in class com.marklogic.client.query.StructuredQueryBuilder.AbstractStructuredQuery
-
- serialize()
- Method in interface com.marklogic.client.query.StructuredQueryBuilder.Point
-
- serialize()
- Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Returns the structured query definition as a
serialized XML string.
- serialize(XMLStreamWriter)
- Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Serializes the structured query definition to
the given XML stream writer.
- ServerConfigurationManager - Interface in
com.marklogic.client.admin
-
The ServerConfigurationManager reads and writes
the configurable properties of the server.
- ServerConfigurationManager.Policy - Enum
in com.marklogic.client.admin
-
Specifies the policy for use of a
capability.
- ServerConfigurationManager.UpdatePolicy -
Enum in com.marklogic.client.admin
-
Specifies the policy for updating documents in
the database.
- ServerEvaluationCall - Interface in
com.marklogic.client.eval
-
ServerEvaluationCall uses a fluent builder-style
API to collect the parameters for a server-side
xquery
or
javascript
eval or invoke (
modulePath
)
call.
- ServerExpression - Interface in com.marklogic.client.type
-
One or more server expressions.
- ServerTransform - Class in com.marklogic.client.document
-
ServerTransform specifies the invocation of a
transform on the server including both the name of the transform
and the parameters passed to the transform.
- ServerTransform(String)
- Constructor for class com.marklogic.client.document.ServerTransform
-
Specifies invocation of the named transform on
the server.
- SessionState - Interface in com.marklogic.client
-
Identifies a server state for sharing across
multiple calls to server endpoints.
- set(Document)
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Assigns an XML document structure as the
content.
- set(JsonElement)
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
Assigns a JSON tree as the content.
- set(Document)
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Assigns an XML document structure as the
content.
- set(byte[])
- Method in class com.marklogic.client.io.BytesHandle
-
Assigns a byte array as the content.
- set(Document)
- Method in class com.marklogic.client.io.DOMHandle
-
Assigns a DOM document as the content.
- set(File)
- Method in class com.marklogic.client.io.FileHandle
-
Assigns a file as the content.
- set(InputSource)
- Method in class com.marklogic.client.io.InputSourceHandle
-
Assigns an input source as the content.
- set(InputStream)
- Method in class com.marklogic.client.io.InputStreamHandle
-
Assigns an input stream as the content.
- set(T)
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Assigns your custom POJO as the content.
- set(JsonNode)
- Method in class com.marklogic.client.io.JacksonHandle
-
Assigns a JSON tree as the content.
- set(JsonParser)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
Available for the edge case that content from a
JsonParser must be written.
- set(C)
- Method in class com.marklogic.client.io.JAXBHandle
-
Assigns the root object of the JAXB structure
for the content.
- set(C)
- Method in interface com.marklogic.client.io.marker.ContentHandle
-
Assigns the content.
- set(OutputStreamSender)
- Method in class com.marklogic.client.io.OutputStreamHandle
-
Assigns an output stream sender providing the
callback that writes content to the database via an output
stream.
- set(Reader)
- Method in class com.marklogic.client.io.ReaderHandle
-
Assigns an character reader as the
content.
- set(Source)
- Method in class com.marklogic.client.io.SourceHandle
-
Assigns a transform source that produces the
content.
- set(String)
- Method in class com.marklogic.client.io.StringHandle
-
Assigns an string as the content.
- set(XMLEventReader)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Assigns the event reader for the content.
- set(XMLStreamReader)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Assigns the stream reader for the content.
- setAggregate(String...)
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the name of the aggregate function to be
applied as part of this values query.
- setAggregatePath(String)
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the aggregate path.
- setBasePath(String)
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Set a base path to use for constructing a
client
- setBaseUri(String)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
set the base IRI for the query
- setBatchFailureListeners(WriteFailureListener...)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Remove any existing WriteFailureListener
instances registered via onBatchFailure including the
HostAvailabilityListener registered by default and replace them
with the provided listeners.
- setBatchSuccessListeners(WriteBatchListener...)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Remove any existing WriteBatchListener instances
registered via onBatchSuccess and replace them with the provided
listeners.
- setBindings(SPARQLBindings)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the child SPARQLBindings instance.
- setBuilder(SAXBuilder)
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Specifies a JDOM structure builder for XML
content.
- setByteLength(long)
- Method in interface com.marklogic.client.document.ContentDescriptor
-
Specifies the length of the content in bytes or
the UNKNOWN_LENGTH constant if the length of the content is not
known.
- setByteLength(long)
- Method in class com.marklogic.client.io.BaseHandle
-
- setCapability(String)
- Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
sets the capability for this permission
- setCollections(DocumentMetadataHandle.DocumentCollections)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document
collections.
- setCollections(String...)
- Method in interface com.marklogic.client.query.QueryDefinition
-
Sets the list of collections to which the query
should be limited.
- setConnectionType(DatabaseClient.ConnectionType)
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specify whether the client connects directly
with a MarkLogic host or by means of a gateway such as a load
balancer.
- setConstrainingQueryDefinition(QueryDefinition)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the search query used to constrain the set
of documents included in the SPARQL query.
- setContentFormat(Format)
- Method in interface com.marklogic.client.document.DocumentManager
-
Sets the default format of the managed
documents
- setContentMax(long)
- Method in interface com.marklogic.client.util.RequestLogger
-
Controls how much content is copied to the log
(defaulting to NO_CONTENT).
- setCriteria(String)
- Method in interface com.marklogic.client.query.RawCtsQueryDefinition
-
Sets the query criteria as a query string.
- setCriteria(String)
- Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Sets the query criteria as a query string.
- setCriteria(String)
- Method in interface com.marklogic.client.query.StringQueryDefinition
-
Sets the query criteria as a query string.
- setCriteria(String)
- Method in class com.marklogic.client.query.StructuredQueryBuilder.AbstractStructuredQuery
-
- setCriteria(String)
- Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Sets the query criteria as a query string.
- setCursorPosition(Integer)
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets the cursor position to use in the suggest
call.
- setDatabase(String)
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the database for clients created with
a DatabaseClientFactory.Bean object.
- setDatatypeStyle(RowManager.RowSetPart)
- Method in interface com.marklogic.client.row.RowManager
-
Specifies whether to emit the data type of each
column in each row or only in the header in the response for
requests made with the row manager.
- setDefaultDocumentReadTransform(String)
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies the name of the default transform for
reading documents.
- setDefaultDocumentReadTransformAll(Boolean)
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the default transform for
reading documents applies to all users or only users with the
rest-reader role.
- setDefaultGraphUris(String...)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the URI of the graph or graphs to use as the
default graph.
- setDefaultMimetype(String)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Set the default mimetype for data sent by write*
or merge* methods and data serialized by the server in response to
calls to read* or things* methods.
- setDefaultNamespaceURI(String)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Specifies the namespace URI bound to the empty
prefix.
- setDefaultWriteSchema(Schema)
- Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the default schema for validating the
input source.
- setDescription(String)
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the description of the
extension.
- setDescription(String)
- Method in class com.marklogic.client.alerting.RuleDefinition
-
Sets the description of the rule.
- setDirection(ValuesDefinition.Direction)
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the direction of the results to use in this
values query.
- setDirectory(String)
- Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the directory that should prefix the
document uri.
- setDirectory(String)
- Method in interface com.marklogic.client.query.QueryDefinition
-
Sets the directory to which the query should be
limited.
- setDocumentRepair(XMLDocumentManager.DocumentRepair)
- Method in interface com.marklogic.client.document.XMLDocumentManager
-
Specifies whether poorly formed XML documents
written by the manager should be repaired on the server.
- setEnabled(boolean)
- Method in interface com.marklogic.client.util.RequestLogger
-
Suspend or resume logging.
- setEntryFilter(Predicate<ZipEntry>)
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Used to set entryFilter to splitter.
- setErrorHandler(ErrorHandler)
- Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the error handler for errors
discovered while parsing the input source.
- setErrorListener(ExecCaller.BulkExecCaller.ErrorListener)
- Method in interface com.marklogic.client.dataservices.ExecCaller.BulkExecCaller
-
- setErrorListener(InputCaller.BulkInputCaller.ErrorListener)
- Method in interface com.marklogic.client.dataservices.InputCaller.BulkInputCaller
-
Provides a callback that specifies the
disposition of a failed call.
- setErrorListener(InputOutputCaller.BulkInputOutputCaller.ErrorListener)
- Method in interface com.marklogic.client.dataservices.InputOutputCaller.BulkInputOutputCaller
-
Provides a callback specifies the disposition of
a failed call.
- setErrorListener(OutputCaller.BulkOutputCaller.ErrorListener)
- Method in interface com.marklogic.client.dataservices.OutputCaller.BulkOutputCaller
-
- setExtension(String)
- Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the extension that should suffix the
document uri.
- setFactory(DocumentBuilderFactory)
- Method in class com.marklogic.client.io.DOMHandle
-
Specifies the factory for building DOM
documents.
- setFactory(SAXParserFactory)
- Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the factory for parsing SAX
events.
- setFactory(XMLInputFactory)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Specifies the factory for parsing StAX
events.
- setFactory(XMLInputFactory)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Specifies the factory for parsing StAX
streams.
- setFailureListeners(RowBatchFailureListener...)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies the callback functions for errors when
more than one callback function is needed.
- setFormat(Format)
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Used to set document format to splitter.
- setFormat(Format)
- Method in interface com.marklogic.client.document.ContentDescriptor
-
Specifies the format of the content as binary,
JSON, text, or XML.
- setFormat(Format)
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Restricts the format to XML.
- setFormat(Format)
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
Restricts the format to JSON.
- setFormat(Format)
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Restricts the format to XML.
- setFormat(Format)
- Method in class com.marklogic.client.io.BaseHandle
-
- setFormat(Format)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Restricts the format used parsing and
serializing the metadata.
- setFormat(Format)
- Method in class com.marklogic.client.io.DOMHandle
-
Restricts the format to XML.
- setFormat(Format)
- Method in class com.marklogic.client.io.InputSourceHandle
-
Restricts the format to XML.
- setFormat(Format)
- Method in class com.marklogic.client.io.JAXBHandle
-
Restricts the format to XML.
- setFormat(Format)
- Method in class com.marklogic.client.io.QueryOptionsListHandle
-
Sets the format associated with this
handle.
- setFormat(Format)
- Method in class com.marklogic.client.io.SearchHandle
-
Sets the format associated with this
handle.
- setFormat(Format)
- Method in class com.marklogic.client.io.SourceHandle
-
Restricts the format to XML.
- setFormat(Format)
- Method in class com.marklogic.client.io.TuplesHandle
-
Sets the format associated with this
handle.
- setFormat(Format)
- Method in class com.marklogic.client.io.ValuesHandle
-
Sets the format associated with this
handle.
- setFormat(Format)
- Method in class com.marklogic.client.io.ValuesListHandle
-
Sets the format associated with this
handle.
- setFormat(Format)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Restricts the format to XML.
- setFormat(Format)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Restricts the format to XML.
- setFrequency(ValuesDefinition.Frequency)
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the frequency to be used in this values
query.
- setHandle(StructureWriteHandle)
- Method in interface com.marklogic.client.query.RawQueryDefinition
-
Specifies the handle for the JSON or XML
representation of the query.
- setHandle(JSONWriteHandle)
- Method in interface com.marklogic.client.row.RawPlanDefinition
-
Specifies the handle for the JSON representation
of the AST for the plan.
- setHandle(TextWriteHandle)
- Method in interface com.marklogic.client.row.RawQueryDSLPlan
-
Specifies the handle for the text of the
JavaScript representation of the Query DSL.
- setHandle(TextWriteHandle)
- Method in interface com.marklogic.client.row.RawSPARQLSelectPlan
-
Specifies the handle for the text of the SPARQL
query.
- setHandle(TextWriteHandle)
- Method in interface com.marklogic.client.row.RawSQLPlan
-
Specifies the handle for the text of the SQL
query.
- setHandleRegistry(DatabaseClientFactory.HandleFactoryRegistry)
- Method in class com.marklogic.client.io.SearchHandle
-
Makes the handle registry for this database
client available to this SearchHandle during processing of the
search response.
- setHost(String)
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the host for clients created from a
DatabaseClientFactory.Bean object.
- setId(String)
- Method in class com.marklogic.client.io.SearchHandle.Report
-
- setId(String)
- Method in class com.marklogic.client.io.SearchHandle.Warning
-
- setIncludeDefaultRulesets(Boolean)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set whether to include database-default
inference or not.
- setInputAfter(String)
- Method in interface com.marklogic.client.datamovement.Splitter.UriMaker
-
Set inputAfter of the UriMaker, which could be
base URI
- setLimit(Integer)
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets a limit for a suggest call.
- setMapper(ObjectMapper)
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Enables clients to specify their own
ObjectMapper instance, including databinding mappers for formats
other than JSON.
- setMapper(ObjectMapper)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
Enables clients to specify their own
ObjectMapper instance, including databinding mappers for formats
other than JSON.
- setMaxBatches(long)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Sets the limit for the maximum number of batches
that can be collected.
- setMaxBatches()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Caps the query at the current batch.
- setMessage(String)
- Method in class com.marklogic.client.io.SearchHandle.Report
-
- setMessage(String)
- Method in class com.marklogic.client.io.SearchHandle.Warning
-
- setMetadata(RuleDefinition.RuleMetadata)
- Method in class com.marklogic.client.alerting.RuleDefinition
-
Sets the metadata object for this rule.
- setMetadataCategories(Set<DocumentManager.Metadata>)
- Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the categories of metadata to read,
write, patch, or search.
- setMetadataCategories(DocumentManager.Metadata...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the categories of metadata to read,
write, patch, or search.
- setMetadataExtraction(BinaryDocumentManager.MetadataExtraction)
- Method in interface com.marklogic.client.document.BinaryDocumentManager
-
Specifies the metadata extraction policy for
binary documents.
- setMetadataValues(DocumentMetadataHandle.DocumentMetadataValues)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document
metadata-values.
- setMimetype(String)
- Method in interface com.marklogic.client.document.ContentDescriptor
-
Specifies the mimetype of the content such as
application/json, text/plain, or application/xml.
- setMimetype(String)
- Method in class com.marklogic.client.io.BaseHandle
-
- setName(String)
- Method in class com.marklogic.client.alerting.RuleDefinition
-
Sets the name of the rule.
- setName(String)
- Method in class com.marklogic.client.io.SearchHandle.Report
-
- setName(String)
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the name of the values constraint.
- setNamedGraphUris(String...)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the URI of a named graph or graphs to
include in the query or update operation.
- setNamespaceContext(NamespaceContext)
- Method in interface com.marklogic.client.util.NameMap
-
Specifies a namespace context that declares the
namespace bindings used to convert prefixed string names into
QNames.
- setNamespaces(IterableNamespaceContext)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Declares the namespaces available for the paths
of a patch against XML documents.
- setNamespaces(IterableNamespaceContext)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Specifies the namespace bindings used for the
query.
- setNamespaceURI(String, String)
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Specifies a binding between a prefix and a
namespace URI.
- setNonDocumentFormat(Format)
- Method in interface com.marklogic.client.document.DocumentManager
-
- setOptimize(Integer)
- Method in interface com.marklogic.client.row.RowManager
-
Set an optional optimization level.
- setOptimizeLevel(int)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set a number indicating how much time for the
query engine to spend analyzing a query.
- setOptionsName(String)
- Method in class com.marklogic.client.io.ValuesListHandle
-
Sets the name of the query options to be used
for this query.
- setOptionsName(String)
- Method in interface com.marklogic.client.query.SearchQueryDefinition
-
Sets the name of the query options to be used
for this query.
- setOptionsName(String)
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets the name of the query options to be used
for this query.
- setOptionsName(String)
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Set the name of the options node to use for this
values query.
- setOptionsName(String)
- Method in interface com.marklogic.client.query.ValuesListDefinition
-
Set the name of the options node to be used for
this query.
- setOutputFormat(OutputFormat)
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Specifies the dom4j output format for
serializing XML content.
- setOutputListener(Consumer<O>)
- Method in interface com.marklogic.client.dataservices.InputOutputCaller.BulkInputOutputCaller
-
Specifies the function to call on receiving
output from the endpoint.
- setOutputListener(Consumer<O>)
- Method in interface com.marklogic.client.dataservices.OutputCaller.BulkOutputCaller
-
Specifies the function to call on receiving
output from the endpoint.
- setOutputter(XMLOutputter)
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Specifies a JDOM serializer for XML
content.
- setPageLength(long)
- Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the maximum number of documents that
can appear in any page of the query results, overriding any maximum
specified in the query options.
- setPageLength(long)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Set the number of instances per page returned
when calling
readAll
or
search
.
- setPageLength(long)
- Method in interface com.marklogic.client.query.QueryManager
-
Specifies the maximum number of documents that
can appear in any page of the query results, overriding any maximum
specified in the query options.
- setPageLength(long)
- Method in interface com.marklogic.client.semantics.SPARQLQueryManager
-
Set a page length for all SPARQL "SELECT"
queries sent by this instance.
- setPath(String)
- Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor
-
Sets the path for this module descriptor.
- setPermissions(DocumentMetadataHandle.DocumentPermissions)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document
permissions.
- setPort(int)
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the port for clients created with a
DatabaseClientFactory.Bean object.
- setProperties(DocumentMetadataHandle.DocumentProperties)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally assigns a container with document
properties.
- setProvider(String)
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the name of the organization providing
the extension.
- setQuality(int)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder
-
Sets the search quality of the document.
- setQuality(int)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Specifies the quality of the document, which
affects search weighting.
- setQueryCriteria(SearchQueryDefinition)
- Method in class com.marklogic.client.io.SearchHandle
-
Sets the query definition used in the
search.
- setQueryCriteria(ValuesDefinition)
- Method in class com.marklogic.client.io.TuplesHandle
-
Specifies the tuples query definition used to
identify this set of tuples.
- setQueryCriteria(ValuesDefinition)
- Method in class com.marklogic.client.io.ValuesHandle
-
Sets the query definition used when retrieving
values.
- setQueryDefinition(ValueQueryDefinition)
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Set the query definition associated with this
values query.
- setQueryFailureListeners(QueryFailureListener...)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Remove any existing QueryFailureListener
instances registered via onBatchFailure including the
HostAvailabilityListener registered by default and replace them
with the provided listeners.
- setQueryJobCompletionListeners(QueryBatcherListener...)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Remove any existing QueryBatcherListener
instances registered via onJobCompletion and replace them with the
provided listeners.
- setQueryOptionValidation(Boolean)
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the server validates query
options before storing them.
- setQueryStrings(String...)
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets zero or more search strings to AND with the
suggestion call.
- setQueryValidation(Boolean)
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the server validates queries
before running them.
- setReader(SAXReader)
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Specifies a dom4j reader for XML content.
- setReadTransform(ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Specifies a transform for read requests that
don't specify a transform.
- setResendable(boolean)
- Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies whether the content can be resent to
the output stream if the request must be retried.
- setResolver(LSResourceResolver)
- Method in class com.marklogic.client.io.DOMHandle
-
Specifies the resolver for resolving references
while parsing the document.
- setResolver(EntityResolver)
- Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the resolver for resolving references
while parsing the input source.
- setResolver(XMLResolver)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Specifies the resolver for resolving references
while parsing the event reader source.
- setResolver(XMLResolver)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Specifies the resolver for resolving references
while parsing the event reader source.
- setResponseTransform(ServerTransform)
- Method in interface com.marklogic.client.query.SearchQueryDefinition
-
Specifies a transform that modifies responses to
this query on the server.
- setRoleName(String)
- Method in class com.marklogic.client.admin.ExtensionLibraryDescriptor.Permission
-
sets the role name for this permission
- setRowStructureStyle(RowManager.RowStructure)
- Method in interface com.marklogic.client.row.RowManager
-
Specifies whether to get each row as an object
(the default) or as an array in the response for requests made with
the row manager.
- setRulesets(SPARQLRuleset...)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the name of rulesets to include for
inferring triples.
- setScriptLanguage(ExtensionMetadata.ScriptLanguage)
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the script language for this resource
extension, either XQUERY (default) or JAVASCRIPT.
- setSearchView(QueryManager.QueryView)
- Method in interface com.marklogic.client.document.DocumentManager
-
Specifies the view types included in a
SearchReadHandle populated by calls to
search
- setSecurityContext(DatabaseClientFactory.SecurityContext)
- Method in class com.marklogic.client.DatabaseClientFactory.Bean
-
Specifies the security context for clients
created with a DatabaseClientFactory.Bean object
- setServerRequestLogging(Boolean)
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies whether the server logs requests to
the error log on the server.
- setServerTimestamp(long)
- Method in class com.marklogic.client.io.BaseHandle
-
- setSparql(String)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the SPARQL query or update statement
- setSparql(TextWriteHandle)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the SPARQL query or update statement
- setSplitFilename(String)
- Method in interface com.marklogic.client.datamovement.Splitter.UriMaker
-
Set splitFilename to the UriMaker
- setSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
- setSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
Specifies the host verifier for a client that
verifies hosts for additional security.
- setStringCriteria(String)
- Method in interface com.marklogic.client.query.SuggestDefinition
-
Sets one or more criteria for the suggestion
call.
- setSuccessListeners(RowBatchSuccessListener<T>...)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies the callback functions for
successfully retrieved rows when more than one callback function is
needed.
- setTitle(String)
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the title of the extension.
- setTraceLabel(String)
- Method in interface com.marklogic.client.row.RowManager
-
Set an optional label and enable the "optic"
trace event for the duration of each plan execution
- setTransformer(Transformer)
- Method in class com.marklogic.client.io.SourceHandle
-
Specifies a transformer for modifying the
content.
- setType(String)
- Method in class com.marklogic.client.io.SearchHandle.Report
-
- setUpdatePermissions(GraphPermissions)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
For use with
SPARQL update
, where specified permissions will
apply to any records created by the update.
- setUpdatePolicy(ServerConfigurationManager.UpdatePolicy)
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Specifies the policy for updating or deleting
documents in the database.
- setUri(String)
- Method in interface com.marklogic.client.document.DocumentDescriptor
-
Specifies the URI identifier for a database
document.
- setUriMaker(JacksonCSVSplitter.UriMaker)
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Set the UriMaker to the splitter
- setUriMaker(JSONSplitter.UriMaker)
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Set the UriMaker to the splitter
- setUriMaker(LineSplitter.UriMaker)
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Set the UriMaker to the splitter
- setUriMaker(UnarySplitter.UriMaker)
- Method in class com.marklogic.client.datamovement.UnarySplitter
-
Set the UriMaker to the splitter
- setUriMaker(XMLSplitter.UriMaker)
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Set the UriMaker to the splitter
- setUriMaker(ZipSplitter.UriMaker)
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Set the UriMaker to the splitter
- setUrisReadyListeners(QueryBatchListener...)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Remove any existing QueryBatchListener instances
registered via onUrisReady and replace them with the provided
listeners.
- setUriTransformer(Function<String, String>)
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Used to set uriTransformer to splitter.
- setUsingGraphUris(String...)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the URI of the graph or graphs to address as
part of a SPARQL update operation.
- setUsingNamedGraphUris(String...)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the URI of a named graph or graphs to
address as part of a SPARQL update operation.
- setVersion(String)
- Method in class com.marklogic.client.admin.ExtensionMetadata
-
Specifies the version identifier for the
extension implementation.
- setVersion(long)
- Method in interface com.marklogic.client.document.DocumentDescriptor
-
Specifies the document version.
- setView(QueryManager.QueryView)
- Method in interface com.marklogic.client.query.QueryManager
-
Specifies the type of view results produced by
queries.
- setView(String)
- Method in interface com.marklogic.client.query.ValuesDefinition
-
Sets the view for this values query.
- setVisitor(JSONSplitter.Visitor<T>)
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Set the visitor to select objects or arrays to
split in JSONSplitter.
- setVisitor(XMLSplitter.Visitor<T>)
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Set the visitor to select elements to split in
XMLSplitter.
- setWriteTransform(ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Specifies a transform for write requests that
don't specify a transform.
- setXPathProcessor(XPath)
- Method in class com.marklogic.client.io.DOMHandle
-
Specifies the processor used to evaluate XPath
expressions against the document.
- sha1(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA1 hash of the given
argument.
- sha1(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA1 hash of the given
argument.
- sha1(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA1 hash of the given
argument.
- sha256(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA256 hash of the given
argument.
- sha256(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA256 hash of the given
argument.
- sha256(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA256 hash of the given
argument.
- sha384(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA384 hash of the given
argument.
- sha384(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA384 hash of the given
argument.
- sha384(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA384 hash of the given
argument.
- sha512(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA512 hash of the given
argument.
- sha512(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA512 hash of the given
argument.
- sha512(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Calculates the SHA512 hash of the given
argument.
- shortestDistance(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the great circle distance (in units)
between a point and a region.
- shortestDistance(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the great circle distance (in units)
between a point and a region.
- shortestDistance(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns the great circle distance (in units)
between a point and a region.
- shortExpr(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:short server data type.
- shortSeq(short...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of short primitives and
constructs an xs:short sequence
- shortSeq(XsShortVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:short values and
constructs an xs:short sequence
- shortVal(short)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a short primitive and constructs an
xs:short value
- sign(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns the sign of number x.
- SimpleProgressUpdate(QueryBatch, long, long, double)
- Constructor for class com.marklogic.client.datamovement.ProgressListener.SimpleProgressUpdate
-
Constructs a simple implementation of the
ProgressUpdate interface
- sin(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the sine of x, in the range from -1 to
+1 (inclusive).
- sinh(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the hyperbolic sine of x.
- size()
- Method in class com.marklogic.client.alerting.RuleDefinitionList
-
gets the number of rules in the list.
- size() - Method
in interface com.marklogic.client.Page
-
The count of items in this page, which is always
less than getPageSize().
- size()
- Method in interface com.marklogic.client.query.ExtractedResult
-
The number of ExtractedItem objects in the
Iterator.
- size()
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Returns the number of namespace bindings.
- size()
- Method in class com.marklogic.client.util.RequestParameters
-
Returns the number of request parameters.
- SOME_VALUES_FROM
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- sortKeySeq(PlanSortKey...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a sequence from multiple key values
to pass as a parameter to an operation.
- soundex(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a four-character (SOUNDEX) code to
evaluate the similarity of two strings.
- SourceHandle - Class in com.marklogic.client.io
-
A Source Handle represents XML content as a
transform source for reading or transforms a source into a result
for writing.
- SourceHandle()
- Constructor for class com.marklogic.client.io.SourceHandle
-
Zero-argument constructor.
- SourceHandle(Source)
- Constructor for class com.marklogic.client.io.SourceHandle
-
Initializes the handle with a transform source
for the content.
- space(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns a string that is the given number of
spaces.
- SPARQL_CSV
- Static variable in class com.marklogic.client.semantics.SPARQLMimeTypes
-
- SPARQL_JSON
- Static variable in class com.marklogic.client.semantics.SPARQLMimeTypes
-
- SPARQL_XML
- Static variable in class com.marklogic.client.semantics.SPARQLMimeTypes
-
- SPARQLBinding - Interface in com.marklogic.client.semantics
-
Represents a binding name, value, and type or
language tag.
- SPARQLBindings - Interface in com.marklogic.client.semantics
-
Represents binding names and values to be sent
with a SPARQL Query.
- SPARQLMimeTypes - Class in com.marklogic.client.semantics
-
- SPARQLMimeTypes()
- Constructor for class com.marklogic.client.semantics.SPARQLMimeTypes
-
- sparqlOptions()
- Method in interface com.marklogic.client.expression.PlanBuilderBase
-
- SPARQLQueryDefinition - Interface in
com.marklogic.client.semantics
-
Represents a SPARQL query.
- SPARQLQueryManager - Interface in
com.marklogic.client.semantics
-
A manager for executing SPARQL queries in
MarkLogic Server and retrieving the results.
- SPARQLResultsReadHandle - Interface in
com.marklogic.client.io.marker
-
- SPARQLRuleset - Class in com.marklogic.client.semantics
-
- spell
- Variable in class com.marklogic.client.expression.CtsQueryBuilder
-
Builds expressions with spell server
functions.
- spell
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with spell server
functions.
- SpellExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the
spell server library for a row pipeline.
- split(InputStream)
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Takes the input stream and converts it into a
stream of JacksonHandle by setting the schema and wrapping the
JsonNode into JacksonHandle.
- split(Reader)
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Takes the input stream and converts it into a
stream of JacksonHandle by setting the schema and wrapping the
JsonNode into JacksonHandle.
- split(InputStream)
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Takes an InputStream of a JSON file and split it
into a steam of handles.
- split(JsonParser)
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Take an input of JsonParser created from the
JSON file and split it into a stream of handles to write to
database.
- split(InputStream)
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Takes the input stream and converts it into a
stream of StringHandle.
- split(InputStream, Charset)
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Takes the input stream and converts it into a
stream of StringHandle.
- split(Reader)
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Takes the Reader input and converts it into a
stream of StringHandle.
- split(InputStream)
- Method in interface com.marklogic.client.datamovement.Splitter
-
Converts the incoming input stream to a stream
of AbstractWriteHandle objects.
- split(InputStream)
- Method in class com.marklogic.client.datamovement.UnarySplitter
-
Takes a input stream of a file and convert the
entire file to a stream of InputStreamHandle
- split(InputStream)
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Takes an input stream of an XML file and split
it into a steam of handles.
- split(XMLStreamReader)
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Take an input of XMLStreamReader of the XML file
and split it into a stream of handles to write to database.
- split(InputStream)
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Takes a input stream of a ZIP file and convert
it to a stream of BytesHandle.
- split(ZipInputStream)
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Takes a ZipInputStream of a ZIP file and convert
it to a stream of BytesHandle.
- splitDocumentWriteOperations(Stream<Path>)
- Method in class com.marklogic.client.datamovement.PathSplitter
-
Take a stream of Paths and convert the content
into a stream of DocumentWriteOperation
- splitHandles(Stream<Path>)
- Method in class com.marklogic.client.datamovement.PathSplitter
-
Take a stream of Paths and convert the content
into a stream of AbstractWriteHandle
- Splitter<T extends AbstractWriteHandle>
- Interface in com.marklogic.client.datamovement
-
Splitter splits an input stream into a Java
stream of write handles.
- Splitter.UriMaker - Interface in com.marklogic.client.datamovement
-
UriMaker generates URI for each split
file.
- splitWriteOperations(InputStream)
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Takes the input stream and converts it into a
stream of DocumentWriteOperation by setting the schema and wrapping
the JsonNode into DocumentWriteOperation.
- splitWriteOperations(InputStream, String)
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Takes the input stream and the input name, then
converts the input into a stream of DocumentWriteOperation by
setting the schema and wrapping the JsonNode into
DocumentWriteOperation.
- splitWriteOperations(Reader)
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Takes the input Reader and converts it into a
stream of DocumentWriteOperation by setting the schema and wrapping
the JsonNode into DocumentWriteOperation.
- splitWriteOperations(Reader, String)
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Takes the input Reader and the input name, then
converts the input Reader into a stream of DocumentWriteOperation
by setting the schema and wrapping the JsonNode into
DocumentWriteOperation.
- splitWriteOperations(InputStream)
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Takes an InputStream of a JSON file and split it
into a steam of DocumentWriteOperation to write to database.
- splitWriteOperations(InputStream, String)
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Takes an InputStream of a JSON file and file
name and split it into a steam of DocumentWriteOperation to write
to database.
- splitWriteOperations(JsonParser, String)
- Method in class com.marklogic.client.datamovement.JSONSplitter
-
Take an input of JsonParser created from the
JSON file and split it into a stream of DocumentWriteOperations to
write to database.
- splitWriteOperations(InputStream)
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Takes the input stream and converts it into a
stream of DocumentWriteOperation.
- splitWriteOperations(InputStream, String)
- Method in class com.marklogic.client.datamovement.LineSplitter
-
Takes the input stream and input file name and
converts it into a stream of DocumentWriteOperation.
- splitWriteOperations(InputStream)
- Method in interface com.marklogic.client.datamovement.Splitter
-
Converts the incoming input stream to a stream
of DocumentWriteOperation objects.
- splitWriteOperations(InputStream, String)
- Method in interface com.marklogic.client.datamovement.Splitter
-
Converts the incoming input stream to a stream
of DocumentWriteOperation objects.
- splitWriteOperations(InputStream)
- Method in class com.marklogic.client.datamovement.UnarySplitter
-
Takes a input stream of a file and convert the
entire file to a stream of DocumentWriteOperation
- splitWriteOperations(InputStream, String)
- Method in class com.marklogic.client.datamovement.UnarySplitter
-
Takes a input stream and the name of a file,
then convert the entire file to a stream of
DocumentWriteOperation
- splitWriteOperations(InputStream)
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Takes an input stream of an XML file and split
it into a steam of DocumentWriteOperation.
- splitWriteOperations(InputStream, String)
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Takes an input stream of an XML file and input
file name, split it into a steam of DocumentWriteOperation.
- splitWriteOperations(XMLStreamReader, String)
- Method in class com.marklogic.client.datamovement.XMLSplitter
-
Take an input of XMLStreamReader of the XML file
and split it into a stream of DocumentWriteOperations to write to
database.
- splitWriteOperations(InputStream)
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Takes a input stream of a ZIP file and convert
it to a stream of DocumentWriteOperation.
- splitWriteOperations(InputStream, String)
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Takes a input stream and name of a ZIP file and
convert it to a stream of DocumentWriteOperation.
- splitWriteOperations(ZipInputStream)
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Takes a ZipInputStream of a ZIP file and convert
it to a stream of DocumentWriteOperation.
- splitWriteOperations(ZipInputStream, String)
- Method in class com.marklogic.client.datamovement.ZipSplitter
-
Takes a ZipInputStream and name of a ZIP file
and convert it to a stream of DocumentWriteOperation.
- sql
- Variable in class com.marklogic.client.expression.CtsQueryBuilder
-
Builds expressions with sql server
functions.
- sql
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with sql server
functions.
- sqlCondition(String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns a filter definition as
input for a WHERE operation.
- sqlCondition(XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function returns a filter definition as
input for a WHERE operation.
- SqlExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the sql
server library for a row pipeline.
- sqrt(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the square root of x.
- START
- Static variable in interface com.marklogic.client.query.QueryManager
-
The offset of the first result in the default
page.
- startArray(String)
- Method in class com.marklogic.client.datamovement.JSONSplitter.ArrayVisitor
-
Use the arrayDepth and containerKey to check if
the current array is the target to split.
- startArray(String)
- Method in class com.marklogic.client.datamovement.JSONSplitter.Visitor
-
This method inspects the state of the current
array and decides whether to split it or not.
- startElement(XMLSplitter.StartElementReader)
- Method in class com.marklogic.client.datamovement.XMLSplitter.BasicElementVisitor
-
Checks if the current element matches the
namespace URI and local name.
- startElement(XMLSplitter.StartElementReader)
- Method in class com.marklogic.client.datamovement.XMLSplitter.Visitor
-
Use the methods in StartElementReader to check
if the current element is the one to split.
- startJob(WriteBatcher)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Begins job tracking on the WriteBatcher.
- startJob(QueryBatcher)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Starts the QueryBatcher job.
- startJob(RowBatcher<?>)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Starts the RowBatcher job.
- startLogging(RequestLogger)
- Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Starts debugging client requests.
- startLogging(RequestLogger)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Starts debugging client requests.
- startLogging(RequestLogger)
- Method in interface com.marklogic.client.document.DocumentManager
-
Starts debugging client requests.
- startLogging(RequestLogger)
- Method in class com.marklogic.client.extensions.ResourceManager
-
Starts debugging client requests.
- startLogging(RequestLogger)
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Starts debugging client requests.
- startLogging(RequestLogger)
- Method in interface com.marklogic.client.query.QueryManager
-
Starts debugging client requests.
- startObject(String)
- Method in class com.marklogic.client.datamovement.JSONSplitter.ArrayVisitor
-
Use the arrayDepth and containerKey to check if
the current object is the target to split.
- startObject(String)
- Method in class com.marklogic.client.datamovement.JSONSplitter.Visitor
-
This method inspects the state of the current
object and decides whether to split it or not.
- startsWith(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter starts with
the string from the second parameter, otherwise returns
false.
- startsWith(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter starts with
the string from the second parameter, otherwise returns
false.
- startsWith(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter starts with
the string from the second parameter, otherwise returns
false.
- startsWith(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns true if the first parameter starts with
the string from the second parameter, otherwise returns
false.
- stddev(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the sample standard deviation of a
sequence of values.
- stddevP(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the standard deviation of a
population.
- stem(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- stem(ServerExpression, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- stem(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- stem(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- stem(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns the stem(s) for a word.
- step64(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Combines an initial hash with a subsequent
hash.
- stopJob(JobTicket)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Immediately cancel all queued tasks, prevent new
tasks from being added to the queue, and begin to free all
resources.
- stopJob(Batcher)
- Method in interface com.marklogic.client.datamovement.DataMovementManager
-
Immediately cancel all queued tasks, prevent new
tasks from being added to the queue, and begin to free all
resources.
- stopLogging()
- Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Stops debugging client requests.
- stopLogging()
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Stops debugging client requests.
- stopLogging()
- Method in interface com.marklogic.client.document.DocumentManager
-
Stops debugging client requests.
- stopLogging()
- Method in class com.marklogic.client.extensions.ResourceManager
-
Stops debugging client requests.
- stopLogging()
- Method in interface com.marklogic.client.extensions.ResourceServices
-
Stops debugging client requests.
- stopLogging()
- Method in interface com.marklogic.client.query.QueryManager
-
Stops debugging client requests.
- store()
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:store function defines a set of
criteria, that when evaluated, selects a set of triples to be
passed in to sem:sparql(), sem:sparql-update(), or
sem:sparql-values() as part of the options argument.
- store(String)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:store function defines a set of
criteria, that when evaluated, selects a set of triples to be
passed in to sem:sparql(), sem:sparql-update(), or
sem:sparql-values() as part of the options argument.
- store(ServerExpression)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:store function defines a set of
criteria, that when evaluated, selects a set of triples to be
passed in to sem:sparql(), sem:sparql-update(), or
sem:sparql-values() as part of the options argument.
- store(String, ServerExpression)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:store function defines a set of
criteria, that when evaluated, selects a set of triples to be
passed in to sem:sparql(), sem:sparql-update(), or
sem:sparql-values() as part of the options argument.
- store(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SemExpr
-
The sem:store function defines a set of
criteria, that when evaluated, selects a set of triples to be
passed in to sem:sparql(), sem:sparql-update(), or
sem:sparql-values() as part of the options argument.
- store(String...)
- Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store for accessing triples,
modifying the triple retrieval based on the options.
- store(XsStringSeqVal, CtsQueryExpr)
- Method in interface com.marklogic.client.expression.SemValue
-
Specifies a store for accessing triples,
modifying the triple retrieval based on the options with a
restriction to the triples contained in documents matching the
query.
- stores(SemStoreExpr...)
- Method in interface com.marklogic.client.expression.SemValue
-
Takes any number of triple store specifications
and constructs a store sequence
- storeSeq(SemStoreExpr...)
- Method in interface com.marklogic.client.expression.SemExpr
-
Constructs a sequence of SemStoreExpr
items.
- stream()
- Method in interface com.marklogic.client.row.RowSet
-
Streams each row in the set of rows.
- StreamingContentHandle<C,R> - Interface in
com.marklogic.client.io.marker
-
A Streaming Content Handle provides an adapter
for a streaming content representation to make it possible to
construct a bufferable content representation so the content can be
read multiple times for purposes such as resending input when
retrying after a failed request.
- strftime(ServerExpression, String)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Formats a dateTime value using POSIX
strftime.
- strftime(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Formats a dateTime value using POSIX
strftime.
- STRICT
- Static variable in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
The STRICT SSLHostnameVerifier applies strict
rules for checking hostnames during SSL authentication (similar to
org.apache.http.conn.ssl.StrictHostnameVerifier).
- string(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the value of arg represented as an
xs:string.
- string(ServerExpression)
- Method in interface com.marklogic.client.expression.XsExpr
-
Constructs or casts an expression to the
xs:string server data type.
- string(String)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes a String literal and constructs an
xs:string value
- StringHandle - Class in com.marklogic.client.io
-
A String Handle represents document content as a
string for reading or writing.
- StringHandle()
- Constructor for class com.marklogic.client.io.StringHandle
-
Zero-argument constructor.
- StringHandle(String)
- Constructor for class com.marklogic.client.io.StringHandle
-
Initializes the handle with a string for the
content.
- StringHandle(Reader)
- Constructor for class com.marklogic.client.io.StringHandle
-
Initializes the handle by constructing a string
from the content of a reader.
- stringJoin(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:string created by concatenating
the members of the parameter1 sequence using parameter2 as a
separator.
- stringJoin(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an xs:string created by concatenating
the members of the parameter1 sequence using parameter2 as a
separator.
- stringLength(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns an integer representing the length of
the specified string.
- StringQueryDefinition - Interface in
com.marklogic.client.query
-
A StringQueryDefinition represents the criteria
associated with a simple string query.
- stringSeq(String...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of String literals and
constructs an xs:string sequence
- stringSeq(XsStringVal...)
- Method in interface com.marklogic.client.expression.XsValue
-
Takes any number of xs:string values and
constructs an xs:string sequence
- stringToCodepoints(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the sequence of Unicode code points that
constitute an xs:string.
- strpos(ServerExpression, String)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an integer value representing the
starting position of a string within the search string.
- strpos(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an integer value representing the
starting position of a string within the search string.
- strpos(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an integer value representing the
starting position of a string within the search string.
- strpos(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an integer value representing the
starting position of a string within the search string.
- StructuredQueryBuilder - Class in
com.marklogic.client.query
-
StructuredQueryBuilder builds a query for
documents in the database.
- StructuredQueryBuilder()
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Zero-argument constructor.
- StructuredQueryBuilder(String)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Constructs a query builder for queries against
the options persisted with the specified name.
- StructuredQueryBuilder(IterableNamespaceContext)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Constructs a query builder for queries using the
specified namespace bindings.
- StructuredQueryBuilder(String, IterableNamespaceContext)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder
-
Constructs a query builder for queries against
the options persisted with the specified name using the specified
namespace bindings.
- StructuredQueryBuilder.AbstractStructuredQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.AndNotQuery -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.AndQuery - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.Attribute -
Interface in com.marklogic.client.query
-
An Attribute represents an attribute in database
documents.
- StructuredQueryBuilder.AttributeImpl -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.Axis - Interface
in com.marklogic.client.query
-
- StructuredQueryBuilder.Box - Interface in
com.marklogic.client.query
-
- StructuredQueryBuilder.BoxImpl - Class in
com.marklogic.client.query
-
- StructuredQueryBuilder.Circle - Interface
in com.marklogic.client.query
-
- StructuredQueryBuilder.CircleImpl - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.CollectionConstraintQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.CollectionQuery -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.ContainerIndex -
Interface in com.marklogic.client.query
-
A ContainerIndex can be used for container
queries.
- StructuredQueryBuilder.ContainerQuery -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.CoordinateSystem -
Class in com.marklogic.client.query
-
CoordinateSystem provides a list of all known
coordinate systems and it also provides a capability to add new
CoordinateSystems in the future
- StructuredQueryBuilder.CustomConstraintQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.DirectoryQuery -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.DocumentFragmentQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.DocumentQuery -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.Element -
Interface in com.marklogic.client.query
-
An Element represents an element in database
documents.
- StructuredQueryBuilder.ElementAttribute -
Interface in com.marklogic.client.query
-
An ElementAttribute represents an attribute on
an element in database documents.
- StructuredQueryBuilder.ElementAttributeImpl
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.ElementImpl -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.Field - Interface
in com.marklogic.client.query
-
A Field represents a field defined in the
database configuration.
- StructuredQueryBuilder.FieldImpl - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.FragmentScope -
Enum in com.marklogic.client.query
-
Whether a query should search the document or
its associated properties.
- StructuredQueryBuilder.GeoAttributePairImpl
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeoElementImpl -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeoElementPairImpl
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeoJSONPropertyImpl
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeoJSONPropertyPairImpl
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeospatialConstraintQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeospatialIndex -
Interface in com.marklogic.client.query
-
A GeospatialIndex can be used for geospatial
queries.
- StructuredQueryBuilder.GeospatialOperator
- Enum in com.marklogic.client.query
-
Geospatial operators to be used in geospatial
region index queries
- StructuredQueryBuilder.GeospatialPointQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeospatialRegionConstraintQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.GeospatialRegionIndex
- Interface in com.marklogic.client.query
-
A GeospatialRangeIndex can be used for
geospatial region index queries.
- StructuredQueryBuilder.GeospatialRegionQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.IndexImpl - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.JSONProperty -
Interface in com.marklogic.client.query
-
A JSONProperty represents a key in JSON database
documents.
- StructuredQueryBuilder.JSONPropertyImpl -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.LocksQuery - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.NearQuery - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.NotQuery - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.Operator - Enum in
com.marklogic.client.query
-
A comparison operator for use in range
queries.
- StructuredQueryBuilder.Ordering - Enum in
com.marklogic.client.query
-
Control over ordering for use in near
queries.
- StructuredQueryBuilder.OrQuery - Class in
com.marklogic.client.query
-
- StructuredQueryBuilder.PathIndex -
Interface in com.marklogic.client.query
-
A PathIndex represents an index defined with an
XPath in the database configuration.
- StructuredQueryBuilder.PathIndexImpl -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.Period - Interface
in com.marklogic.client.query
-
- StructuredQueryBuilder.Point - Interface
in com.marklogic.client.query
-
- StructuredQueryBuilder.PointImpl - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.Polygon -
Interface in com.marklogic.client.query
-
- StructuredQueryBuilder.PolygonImpl -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.PropertiesConstraintQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.PropertiesQuery -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.RangeConstraintQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.RangeIndex -
Interface in com.marklogic.client.query
-
A RangeIndex can be used for range
queries.
- StructuredQueryBuilder.RangeQuery - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.Region - Interface
in com.marklogic.client.query
-
A region matched by a geospatial query.
- StructuredQueryBuilder.RegionImpl - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.TemporalAxis -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.TemporalLsqtQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.TemporalOperator -
Enum in com.marklogic.client.query
-
- StructuredQueryBuilder.TemporalPeriod -
Class in com.marklogic.client.query
-
- StructuredQueryBuilder.TemporalPeriodCompareQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.TemporalPeriodRangeQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.TermQuery - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.TextIndex -
Interface in com.marklogic.client.query
-
A TextIndex can be used for word and value
queries.
- StructuredQueryBuilder.TimeQuery - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.ValueConstraintQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.ValueQuery - Class
in com.marklogic.client.query
-
- StructuredQueryBuilder.WordConstraintQuery
- Class in com.marklogic.client.query
-
- StructuredQueryBuilder.WordQuery - Class
in com.marklogic.client.query
-
- StructuredQueryDefinition - Interface in
com.marklogic.client.query
-
A StructuredQueryDefinition represents a
structured query.
- StructureReadHandle - Interface in
com.marklogic.client.io.marker
-
A Structure Read Handle can represent a data
structure read from the database.
- StructureWriteHandle - Interface in
com.marklogic.client.io.marker
-
A Structure Write Handle represents a query
serialized as a structured query, combined query, or query by
example.
- subarray(ServerExpression, double)
- Method in interface com.marklogic.client.expression.JsonExpr
-
Extract a subarray from an array, producing a
new array.
- subarray(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.JsonExpr
-
Extract a subarray from an array, producing a
new array.
- subarray(ServerExpression, double, double)
- Method in interface com.marklogic.client.expression.JsonExpr
-
Extract a subarray from an array, producing a
new array.
- subarray(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.JsonExpr
-
Extract a subarray from an array, producing a
new array.
- SUBCLASS_OF
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- subjectSeq(PlanTriplePosition...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Constructs a sequence from multiple subject
values to pass as a parameter to an operation.
- SUBPROPERTY_OF
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- subsequence(ServerExpression, double)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the contiguous sequence of items in the
value of sourceSeq beginning at the position indicated by the value
of startingLoc and continuing for the number of items indicated by
the value of length.
- subsequence(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the contiguous sequence of items in the
value of sourceSeq beginning at the position indicated by the value
of startingLoc and continuing for the number of items indicated by
the value of length.
- subsequence(ServerExpression, double, double)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the contiguous sequence of items in the
value of sourceSeq beginning at the position indicated by the value
of startingLoc and continuing for the number of items indicated by
the value of length.
- subsequence(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the contiguous sequence of items in the
value of sourceSeq beginning at the position indicated by the value
of startingLoc and continuing for the number of items indicated by
the value of length.
- substring(ServerExpression, double)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a substring starting from the
startingLoc and continuing for length characters.
- substring(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a substring starting from the
startingLoc and continuing for length characters.
- substring(ServerExpression, double, double)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a substring starting from the
startingLoc and continuing for length characters.
- substring(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a substring starting from the
startingLoc and continuing for length characters.
- substringAfter(String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to reduce an existing
string to a trailing substring.
- substringAfter(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of
the input characters that occur after the specified after
characters.
- substringAfter(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of
the input characters that occur after the specified after
characters.
- substringAfter(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of
the input characters that occur after the specified after
characters.
- substringAfter(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of
the input characters that occur after the specified after
characters.
- substringBefore(String)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to reduce an existing
string to a leading substring.
- substringBefore(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of
the input characters that occur before the specified before
characters.
- substringBefore(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of
the input characters that occur before the specified before
characters.
- substringBefore(ServerExpression, String, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of
the input characters that occur before the specified before
characters.
- substringBefore(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns the substring created by taking all of
the input characters that occur before the specified before
characters.
- subtract(Number)
- Method in interface com.marklogic.client.document.DocumentMetadataPatchBuilder.CallBuilder
-
Calls the built-in method to subtract from an
existing value.
- subtract(ServerExpression, ServerExpression)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function subtracts the right
numericExpression from the left numericExpression and returns the
value.
- subtract(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns the difference of two vectors.
- subvector(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns a subvector of the input vector,
starting at the specified index, with the specified length
(optional).
- subvector(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns a subvector of the input vector,
starting at the specified index, with the specified length
(optional).
- suggest(SuggestDefinition)
- Method in interface com.marklogic.client.query.QueryManager
-
Queries the REST server for suggested string
completions based on values in the SuggestionDefinition.
- SuggestDefinition - Interface in com.marklogic.client.query
-
Represents the criteria for a suggestion call,
in which the beginning of a term is supplied for possible suggested
endings.
- sum(ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a value obtained by adding together the
values in arg.
- sum(ServerExpression, String)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a value obtained by adding together the
values in arg.
- sum(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.FnExpr
-
Returns a value obtained by adding together the
values in arg.
- sum(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function adds the non-null values of the
column for the rows in the group or row set.
- sum(PlanColumn, PlanExprCol)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function adds the non-null values of the
column for the rows in the group or row set.
- sum(String, String, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function adds the non-null values of the
column for the rows in the group or row set.
- sum(PlanColumn, PlanExprCol, PlanValueOption)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function adds the non-null values of the
column for the rows in the group or row set.
- SYMMETRIC_PROPERTY
- Static variable in class com.marklogic.client.semantics.SPARQLRuleset
-
- validate(RawQueryByExampleDefinition, T)
- Method in interface com.marklogic.client.query.QueryManager
-
Checks a query by example for mistakes in
expressing the criteria.
- validateDoc(String, PlanSchemaDef)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
Validate the document based on a supplied
schema.
- validateDoc(PlanColumn, PlanSchemaDef)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
Validate the document based on a supplied
schema.
- validateWkt(ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Returns true if the string is valid Well-Known
Text for a supported region type.
- value(String, String...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching
specified values.
- value(String, Boolean)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching
specified value.
- value(String, Number...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching
specified values.
- value(String, String[], double, String...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching
specified values.
- value(String, String[], double, Boolean)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching
specified values.
- value(String, String[], double, Number...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties matching
specified values.
- value(StructuredQueryBuilder.TextIndex, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, or
field that has a value with the same string value as at least one
of the criteria values.
- value(StructuredQueryBuilder.TextIndex, Boolean)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a JSON property that has a value with
the same boolean value as at least one of the criteria
values.
- value(StructuredQueryBuilder.TextIndex, Number...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an JSON property that has a value with
the same numeric value as at least one of the criteria
values.
- value(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, or
field that has a value with the same string value as at least one
of the criteria values.
- value(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, Boolean)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a JSON property that has a value with
the same boolean value as at least one of the criteria
values.
- value(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, Number...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches a JSON property that has a value with
the same numeric value as at least one of the criteria
values.
- valueConstraint(String, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the
constraint when it has a value with the same string value as at
least one of the criteria values.
- valueConstraint(String, double, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the
constraint when it has a value with the same string value as at
least one of the criteria values.
- ValueConstraintQuery(String, String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.ValueConstraintQuery
-
- ValueConstraintQuery(String, Double, String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.ValueConstraintQuery
-
- valueOf(String)
- Static method in enum com.marklogic.client.admin.ExtensionMetadata.ScriptLanguage
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.admin.MethodType
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.admin.ServerConfigurationManager.Policy
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.admin.ServerConfigurationManager.UpdatePolicy
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.bitemporal.TemporalDocumentManager.ProtectionLevel
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.DatabaseClient.ConnectionType
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.datamovement.ApplyTransformListener.ApplyResult
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.datamovement.Forest.HostType
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.datamovement.JobTicket.JobType
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.datamovement.NodeOperation
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.datamovement.RowBatchFailureListener.BatchFailureDisposition
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.dataservices.IOEndpoint.BulkIOEndpointCaller.ErrorDisposition
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.document.BinaryDocumentManager.MetadataExtraction
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.document.DocumentManager.Metadata
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.document.DocumentMetadataPatchBuilder.Cardinality
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.document.DocumentPatchBuilder.PathLanguage
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.document.DocumentPatchBuilder.Position
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.document.DocumentWriteOperation.OperationType
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.document.XMLDocumentManager.DocumentRepair
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.eval.EvalResult.Type
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.io.DocumentMetadataHandle.Capability
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.io.Format
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum
com.marklogic.client.pojo.annotation.PathIndexProperty.ScalarType
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.pojo.PojoQueryBuilder.Operator
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.query.QueryManager.QueryView
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.FragmentScope
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.GeospatialOperator
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Operator
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Ordering
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.TemporalOperator
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.query.ValuesDefinition.Direction
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.query.ValuesDefinition.Frequency
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.row.RowManager.RowSetPart
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.row.RowManager.RowStructure
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.row.RowRecord.ColumnKind
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.semantics.Capability
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.semantics.RDFTypes
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.type.PlanSearchOptions.ScoreMethod
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.type.PlanTripleOption
-
Returns the enum constant of this type with the
specified name.
- valueOf(String)
- Static method in enum com.marklogic.client.type.PlanValueOption
-
Returns the enum constant of this type with the
specified name.
- ValueQueryDefinition - Interface in
com.marklogic.client.query
-
ValueQueryDefinitions can be used in value
queries.
- values()
- Static method in enum com.marklogic.client.admin.ExtensionMetadata.ScriptLanguage
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.admin.MethodType
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.admin.ServerConfigurationManager.Policy
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.admin.ServerConfigurationManager.UpdatePolicy
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.bitemporal.TemporalDocumentManager.ProtectionLevel
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.DatabaseClient.ConnectionType
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.datamovement.ApplyTransformListener.ApplyResult
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.datamovement.Forest.HostType
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.datamovement.JobTicket.JobType
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.datamovement.NodeOperation
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.datamovement.RowBatchFailureListener.BatchFailureDisposition
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.dataservices.IOEndpoint.BulkIOEndpointCaller.ErrorDisposition
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.document.BinaryDocumentManager.MetadataExtraction
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.document.DocumentManager.Metadata
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.document.DocumentMetadataPatchBuilder.Cardinality
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.document.DocumentPatchBuilder.PathLanguage
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.document.DocumentPatchBuilder.Position
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.document.DocumentWriteOperation.OperationType
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.document.XMLDocumentManager.DocumentRepair
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.eval.EvalResult.Type
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.io.DocumentMetadataHandle.Capability
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.io.Format
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum
com.marklogic.client.pojo.annotation.PathIndexProperty.ScalarType
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.pojo.PojoQueryBuilder.Operator
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.query.QueryManager.QueryView
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values(ValuesDefinition, T)
- Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query
criteria and, potentially, previously saved query options.
- values(ValuesDefinition, T, long)
- Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query
criteria and, potentially, previously saved query options.
- values(ValuesDefinition, T, Transaction)
- Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query
criteria and, potentially, previously saved query options.
- values(ValuesDefinition, T, long, Transaction)
- Method in interface com.marklogic.client.query.QueryManager
-
Retrieves values from indexes based on query
criteria and, potentially, previously saved query options.
- values()
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.FragmentScope
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.GeospatialOperator
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Operator
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.Ordering
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.query.StructuredQueryBuilder.TemporalOperator
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.query.ValuesDefinition.Direction
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.query.ValuesDefinition.Frequency
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.row.RowManager.RowSetPart
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.row.RowManager.RowStructure
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.row.RowRecord.ColumnKind
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.semantics.Capability
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.semantics.RDFTypes
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.type.PlanSearchOptions.ScoreMethod
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.type.PlanTripleOption
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Static method in enum com.marklogic.client.type.PlanValueOption
-
Returns an array containing the constants of
this enum type, in the order they are declared.
- values()
- Method in class com.marklogic.client.util.EditableNamespaceContext
-
Gets the list of URIs from the namespace
bindings.
- values()
- Method in class com.marklogic.client.util.RequestParameters
-
Returns a list of value lists.
- ValuesDefinition - Interface in com.marklogic.client.query
-
A ValuesDefinition represents a values query
used to retreive values from the server.
- ValuesDefinition.Direction - Enum in
com.marklogic.client.query
-
The possible directions.
- ValuesDefinition.Frequency - Enum in
com.marklogic.client.query
-
The kinds of frequencies.
- ValuesHandle - Class in com.marklogic.client.io
-
A ValuesHandle represents a list of values or of
tuples (combination of values for the same document) retrieved from
the indexes.
- ValuesHandle()
- Constructor for class com.marklogic.client.io.ValuesHandle
-
Zero-argument constructor.
- valuesList(ValuesListDefinition, T)
- Method in interface com.marklogic.client.query.QueryManager
-
Retrieves the list of available named lexicon
configurations from the values list definition and, potentially,
previously saved query options.
- valuesList(ValuesListDefinition, T, Transaction)
- Method in interface com.marklogic.client.query.QueryManager
-
Retrieves the list of available named lexicon
configurations from the values list definition and, potentially,
previously saved query options.
- ValuesListDefinition - Interface in
com.marklogic.client.query
-
A ValuesListDefinition is the base type for a
values or tuples list.
- ValuesListHandle - Class in com.marklogic.client.io
-
A ValuesListHandle represents a list of
available named lexicon configurations from saved query
options.
- ValuesListHandle()
- Constructor for class com.marklogic.client.io.ValuesListHandle
-
The constructor.
- ValuesListReadHandle - Interface in
com.marklogic.client.io.marker
-
A ValuesListReadHandle represents a list of sets
of values read from the database.
- ValuesListResults - Interface in com.marklogic.client.query
-
A ValuesListResults represents the results of a
values query.
- ValuesMetrics - Interface in com.marklogic.client.query
-
A SearchMetrics object represents the query
metrics returned by a search.
- ValuesReadHandle - Interface in com.marklogic.client.io.marker
-
A ValuesReadHandle represents a set of values
read from the database.
- ValuesResults - Interface in com.marklogic.client.query
-
ValuesResults represents one set of values from
a values query.
- variance(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the sample variance of a sequence of
values.
- varianceP(ServerExpression)
- Method in interface com.marklogic.client.expression.MathExpr
-
Returns the population variance of a sequence of
values.
- vec
- Variable in class com.marklogic.client.expression.PlanBuilder
-
Builds expressions with vec server
functions.
- VecExpr - Interface in com.marklogic.client.expression
-
Builds expressions to call functions in the vec
server library for a row pipeline.
- vector(ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
Returns a vector value.
- vectorScore(ServerExpression, double)
- Method in interface com.marklogic.client.expression.VecExpr
-
A helper function that returns a hybrid score
using a cts score and a vector similarity calculation result.
- vectorScore(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
A helper function that returns a hybrid score
using a cts score and a vector similarity calculation result.
- vectorScore(ServerExpression, double, double)
- Method in interface com.marklogic.client.expression.VecExpr
-
A helper function that returns a hybrid score
using a cts score and a vector similarity calculation result.
- vectorScore(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.VecExpr
-
A helper function that returns a hybrid score
using a cts score and a vector similarity calculation result.
- verify(String, String[], String[])
- Method in class com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier.Builtin
-
- verify(String, SSLSession)
- Method in class com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier.HostnameVerifierAdapter
-
verify method verifies the incoming hostname and
SSLSession.
- verify(String, X509Certificate)
- Method in class com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier.HostnameVerifierAdapter
-
verify method verifies the hostname and
X509Certificate certificate.
- verify(String, String[], String[])
- Method in interface com.marklogic.client.DatabaseClientFactory.SSLHostnameVerifier
-
Checks during SSL authentication that a hostname
matches the Common Name or "DNS" Subject alts from the SSL
certificate presented by the server.
- viewCol(String, String)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies a column where the combination of
view and column name is unique.
- viewCol(XsStringVal, XsStringVal)
- Method in class com.marklogic.client.expression.PlanBuilder
-
Identifies a column where the combination of
view and column name is unique.
- Visitor()
- Constructor for class com.marklogic.client.datamovement.JSONSplitter.Visitor
-
- Visitor()
- Constructor for class com.marklogic.client.datamovement.XMLSplitter.Visitor
-
- wallclockToTimestamp(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Converts an xs:dateTime to a 64 bit timestamp
value.
- warning(SAXParseException)
- Method in class com.marklogic.client.io.InputSourceHandle.DraconianErrorHandler
-
Ignores the warning.
- Warning()
- Constructor for class com.marklogic.client.io.SearchHandle.Warning
-
- week(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns an xs:integer between 1 and 53, both
inclusive, representing the week value in the localized value of
arg.
- weekday(ServerExpression)
- Method in interface com.marklogic.client.expression.SqlExpr
-
Returns the day of the week.
- weekdayFromDate(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer in the range 1 to 7,
inclusive, representing the weekday value in the localized value of
arg.
- weekFromDate(ServerExpression)
- Method in interface com.marklogic.client.expression.XdmpExpr
-
Returns an integer between 1 and 53, both
inclusive, representing the week value in the localized value of
arg.
- WGS84
- Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to "wgs84"
- WGS84DOUBLE
- Static variable in class com.marklogic.client.query.StructuredQueryBuilder.CoordinateSystem
-
Coordinate System mapping to
"wgs84/double"
- when(boolean, ServerExpression...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function executes the specified expression
if the specified condition is true for the row.
- when(ServerExpression, ServerExpression...)
- Method in class com.marklogic.client.expression.PlanBuilder
-
This function executes the specified expression
if the specified condition is true for the row.
- where(ServerExpression)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
This method restricts the row set to rows
matched by the boolean expression.
- where(CtsQueryExpr)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
This method restricts the row set to rows from
the documents matched by the cts.query expression.
- where(PlanCondition)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
This method restricts the row set to rows
matched by an SQL boolean expression.
- where(SemStoreExpr)
- Method in interface com.marklogic.client.expression.PlanBuilderBase.ModifyPlanBase
-
This method adjusts the row set based on the
triples for the sem.store definition, restricting the triples to
the documents matched by a cts.query expression and expanding the
triples based on inferencing rules.
- whereDistinct()
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
This method removes duplicate rows from the row
set.
- wipe(String, Transaction, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Removes all the versions of the temporal
document specified by the temporal document logical URI in the
temporalCollection
- wipe(String, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Removes all the versions of the temporal
document specified by the temporal document logical URI in the
temporalCollection
- with(Document)
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
Assigns an XML document structure as the content
and returns the handle.
- with(JsonElement)
- Method in class com.marklogic.client.extra.gson.GSONHandle
-
Assigns a JSON tree as the content and returns
the handle.
- with(Document)
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
Assigns an XML document structure as the content
and returns the handle.
- with(byte[])
- Method in class com.marklogic.client.io.BytesHandle
-
Assigns a byte array as the content and returns
the handle as a fluent convenience.
- with(Document)
- Method in class com.marklogic.client.io.DOMHandle
-
Assigns a DOM document as the content and
returns the handle as a fluent convenience.
- with(File)
- Method in class com.marklogic.client.io.FileHandle
-
Assigns a file as the content and returns the
handle as a fluent convenience.
- with(InputSource)
- Method in class com.marklogic.client.io.InputSourceHandle
-
Assigns an input source as the content and
returns the handle as a fluent convenience.
- with(InputStream)
- Method in class com.marklogic.client.io.InputStreamHandle
-
Assigns an input stream as the content and
returns the handle as a fluent convenience.
- with(T)
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Assigns a your custom POJO as the content and
returns the handle.
- with(JsonNode)
- Method in class com.marklogic.client.io.JacksonHandle
-
Assigns a JSON tree as the content and returns
the handle.
- with(JsonParser)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
Assigns the JsonParser and returns the
handle.
- with(C)
- Method in class com.marklogic.client.io.JAXBHandle
-
Assigns the root object of the JAXB structure
for the content and returns the handle as a fluent
convenience.
- with(OutputStreamSender)
- Method in class com.marklogic.client.io.OutputStreamHandle
-
Assigns an output stream sender providing the
callback that writes content to the database and returns the handle
as a fluent convenience.
- with(Reader)
- Method in class com.marklogic.client.io.ReaderHandle
-
Assigns a character reader as the content and
returns the handle as a fluent convenience.
- with(Source)
- Method in class com.marklogic.client.io.SourceHandle
-
Assigns a transform source that produces the
content and returns the handle as a fluent convenience.
- with(String)
- Method in class com.marklogic.client.io.StringHandle
-
Assigns a string as the content and returns the
handle as a fluent convenience.
- with(XMLEventReader)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Assigns an event reader for the content and
returns the handle as a fluent convenience.
- with(XMLStreamReader)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Assigns an stream reader for the content and
returns the handle as a fluent convenience.
- withApplyResult(ApplyTransformListener.ApplyResult)
- Method in class com.marklogic.client.datamovement.ApplyTransformListener
-
Whether to
REPLACE
each document with the result of the
transform, or run the transform with each document as input, but
IGNORE
the result.
- withAuthType(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withBase(String)
- Method in interface com.marklogic.client.type.PlanSparqlOptions
-
- withBase(XsStringVal)
- Method in interface com.marklogic.client.type.PlanSparqlOptions
-
- withBasePath(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withBasicAuth(String, String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withBatchSize(int)
- Method in interface com.marklogic.client.datamovement.Batcher
-
The size of each batch (usually 50-500).
- withBatchSize(int)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Sets the number of documents processed in a
batch.
- withBatchSize(int, int)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Sets the number of documents processed in a
batch and the ratio of the document processing batch to the
document uri collection batch.
- withBatchSize(int)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies the number of rows in each batch
retrieved from the view.
- withBatchSize(int)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Sets the number of documents to send per
batch.
- withBatchView(PlanBuilder.ModifyPlan)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies the plan for getting rows from a view
with PlanBuilder.
- withBatchView(RawPlanDefinition)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies the plan for getting rows from a view
from a serialized AST in JSON format.
- withBatchView(RawQueryDSLPlan)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies the plan for getting rows from a view
from a serialized Query DSL in JavaScript format.
- withBinding(String, String)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Bind a variable of type iri.
- withBinding(String, String, RDFTypes)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Bind a variable of specified type.
- withBinding(String, String, Locale)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Bind a variable of type
http://www.w3.org/1999/02/22-rdf-syntax-ns#langString with the
specified language tag.
- withBlackList(String...)
- Method in class com.marklogic.client.datamovement.FilteredForestConfiguration
-
Add hosts to the list of black-listed hosts
(hosts which the Batcher will not see when it calls
listForests).
- withBm25LengthWeight(double)
- Method in interface com.marklogic.client.type.PlanSearchOptions
-
- withCertificateAuth(String, String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withCertificateAuth(SSLContext, X509TrustManager)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withCertificateFile(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withCertificatePassword(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withClearPass(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withCloudApiKey(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withCloudAuth(String, String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withCloudAuth(String, String, Integer)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withCloudTokenDuration(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withCollections(String...)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the collections to the current
collections for the document.
- withConnectionType(DatabaseClient.ConnectionType)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withConsistentSnapshot()
- Method in class com.marklogic.client.datamovement.ExportListener
-
Specifies that documents should be retrieved as
they were when this QueryBatcher job started.
- withConsistentSnapshot()
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Specifies that matching uris should be retrieved
as they were when this QueryBatcher job started.
- withConsistentSnapshot()
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Enables retrieval of rows that were present in
the view at the time that the first batch was retrieved, ignoring
subsequent changes to the view.
- withConstrainingQuery(QueryDefinition)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the search query used to constrain the set
of documents included in the SPARQL query.
- withCriteria(String)
- Method in interface com.marklogic.client.query.RawCtsQueryDefinition
-
Sets the query criteria as a query string and
returns the query definition as a fluent convenience.
- withCriteria(String)
- Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Sets the query criteria as a query string and
returns the query definition as a fluent convenience.
- withCriteria(String)
- Method in interface com.marklogic.client.query.StringQueryDefinition
-
Sets the query criteria as a query string and
returns the query definition as a fluent convenience.
- withCriteria(String)
- Method in class com.marklogic.client.query.StructuredQueryBuilder.AbstractStructuredQuery
-
- withCriteria(String)
- Method in interface com.marklogic.client.query.StructuredQueryDefinition
-
Sets the query criteria as a query string and
returns the query definition as a fluent convenience.
- withCsvMapper(CsvMapper)
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Used to set the CsvMapper for the current
instance.
- withCsvSchema(CsvSchema)
- Method in class com.marklogic.client.datamovement.JacksonCSVSplitter
-
Used to set the CsvSchema for the current
instance.
- withDatabase(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withDebug(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withDeduplicated(boolean)
- Method in interface com.marklogic.client.type.PlanSparqlOptions
-
- withDeduplicated(XsBooleanVal)
- Method in interface com.marklogic.client.type.PlanSparqlOptions
-
- withDefaultMetadata(DocumentMetadataHandle)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Sets the DocumentMetadataHandle for write
operations.
- withDigestAuth(String, String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withDirectory(String)
- Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the directory that should prefix the
document uri and returns the template object.
- withDisposition(RowBatchFailureListener.BatchFailureDisposition)
- Method in interface com.marklogic.client.datamovement.RowBatchFailureListener.RowBatchFailureEvent
-
Specifies whether to retry the attempt to
retrieve the batch of rows, skip the batch of rows, or stop the
job.
- withDocumentUriAfter(Path)
- Method in class com.marklogic.client.datamovement.PathSplitter
-
set documentUriAfter to the PathSplitter
- withDoNotPrompt(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withEndpointConstants(BufferableHandle)
- Method in interface com.marklogic.client.dataservices.IOEndpoint.CallContext
-
Sets the constant inputs prior to the first call
to the endpoint.
- withEndpointConstantsAs(Object)
- Method in interface com.marklogic.client.dataservices.IOEndpoint.CallContext
-
Sets the constant inputs prior to the first call
to the endpoint.
- withEndpointState(BufferableHandle)
- Method in interface com.marklogic.client.dataservices.IOEndpoint.CallContext
-
Initializes the stateful properties of the
endpoint prior to the first call to the endpoint.
- withEndpointStateAs(Object)
- Method in interface com.marklogic.client.dataservices.IOEndpoint.CallContext
-
Initializes the stateful properties of the
endpoint prior to the first call to the endpoint.
- withForestConfig(ForestConfiguration)
- Method in interface com.marklogic.client.datamovement.Batcher
-
Updates the ForestConfiguration used by this job
to spread the writes or reads.
- withForestConfig(ForestConfiguration)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
- withForestConfig(ForestConfiguration)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies the forest configuration, which also
identifies the enodes for the cluster when not using a load
balancer.
- withForestConfig(ForestConfiguration)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
- withFormat(Format)
- Method in interface com.marklogic.client.document.DocumentDescriptor
-
Specifies the format for a database document and
returns the descriptor object
- withFormat(Format)
- Method in interface com.marklogic.client.document.DocumentUriTemplate
-
Specifies the format of the document and returns
the template object.
- withFormat(Format)
- Method in class com.marklogic.client.io.BytesHandle
-
Specifies the format of the content and returns
the handle as a fluent convenience.
- withFormat(Format)
- Method in class com.marklogic.client.io.FileHandle
-
Specifies the format of the content and returns
the handle as a fluent convenience.
- withFormat(Format)
- Method in class com.marklogic.client.io.InputStreamHandle
-
Specifies the format of the content and returns
the handle as a fluent convenience.
- withFormat(Format)
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Specifies the format of the content and returns
the handle as a fluent convenience.
- withFormat(Format)
- Method in class com.marklogic.client.io.JacksonHandle
-
Specifies the format of the content and returns
the handle as a fluent convenience.
- withFormat(Format)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
Specifies the format of the content and returns
the handle as a fluent convenience.
- withFormat(Format)
- Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies the format of the content and returns
the handle as a fluent convenience.
- withFormat(Format)
- Method in class com.marklogic.client.io.QueryOptionsListHandle
-
Fluent setter for the format associated with
this handle.
- withFormat(Format)
- Method in class com.marklogic.client.io.ReaderHandle
-
Specifies the format of the content and returns
the handle as a fluent convenience.
- withFormat(Format)
- Method in class com.marklogic.client.io.SearchHandle
-
Fluent setter for the format associated with
this handle.
- withFormat(Format)
- Method in class com.marklogic.client.io.StringHandle
-
Specifies the format of the content and returns
the handle as a fluent convenience.
- withFormat(Format)
- Method in class com.marklogic.client.io.TuplesHandle
-
Fluent setter for the format associated with
this handle.
- withFormat(Format)
- Method in class com.marklogic.client.io.ValuesHandle
-
Fluent setter for the format associated with
this handle.
- withFormat(Format)
- Method in class com.marklogic.client.io.ValuesListHandle
-
Fluent setter for the format associated with
this handle.
- withGzippedResponsesDisabled()
- Method in class com.marklogic.client.DatabaseClientBuilder
-
Prevents the underlying OkHttp library from
sending an "Accept-Encoding-gzip" request header on each
request.
- withHandle(StructureWriteHandle)
- Method in interface com.marklogic.client.query.RawCombinedQueryDefinition
-
Specifies the handle for the JSON or XML
representation of a combined query and returns the query
definition.
- withHandle(StructureWriteHandle)
- Method in interface com.marklogic.client.query.RawCtsQueryDefinition
-
Specifies the handle for the JSON or XML
representation of a combined query and returns the query
definition.
- withHandle(StructureWriteHandle)
- Method in interface com.marklogic.client.query.RawQueryByExampleDefinition
-
Specifies the handle for the JSON or XML
representation of a query by example and returns the query
definition.
- withHandle(StructureWriteHandle)
- Method in interface com.marklogic.client.query.RawStructuredQueryDefinition
-
Specifies the handle for the JSON or XML
representation of a structured query and returns the query
definition.
- withHandle(JSONWriteHandle)
- Method in interface com.marklogic.client.row.RawPlanDefinition
-
Assigns the handle and returns the raw plan as a
convenience.
- withHandle(TextWriteHandle)
- Method in interface com.marklogic.client.row.RawQueryDSLPlan
-
Assigns the handle and returns the raw plan as a
convenience.
- withHandle(TextWriteHandle)
- Method in interface com.marklogic.client.row.RawSPARQLSelectPlan
-
Assigns the handle and returns the raw plan as a
convenience.
- withHandle(TextWriteHandle)
- Method in interface com.marklogic.client.row.RawSQLPlan
-
Assigns the handle and returns the raw plan as a
convenience.
- withHost(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withHostUnavailableExceptions(Class<Throwable>...)
- Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
Overwrites the list of exceptions for which a
request can be retried and a MarkLogic host can be
blacklisted
- within(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'within' DE-9IM relation.
- within(ServerExpression, ServerExpression, String)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'within' DE-9IM relation.
- within(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.GeoExpr
-
Compares geospatial regions to see if they
fulfill the 'within' DE-9IM relation.
- withIncludeDefaultRulesets(Boolean)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set whether to include database-default
inference or not.
- withInitiator(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withJobId(String)
- Method in interface com.marklogic.client.datamovement.Batcher
-
Sets the unique id of the job to help with
managing multiple concurrent jobs and start the job with the
specified job id.
- withJobId(String)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Sets the unique id of the job to help with
managing multiple concurrent jobs and start the job with the
specified job id.
- withJobId(String)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies the identifier for the job executed by
the RowBatcher.
- withJobId(String)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Sets the unique id of the job to help with
managing multiple concurrent jobs and start the job with the
specified job id.
- withJobName(String)
- Method in interface com.marklogic.client.datamovement.Batcher
-
Sets the name of the job to help with managing
multiple concurrent jobs.
- withJobName(String)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Sets the job name.
- withJobName(String)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies the name for the job executed by the
RowBatcher.
- withJobName(String)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Sets the job name.
- withKerberosAuth(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withKerberosPrincipal(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withKeyStoreAlgorithm(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withKeyStorePassword(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withKeyStorePath(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
Enables 2-way SSL by creating an SSL context
based on the given key store path.
- withKeyStoreType(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withKeyTab(String)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withKind(String)
- Method in interface com.marklogic.client.expression.TransformDef
-
Define the kind of transform; either "mjs" (the
default) or "xslt".
- withLimit(int)
- Method in interface com.marklogic.client.type.PlanSampleByOptions
-
- withLimit(XsIntVal)
- Method in interface com.marklogic.client.type.PlanSampleByOptions
-
- withMaxRetries(int)
- Method in interface com.marklogic.client.datamovement.RowBatchFailureListener.RowBatchFailureEvent
-
Specifies the number of retries before skipping
the batch.
- withMetadataCategory(DocumentManager.Metadata)
- Method in class com.marklogic.client.datamovement.ExportListener
-
Adds a metadata category to retrieve and make
available from
DocumentRecord.getMetadata
to listeners registered with
onDocumentReady.
- withMetadataCategory(DocumentManager.Metadata)
- Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
Adds a metadata category to retrieve with each
document.
- withMetadataValue(String, String)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the metadata-value to the current
metadata-values for the document.
- withMimetype(String)
- Method in class com.marklogic.client.io.BytesHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.DOMHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.FileHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.InputSourceHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.InputStreamHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.JacksonHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.JAXBHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.ReaderHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.SourceHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.StringHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMimetype(String)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
Specifies the mime type of the content and
returns the handle as a fluent convenience.
- withMinHosts(int)
- Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
If less than minHosts are left, calls
stopJob.
- withMode(String)
- Method in interface com.marklogic.client.expression.SchemaDefExpr
-
Defines the mode property.
- withNonDocumentFormat(Format)
- Method in class com.marklogic.client.datamovement.ExportListener
-
- withNonDocumentFormat(Format)
- Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
The format for the metadata retrieved with each
document.
- withOAuth(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withOAuthToken(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withParam(String, Object)
- Method in interface com.marklogic.client.expression.TransformDef
-
Convenience method for adding a single parameter
to the transform definition.
- withParams(Map<String, Object>)
- Method in interface com.marklogic.client.expression.TransformDef
-
Define a set of parameters to pass to the
transform.
- withPassword(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withPermission(String, DocumentMetadataHandle.Capability...)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the role and its capabilities to
the current permissions for the document.
- withPort(int)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withPrincipal(String)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withProperty(QName, Object)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the property name and value to the
current properties for the document.
- withProperty(String, Object)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally adds the property name and value to the
current properties for the document.
- withQuality(int)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
Locally specifies the match quality for the
document.
- withQualityWeight(float)
- Method in interface com.marklogic.client.type.PlanSearchOptions
-
Changed in release 7.0.0 to return a float, as
the server requires a float and throws an error on a double.
- withQualityWeight(XsFloatVal)
- Method in interface com.marklogic.client.type.PlanSearchOptions
-
Changed in release 7.0.0 to return a float, as
the server requires a float and throws an error on a double.
- withRecordPrefix(String)
- Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
Sets the string prefix to send to the writer
before each record.
- withRecordPrefix(String)
- Method in class com.marklogic.client.datamovement.UrisToWriterListener
-
- withRecordSuffix(String)
- Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
Sets the string suffix to append to the writer
after each record.
- withRecordSuffix(String)
- Method in class com.marklogic.client.datamovement.UrisToWriterListener
-
- withRefreshKrb5Config(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withRenamedHost(String, String)
- Method in class com.marklogic.client.datamovement.FilteredForestConfiguration
-
Rename hosts to network-addressable names rather
than the host names known to the MarkLogic cluster.
- withRenewTGT(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withResendable(boolean)
- Method in class com.marklogic.client.io.OutputStreamHandle
-
Specifies whether the content can be resent to
the output stream and returns the handle as a fluent
convenience.
- withRuleset(SPARQLRuleset)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the name of rulesets to include for
inferring triples.
- withSAMLAuth(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withSAMLToken(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withSchemaUri(String)
- Method in interface com.marklogic.client.expression.SchemaDefExpr
-
Defines the schema based on an existing document
in the database.
- withScoreMethod(PlanSearchOptions.ScoreMethod)
- Method in interface com.marklogic.client.type.PlanSearchOptions
-
- withSecurityContext(DatabaseClientFactory.SecurityContext)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withSessionState(SessionState)
- Method in interface com.marklogic.client.dataservices.IOEndpoint.CallContext
-
Sets an identifier for an endpoint to use when
accessing a session cache on the server.
- withSparql(String)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the SPARQL query or update statement
- withSparql(TextWriteHandle)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
Set the SPARQL query or update statement
- withSSLContext(SSLContext)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withSSLContext(SSLContext, X509TrustManager)
- Method in class com.marklogic.client.DatabaseClientFactory.BasicAuthContext
-
- withSSLContext(SSLContext, X509TrustManager)
- Method in class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- withSSLContext(SSLContext, X509TrustManager)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosAuthContext
-
- withSSLContext(SSLContext, X509TrustManager)
- Method in class com.marklogic.client.DatabaseClientFactory.MarkLogicCloudAuthContext
-
- withSSLContext(SSLContext, X509TrustManager)
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Configures the SSL context and trust manager for
a SAML authorization context
- withSSLContext(SSLContext, X509TrustManager)
- Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
The SSLContext should be initialized with
KeyManager and TrustManager using a KeyStore.
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in class com.marklogic.client.DatabaseClientFactory.BasicAuthContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in class com.marklogic.client.DatabaseClientFactory.CertificateAuthContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in class com.marklogic.client.DatabaseClientFactory.DigestAuthContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosAuthContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in class com.marklogic.client.DatabaseClientFactory.MarkLogicCloudAuthContext
-
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in class com.marklogic.client.DatabaseClientFactory.SAMLAuthContext
-
Configures the SSL hostname verifier for a SAML
authorization context
- withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier)
- Method in interface com.marklogic.client.DatabaseClientFactory.SecurityContext
-
Specifies the host verifier for a client that
verifies hosts for additional security.
- withSSLProtocol(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withStoreKey(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withStorePass(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withSuspendTimeForHostUnavailable(Duration)
- Method in class com.marklogic.client.datamovement.HostAvailabilityListener
-
If a host becomes unavailable (SocketException,
SSLException, UnknownHostException), adds it to the blacklist
- withTemplate(String)
- Method in class com.marklogic.client.datamovement.ExtractRowsViaTemplateListener
-
Register one or more template uris which needs
to be applied to each batch to extract the rows
- withTemporalCollection(String)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
The temporal collection to use for a temporal
document insert
- withThreadCount(int)
- Method in interface com.marklogic.client.datamovement.Batcher
-
The number of threads to be used internally by
this job to perform concurrent tasks on batches (usually >
10).
- withThreadCount(int)
- Method in interface com.marklogic.client.datamovement.QueryBatcher
-
Sets the number of threads added to the internal
thread pool for this instance to use for retrieving or processing
batches of uris.
- withThreadCount(int)
- Method in interface com.marklogic.client.datamovement.RowBatcher
-
Specifies how many batches of rows to retrieve
concurrently from the view.
- withThreadCount(int)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
Sets the number of threads added to the internal
thread pool for this instance to use for writing or reporting on
batches of uris.
- withTicketCache(String)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withTotalResults(long)
- Method in class com.marklogic.client.datamovement.ProgressListener
-
Configures the total number of results that
progress listeners can expect.
- withTransform(ServerTransform)
- Method in class com.marklogic.client.datamovement.ApplyTransformListener
-
The ServerTransform to run on each document from
each batch.
- withTransform(ServerTransform)
- Method in class com.marklogic.client.datamovement.ExportListener
-
Sets the server tranform to modify the document
contents.
- withTransform(ServerTransform)
- Method in class com.marklogic.client.datamovement.ExportToWriterListener
-
- withTransform(ServerTransform)
- Method in interface com.marklogic.client.datamovement.WriteBatcher
-
The ServerTransform to modify each document from
each batch before it is written to the database.
- withTransformer(Transformer)
- Method in class com.marklogic.client.io.SourceHandle
-
Specifies a transformer for modifying the
content and returns the handle as a fluent convenience.
- withTrustManager(X509TrustManager)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withTrustStoreAlgorithm(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withTrustStorePassword(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withTrustStorePath(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
Supports constructing an
X509TrustManager
based on the given file path, which
should point to a Java key store or trust store.
- withTrustStoreType(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withTryFirstPass(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withUpdate(boolean)
- Method in interface com.marklogic.client.row.RowManager
-
As of MarkLogic 11.2, the "v1/rows/update"
endpoint must be used in order to submit an Optic plan that
performs an update.
- withUpdatePermission(String, Capability)
- Method in interface com.marklogic.client.semantics.SPARQLQueryDefinition
-
- withUseFirstPass(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withUseKeyTab(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withUsername(String)
- Method in class com.marklogic.client.DatabaseClientBuilder
-
- withUseTicketCache(boolean)
- Method in class com.marklogic.client.DatabaseClientFactory.KerberosConfig
-
- withWhiteList(String...)
- Method in class com.marklogic.client.datamovement.FilteredForestConfiguration
-
Add hosts to a white-list.
- word(String, String...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties with at
least one of the specified words or phrases.
- word(String, String[], double, String...)
- Method in interface com.marklogic.client.pojo.PojoQueryBuilder
-
Filter search results by properties with at
least one of the specified words or phrases.
- word(StructuredQueryBuilder.TextIndex, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, or
field that has at least one of the criteria words.
- word(StructuredQueryBuilder.TextIndex, StructuredQueryBuilder.FragmentScope, String[], double, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches an element, attribute, JSON property, or
field that has at least one of the criteria words.
- wordConstraint(String, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the
constraint when it has at least one of the criteria words.
- wordConstraint(String, double, String...)
- Method in class com.marklogic.client.query.StructuredQueryBuilder
-
Matches the container specified by the
constraint when it has at least one of the criteria words.
- WordConstraintQuery(String, String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.WordConstraintQuery
-
- WordConstraintQuery(String, Double, String...)
- Constructor for class com.marklogic.client.query.StructuredQueryBuilder.WordConstraintQuery
-
- wordQuery(String)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given phrase.
- wordQuery(ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given phrase.
- wordQuery(String, String...)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given phrase.
- wordQuery(ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given phrase.
- wordQuery(String, String, double)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given phrase.
- wordQuery(ServerExpression, ServerExpression, ServerExpression)
- Method in interface com.marklogic.client.expression.CtsExpr
-
Returns a query matching text content containing
a given phrase.
- write(String, AbstractWriteHandle)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided
path on the REST server.
- write(ExtensionLibraryDescriptor, AbstractWriteHandle)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided
path on the REST server.
- write(OutputStream)
- Method in class com.marklogic.client.alerting.RuleDefinition
-
Writes a serialized RuleDefinition to an
OutputStream as XML.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- write(String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write
but write document at a specific system
time
- write(String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write
but write document at a specific system
time
- write(DocumentWriteSet, ServerTransform, Transaction, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
- write(DocumentDescriptor, String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write
but creates a new version of the document in
the logical temporal collection URI passed as argument and names
the new version of the document as the URI in the Document
descriptor
- write(String, String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write
but creates a new version of the document in
the logical temporal collection URI passed as argument and names
the new version of the document as the docId passed.
- write(String, String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write
but writes document at a specific system
time
- write(DocumentDescriptor, String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction, String, Calendar)
- Method in interface com.marklogic.client.bitemporal.TemporalDocumentManager
-
Just like
write
but writes document at a specific system
time
- write(DocumentWriteSet)
- Method in interface com.marklogic.client.document.DocumentManager
-
Write a set of documents and metadata to the
server via REST API bulk capabilities.
- write(DocumentWriteSet, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Write a set of documents and metadata to the
server via REST API bulk capabilities.
- write(DocumentWriteSet, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Write a set of documents and metadata to the
server via REST API bulk capabilities.
- write(DocumentWriteSet, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Write a set of documents and metadata to the
server via REST API bulk capabilities.
- write(String, W)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from
the representation provided by the handle To call write(), an
application must authenticate as rest-writer or rest-admin.
- write(String, W, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database as
transformed on the server.
- write(DocumentDescriptor, W)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from
the representation provided by the handle To call write(), an
application must authenticate as rest-writer or rest-admin.
- write(DocumentDescriptor, W, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database as
transformed on the server.
- write(String, DocumentMetadataWriteHandle, W)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the
database from the representations provided by the handles To call
write(), an application must authenticate as rest-writer or
rest-admin.
- write(String, DocumentMetadataWriteHandle, W, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the
database as transformed on the server.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the
database from the representations provided by the handles To call
write(), an application must authenticate as rest-writer or
rest-admin.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to the
database as transformed on the server.
- write(String, W, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database
transaction from the representation provided by the handle To call
write(), an application must authenticate as rest-writer or
rest-admin.
- write(String, W, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database
transaction as transformed on the server.
- write(DocumentDescriptor, W, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database
transaction from the representation provided by the handle To call
write(), an application must authenticate as rest-writer or
rest-admin.
- write(DocumentDescriptor, W, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to an open database
transaction as transformed on the server.
- write(String, DocumentMetadataWriteHandle, W, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an
open database transaction from the representations provided by the
handles To call write(), an application must authenticate as
rest-writer or rest-admin.
- write(String, DocumentMetadataWriteHandle, W, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an
open database transaction as transformed on the server.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an
open database transaction from the representations provided by the
handles To call write(), an application must authenticate as
rest-writer or rest-admin.
- write(DocumentDescriptor, DocumentMetadataWriteHandle, W, ServerTransform, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata and content to an
open database transaction as transformed on the server.
- write()
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
Inserts or overwrites the documents identified
by the uri column with the data supplied by the other document
descriptor columns.
- write(PlanDocColsIdentifier)
- Method in interface com.marklogic.client.expression.PlanBuilder.ModifyPlan
-
Inserts or overwrites the documents identified
by the uri column with the data supplied by the other document
descriptor columns.
- write(OutputStream)
- Method in class com.marklogic.client.extra.dom4j.DOM4JHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.extra.jdom.JDOMHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.DocumentMetadataHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.DOMHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.InputSourceHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.JacksonDatabindHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.JacksonHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.JacksonParserHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.JAXBHandle
-
- write(OutputStream)
- Method in interface com.marklogic.client.io.OutputStreamSender
-
Implements a callback to write content to the
provided output stream for sending to the database server.
- write(OutputStream)
- Method in class com.marklogic.client.io.ReaderHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.SourceHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.StringHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.XMLEventReaderHandle
-
- write(OutputStream)
- Method in class com.marklogic.client.io.XMLStreamReaderHandle
-
- write(T)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Write this instance to the database.
- write(T, String...)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
Does everything in
write(T)
but also adds your collections to the persisted instance.
- write(T, Transaction)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
- write(T, Transaction, String...)
- Method in interface com.marklogic.client.pojo.PojoRepository
-
- write(String, TriplesWriteHandle)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the handle as the
specified graph.
- write(String, TriplesWriteHandle, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the handle as the
specified graph.
- write(String, TriplesWriteHandle, GraphPermissions)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the handle and specified
permissions as the specified graph.
- write(String, TriplesWriteHandle, GraphPermissions, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the handle and specified
permissions as the specified graph.
- writeAs(String, Object)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided
path on the REST server as an object of an IO class.
- writeAs(ExtensionLibraryDescriptor, Object)
- Method in interface com.marklogic.client.admin.ExtensionLibrariesManager
-
Writes the contents of a handle to the provided
path on the REST server as an object of an IO class.
- writeAs(String, Object)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from
an object of an IO class.
- writeAs(String, Object, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from
an object of an IO class.
- writeAs(String, DocumentMetadataWriteHandle, Object)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from
an object of an IO class.
- writeAs(String, DocumentMetadataWriteHandle, Object, ServerTransform)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document content to the database from
an object of an IO class.
- writeAs(String, Object)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the graphData object as
the specified graph.
- writeAs(String, Object, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the graphData object as
the specified graph.
- writeAs(String, Object, GraphPermissions)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the graphData object and
specified permissions as the specified graph.
- writeAs(String, Object, GraphPermissions, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite triples from the graphData object and
specified permissions as the specified graph.
- WriteBatch - Interface in com.marklogic.client.datamovement
-
A batch of documents written successfully.
- WriteBatcher - Interface in com.marklogic.client.datamovement
-
To facilitate long-running write jobs, batches
documents added by many external threads and coordinates internal
threads to send the batches round-robin to all appropriate hosts in
the cluster.
- WriteBatchListener - Interface in
com.marklogic.client.datamovement
-
Runs processEvent on each batch as it is ready
during a WriteBatcher job.
- writeConfiguration()
- Method in interface com.marklogic.client.admin.ServerConfigurationManager
-
Writes the values of the properties of this
object to the server.
- writeDefaultMetadata(String)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reverts the document metadata in the database to
the defaults To call writeDefaultMetadata(), an application must
authenticate as rest-writer or rest-admin.
- writeDefaultMetadata(String, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reverts the document metadata in an open
database transaction to the defaults To call
writeDefaultMetadata(), an application must authenticate as
rest-writer or rest-admin.
- writeDefaultMetadata(String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reverts the metadata in the database for the
documents to the defaults To call writeDefaultMetadata(), an
application must authenticate as rest-writer or rest-admin.
- writeDefaultMetadata(Transaction, String...)
- Method in interface com.marklogic.client.document.DocumentManager
-
Reverts the document metadata in an open
database transaction to the defaults To call
writeDefaultMetadata(), an application must authenticate as
rest-writer or rest-admin.
- WriteEvent - Interface in com.marklogic.client.datamovement
-
Each WriteBatch is composed of many WriteEvents,
each of which represents all the information about a single
document which was written to the server.
- WriteFailureListener - Interface in
com.marklogic.client.datamovement
-
The listener interface for handling exceptions
occurring withing WriteBatcher.
- writeJavascriptTransform(String, TextWriteHandle)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in
Javascript.
- writeJavascriptTransform(String, TextWriteHandle, ExtensionMetadata)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in
Javascript.
- writeJavascriptTransformAs(String, Object)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery in a
textual representation provided as an object of an IO class.
- writeJavascriptTransformAs(String, ExtensionMetadata, Object)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in Javascript
in a textual representation provided as an object of an IO
class.
- writeMetadata(String, DocumentMetadataWriteHandle)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata to the database
from the representation provided by the handle To call
writeMetadata(), an application must authenticate as rest-writer or
rest-admin.
- writeMetadata(String, DocumentMetadataWriteHandle, Transaction)
- Method in interface com.marklogic.client.document.DocumentManager
-
Writes the document metadata to an open database
transaction from the representation provided by the handle To call
writeMetadata(), an application must authenticate as rest-writer or
rest-admin.
- writeOptions(String, QueryOptionsWriteHandle)
- Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Write a named QueryOptions configuration to the
REST server.
- writeOptionsAs(String, Format, Object)
- Method in interface com.marklogic.client.admin.QueryOptionsManager
-
Write a named QueryOptions configuration to the
REST server in a JSON or XML representation provided as an object
of an IO class.
- writePermissions(String, GraphPermissions)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite all permissions for the graph.
- writePermissions(String, GraphPermissions, Transaction)
- Method in interface com.marklogic.client.semantics.GraphManager
-
Overwrite all permissions for the graph.
- writeRule(RuleDefinition)
- Method in interface com.marklogic.client.alerting.RuleManager
-
Writes a rule to the server from the provided
handle.
- writeRule(String, RuleWriteHandle)
- Method in interface com.marklogic.client.alerting.RuleManager
-
Writes a rule to the server from the provided
handle.
- writeRuleAs(String, Object)
- Method in interface com.marklogic.client.alerting.RuleManager
-
Writes a rule to the server in an XML
representation provided as an object of an IO class.
- writeServices(String, TextWriteHandle, ExtensionMetadata, ResourceExtensionsManager.MethodParameters...)
- Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Installs the services that implement a
resource.
- writeServicesAs(String, Object, ExtensionMetadata, ResourceExtensionsManager.MethodParameters...)
- Method in interface com.marklogic.client.admin.ResourceExtensionsManager
-
Installs the services that implement a resource
in a textual representation provided as an object of an IO
class.
- writeXQueryTransform(String, TextWriteHandle)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in
XQuery.
- writeXQueryTransform(String, TextWriteHandle, ExtensionMetadata)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in
XQuery.
- writeXQueryTransformAs(String, Object)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery in a
textual representation provided as an object of an IO class.
- writeXQueryTransformAs(String, ExtensionMetadata, Object)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XQuery in a
textual representation provided as an object of an IO class.
- writeXSLTransform(String, XMLWriteHandle)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL.
- writeXSLTransform(String, XMLWriteHandle, ExtensionMetadata)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL.
- writeXSLTransformAs(String, Object)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL in an
XML representation provided as an object of an IO class.
- writeXSLTransformAs(String, ExtensionMetadata, Object)
- Method in interface com.marklogic.client.admin.TransformExtensionsManager
-
Installs a transform implemented in XSL in an
XML representation provided as an object of an IO class.