- 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