- AdhocQuery - Interface in com.marklogic.xcc
-
A specialization of
Request
which
contains an ad-hoc query (XQuery code as a literal String) to be
submitted and evaluated by the MarkLogic Server.
- appendRequestInfo(StringBuffer)
- Method in exception com.marklogic.xcc.exceptions.RequestException
-
- applyEffectiveValues(RequestOptions[])
- Method in class com.marklogic.xcc.RequestOptions
-
Set the option values of this object to the
effective values obtained by merging each of the RequestOption
objects in the array.
- ARRAY_NODE
- Static variable in class com.marklogic.xcc.types.ValueType
-
- ArrayNode - Interface in com.marklogic.xcc.types
-
Interface for JSON array node.
- asBigDecimal()
- Method in interface com.marklogic.xcc.types.NumberNode
-
- asBigDecimal()
- Method in interface com.marklogic.xcc.types.XSDecimal
-
- asBigDecimal()
- Method in interface com.marklogic.xcc.types.XSDouble
-
The item's value as a
BigDecimal
.
- asBigDecimal()
- Method in interface com.marklogic.xcc.types.XSFloat
-
The item's value as a
BigDecimal
.
- asBigInteger()
- Method in interface com.marklogic.xcc.types.XSInteger
-
- asBinaryData()
- Method in interface com.marklogic.xcc.types.XdmBinary
-
Buffers the binary() item from the server and
converts it to a Java byte array.
- asBinaryData()
- Method in interface com.marklogic.xcc.types.XSBase64Binary
-
- asBinaryData()
- Method in interface com.marklogic.xcc.types.XSHexBinary
-
- asBoolean()
- Method in interface com.marklogic.xcc.types.BooleanNode
-
- asBoolean()
- Method in interface com.marklogic.xcc.types.XSBoolean
-
- asDate()
- Method in interface com.marklogic.xcc.types.XSDate
-
- asDate()
- Method in interface com.marklogic.xcc.types.XSDateTime
-
- asDate()
- Method in interface com.marklogic.xcc.types.XSTime
-
- asDouble()
- Method in interface com.marklogic.xcc.types.NumberNode
-
- asDouble()
- Method in interface com.marklogic.xcc.types.XSDouble
-
The item's value as a Double
.
- asDuration()
- Method in interface com.marklogic.xcc.types.XSDuration
-
- asFloat()
- Method in interface com.marklogic.xcc.types.XSFloat
-
The item's value as a Float
.
- asGregorianCalendar()
- Method in interface com.marklogic.xcc.types.XSGDay
-
- asGregorianCalendar()
- Method in interface com.marklogic.xcc.types.XSGMonth
-
- asGregorianCalendar()
- Method in interface com.marklogic.xcc.types.XSGMonthDay
-
- asGregorianCalendar()
- Method in interface com.marklogic.xcc.types.XSGYear
-
- asGregorianCalendar()
- Method in interface com.marklogic.xcc.types.XSGYearMonth
-
- asInputStream()
- Method in interface com.marklogic.xcc.types.XdmItem
-
Return a java.io.InputStream for this
item.
- asInteger()
- Method in interface com.marklogic.xcc.types.XSInteger
-
- asJsonNode()
- Method in interface com.marklogic.xcc.types.JsonItem
-
- asJsonNode(ObjectMapper)
- Method in interface com.marklogic.xcc.types.JsonItem
-
- asLong()
- Method in interface com.marklogic.xcc.types.XSInteger
-
- asPrimitiveBoolean()
- Method in interface com.marklogic.xcc.types.XSBoolean
-
- asPrimitiveDouble()
- Method in interface com.marklogic.xcc.types.XSDouble
-
The item's value as a primitive double
value.
- asPrimitiveFloat()
- Method in interface com.marklogic.xcc.types.XSFloat
-
The item's value as a primitive float
value.
- asPrimitiveInt()
- Method in interface com.marklogic.xcc.types.XSInteger
-
- asPrimitiveLong()
- Method in interface com.marklogic.xcc.types.XSInteger
-
- asReader()
- Method in interface com.marklogic.xcc.types.XdmItem
-
Return a java.io.Reader for this item.
- asString(String)
- Method in interface com.marklogic.xcc.types.XdmSequence
-
Returns a String comprised of
XdmValue.asString()
value of each item in the sequence with the given separator string
between each.
- asString()
- Method in interface com.marklogic.xcc.types.XdmSequence
-
This method is equivalent to asString
("\n")
.
- asString()
- Method in interface com.marklogic.xcc.types.XdmValue
-
Return a String representation of this item, if
possible.
- asStrings()
- Method in interface com.marklogic.xcc.types.XdmSequence
-
Returns an array of
String
s, each
of which is the value returned by the
XdmValue.asString()
method for each item in the sequence.
- asUri()
- Method in interface com.marklogic.xcc.types.XSAnyURI
-
- asW3cAttr(DocumentBuilder)
- Method in interface com.marklogic.xcc.types.XdmAttribute
-
- asW3cAttr()
- Method in interface com.marklogic.xcc.types.XdmAttribute
-
- asW3cComment(DocumentBuilder)
- Method in interface com.marklogic.xcc.types.XdmComment
-
- asW3cComment()
- Method in interface com.marklogic.xcc.types.XdmComment
-
- asW3cDocument(DocumentBuilder)
- Method in interface com.marklogic.xcc.types.XdmDocument
-
Returns a W3C Document equivalent of this
document.
- asW3cDocument()
- Method in interface com.marklogic.xcc.types.XdmDocument
-
This is equivalent to asW3cDocument
(null)
.
- asW3cDocument(DocumentBuilder)
- Method in interface com.marklogic.xcc.types.XdmElement
-
Returns a W3C Document object with this
element() as the root node.
- asW3cDocument()
- Method in interface com.marklogic.xcc.types.XdmElement
-
This is equivalent to asW3cDocument
(null)
.
- asW3cElement(DocumentBuilder)
- Method in interface com.marklogic.xcc.types.XdmElement
-
Returns a W3C Element object equivalent to this
XdmElement.
- asW3cElement()
- Method in interface com.marklogic.xcc.types.XdmElement
-
This is equivalent to asW3cElement
(null)
.
- asW3cNode(DocumentBuilder)
- Method in interface com.marklogic.xcc.types.XdmNode
-
Buffers the node() item from the server and
converts it to a W3C DOM Node object.
- asW3cNode()
- Method in interface com.marklogic.xcc.types.XdmNode
-
This is equivalent to asW3cNode
(null);
- asW3cProcessingInstruction(DocumentBuilder)
- Method in interface com.marklogic.xcc.types.XdmProcessingInstruction
-
- asW3cProcessingInstruction()
- Method in interface com.marklogic.xcc.types.XdmProcessingInstruction
-
- asW3cText(DocumentBuilder)
- Method in interface com.marklogic.xcc.types.XdmText
-
- asW3cText()
- Method in interface com.marklogic.xcc.types.XdmText
-
- AtomicType - Class in com.marklogic.xcc.types
-
Base class for type-safe enumeration instances
that represent atomic types.
- ATTRIBUTE
- Static variable in class com.marklogic.xcc.types.ValueType
-
- AUTO_RETRY_DELAY_SYSTEM_PROPERTY
- Static variable in class com.marklogic.xcc.RequestOptions
-
The system property name
(xcc.request.retries.delay
) which, if set, specifies
the default delay (in milliseconds) between automatic request
retries.
- getAddress()
- Method in interface com.marklogic.xcc.spi.SingleHostAddress
-
The address to which connections are made.
- getAutoRetryDelayMillis()
- Method in class com.marklogic.xcc.RequestOptions
-
The number of milliseconds to delay between each
automatic query retry attempt.
- getBufferSize()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Return the preferred working buffer size to use
for copying the content to the server.
- getCachedTxnTimeout()
- Method in interface com.marklogic.xcc.Session
-
Get the current transaction timeout cached in
XCC.
- getCacheResult()
- Method in class com.marklogic.xcc.RequestOptions
-
Indicates whether the
ResultSequence
should be cached when read from the server.
- getCapability()
- Method in class com.marklogic.xcc.ContentPermission
-
Get this permission's capability.
- getCenter()
- Method in interface com.marklogic.xcc.types.CtsCircle
-
- getChannel(ResultChannelName)
- Method in interface com.marklogic.xcc.ResultSequence
-
- getCode()
- Method in exception com.marklogic.xcc.exceptions.QueryException
-
Returns the server error code for this XQuery
exception.
- getCollections()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Return the set of collection URIs currently in
effect for this options object.
- getConnectionProvider()
- Method in interface com.marklogic.xcc.ContentSource
-
- getConnectionProvider()
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- getConnectionUri()
- Method in interface com.marklogic.xcc.Session
-
Return a URI that describes connection
information for this Session, if available.
- getContent()
- Method in exception com.marklogic.xcc.exceptions.ContentInsertException
-
The
Content
object that could not be inserted.
- getContentBaseId()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Return the numeric database ID of the
contentbase.
- getContentbaseMetaData()
- Method in interface com.marklogic.xcc.Session
-
Meta-information about the contentbase
associated with this Session.
- getContentBaseName()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Return the name of the contentbase associated
with the
Session
.
- getContentBaseName()
- Method in interface com.marklogic.xcc.Session
-
Return the contentbase name provided when this
Session was created, if any.
- getContentSource()
- Method in interface com.marklogic.xcc.Session
-
Obtain a reference to the
ContentSource
object from which this Session instance was obtained.
- getContentUri()
- Method in exception com.marklogic.xcc.exceptions.ContentInsertException
-
The URI, as a String, of the
Content
that
could not be inserted.
- getContextItem()
- Method in class com.marklogic.xcc.exceptions.QueryStackFrame
-
Get the context item, or null if there is no
context defined.
- getContextPosition()
- Method in class com.marklogic.xcc.exceptions.QueryStackFrame
-
Get the context position, or 0 if there is no
context defined.
- getCount() -
Method in interface com.marklogic.xcc.Request
-
Get count of result items for this
request.
- getCreateOptions()
- Method in interface com.marklogic.xcc.Content
-
- getCreateOptions()
- Method in class com.marklogic.xcc.examples.OutputStreamContent
-
- getCreateOptions()
- Method in class com.marklogic.xcc.examples.SemiBufferedContent
-
- getCurrentServerPointInTime()
- Method in interface com.marklogic.xcc.Session
-
Issues a query to the server and returns the
most recent system commit timestamp.
- getData()
- Method in exception com.marklogic.xcc.exceptions.QueryException
-
- getDays()
- Method in class com.marklogic.xcc.types.Duration
-
- getDays()
- Method in interface com.marklogic.xcc.types.XdmDuration
-
- getDefaultLogger()
- Method in interface com.marklogic.xcc.ContentSource
-
Returns the current Logger to which log messages
will be sent.
- getDefaultLogger()
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- getDefaultRequestOptions()
- Method in interface com.marklogic.xcc.Session
-
- getDefaultXQueryVersion()
- Method in class com.marklogic.xcc.RequestOptions
-
Get the default XQuery version string to use as
the default for the request, if any.
- getDocumentURI()
- Method in interface com.marklogic.xcc.ResultItem
-
Returns the URI of the document represented by
this ResultItem, as returned by xdmp:node-uri($node).
- getDriverMajorVersion()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
The driver (XCC) major release version.
- getDriverMinorVersion()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
The driver (XCC) minor release version.
- getDriverPatchVersion()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
The driver (XCC) patch release version.
- getDriverVersionString()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
The driver (XCC) release version, as a
String.
- getEast()
- Method in interface com.marklogic.xcc.types.CtsBox
-
- getEffectiveOptions()
- Method in interface com.marklogic.xcc.Request
-
Returns a
RequestOptions
instance that reflects the execution options that will be applied
to this request.
- getEffectivePointInTime()
- Method in class com.marklogic.xcc.RequestOptions
-
Returns the point-in-time timestamp value, if
any, set in this object.
- getEffectiveRequestOptions()
- Method in interface com.marklogic.xcc.Session
-
Returns an instance of
RequestOptions
that
represents the effective default request options for this Session
(ie, the options that would be applied if no options are applied to
a specific
Request
.
- getEnabledCipherSuites()
- Method in class com.marklogic.xcc.SecurityOptions
-
Return the names of the SSL cipher suites which
are to be enabled when new XCCS connections are created.
- getEnabledProtocols()
- Method in class com.marklogic.xcc.SecurityOptions
-
Return the names of the protocol versions which
are to be enabled when new XCCS connections are created.
- getEncoding()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Get the current charset encoding setting for
this options object.
- getEntityLocation()
- Method in exception com.marklogic.xcc.exceptions.ContentInsertEntityException
-
Returns the location, as a URI String, of the
requested entity.
- getForestIds()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Return the IDs of forests attached to the
contentbase associated with the
Session
.
- getForestMap()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Returns a Map
of forest names to
forest IDs.
- getForestNames()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Return the names of the forests attached to the
contnetbase associated with the
Session
.
- getFormat()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Return the document format value currently in
effect for this options object.
- getFormatString()
- Method in exception com.marklogic.xcc.exceptions.QueryException
-
- getGraph()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Get the RDF Graph for this options object
- getHostName()
- Method in interface com.marklogic.xcc.spi.ConnectionProvider
-
Return the host name of the connection
provider
- getHours()
- Method in class com.marklogic.xcc.types.Duration
-
- getHours()
- Method in interface com.marklogic.xcc.types.XdmDuration
-
- getId()
- Method in class com.marklogic.xcc.ContentPermission
-
Get the roleId of the role associated with this
permission.
- getIndex()
- Method in interface com.marklogic.xcc.ResultItem
-
The position (zero-based) of this ResultItem in
its containing
ResultSequence
.
- getItem()
- Method in interface com.marklogic.xcc.ResultItem
-
Returns the actual
XdmItem
value wrapped by this ResultItem.
- getItemType()
- Method in interface com.marklogic.xcc.types.XdmItem
-
The
ItemType
instance corresponding to the type of this item.
- getLanguage()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Get the current language setting for this
options object.
- getLatitude()
- Method in interface com.marklogic.xcc.types.CtsPoint
-
- getLineNumber()
- Method in class com.marklogic.xcc.exceptions.QueryStackFrame
-
Get the line number in the XQuery source.
- getLocale()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Get the Locale
setting for this
options object.
- getLocale()
- Method in class com.marklogic.xcc.RequestOptions
-
The (possibly null) Locale
object
associated with this instance.
- getLocalname()
- Method in class com.marklogic.xcc.types.XName
-
This XName's local name.
- getLogger()
- Method in interface com.marklogic.xcc.Session
-
Get the java.util.logging.Logger instance set on
this Session.
- getLongitude()
- Method in interface com.marklogic.xcc.types.CtsPoint
-
- getMaxAutoRetry()
- Method in class com.marklogic.xcc.RequestOptions
-
The maximum number of times a retryable request
will be automatically retried before throwing an exception.
- getMetadata()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Return the set of metadata currently in effect
for this options object.
- getMinutes()
- Method in class com.marklogic.xcc.types.Duration
-
- getMinutes()
- Method in interface com.marklogic.xcc.types.XdmDuration
-
- getModuleUri()
- Method in interface com.marklogic.xcc.ModuleInvoke
-
Returns the currently set URI for this
Request
.
- getModuleUri()
- Method in interface com.marklogic.xcc.ModuleSpawn
-
Returns the currently set URI for this
Request
.
- getMonths()
- Method in class com.marklogic.xcc.types.Duration
-
- getMonths()
- Method in interface com.marklogic.xcc.types.XdmDuration
-
- getName()
- Method in interface com.marklogic.xcc.types.XdmVariable
-
The name of this variable.
- getNamespace()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Return the namespace name setting current in
effect for this options object.
- getNamespace()
- Method in class com.marklogic.xcc.types.XName
-
This XName's namespace name, if defined.
- getNodePath()
- Method in interface com.marklogic.xcc.ResultItem
-
Returns the path of the node represented by this
ResultItem, as returned by xdmp:path($node, false()).
- getNorth()
- Method in interface com.marklogic.xcc.types.CtsBox
-
- getObjectInstance(Object, Name, Context, Hashtable<?, ?>)
- Method in class com.marklogic.xcc.jndi.ContentSourceBeanFactory
-
- getOperation()
- Method in class com.marklogic.xcc.exceptions.QueryStackFrame
-
Get the description of the current
operation.
- getOptions()
- Method in interface com.marklogic.xcc.Request
-
- getOutputStream()
- Method in class com.marklogic.xcc.examples.OutputStreamContent
-
Return the end of the pipe to which you will
write your content (the sink).
- getPermissions()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Return the set of document permissions currently
in effect for this options object.
- getPlaceKeys()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Returns the set of forest placement keys (forest
IDs) currently in effect for this options object.
- getPort()
- Method in interface com.marklogic.xcc.spi.ConnectionProvider
-
Return the port of the connection provider
- getPosition()
- Method in interface com.marklogic.xcc.Request
-
Get starting position of results for this
request.
- getQuality()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Return the quality value currently set on this
options object.
- getQuery()
- Method in interface com.marklogic.xcc.AdhocQuery
-
Returns the currently set ad-hoc XQuery
string.
- getQueryLanguage()
- Method in class com.marklogic.xcc.RequestOptions
-
- getRadius()
- Method in interface com.marklogic.xcc.types.CtsCircle
-
- getRepairLevel()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Return the current document repair level
setting.
- getRequest()
- Method in class com.marklogic.xcc.examples.ModuleRunner
-
Returns the
Request
object
used internally to submit requests.
- getRequest()
- Method in class com.marklogic.xcc.examples.SimpleQueryRunner
-
Returns the
Request
object
used internally to submit requests.
- getRequest()
- Method in exception com.marklogic.xcc.exceptions.RequestException
-
The initiating request to which this exception
applies.
- getRequestName()
- Method in class com.marklogic.xcc.RequestOptions
-
A user-defined, name value sent with the
Request
and
logged on the server.
- getRequestTimeLimit()
- Method in class com.marklogic.xcc.RequestOptions
-
Get the "soft" request time limit (in seconds)
to apply to the submitted request.
- getResolveBufferSize()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Indicate the buffer size to use for entity
resolution.
- getResolveEntities()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Get the current setting of the flag which
indicates whether or not to resolve entities embedded in an XML
document to be inserted.
- getResponseCode()
- Method in exception com.marklogic.xcc.exceptions.ServerResponseException
-
- getResponseMessage()
- Method in exception com.marklogic.xcc.exceptions.ServerResponseException
-
- getResultBufferSize()
- Method in class com.marklogic.xcc.RequestOptions
-
The currently set (or default if never set)
ResultSequence
buffer size.
- getResultSequence()
- Method in exception com.marklogic.xcc.exceptions.StreamingResultException
-
- getRole()
- Method in class com.marklogic.xcc.ContentPermission
-
Get the name of the role associated with this
permission.
- getSeconds()
- Method in class com.marklogic.xcc.types.Duration
-
- getSeconds()
- Method in interface com.marklogic.xcc.types.XdmDuration
-
- getServerMajorVersion()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Return the server major release version
number.
- getServerMinorVersion()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Return ther server minor release version
number.
- getServerPatchVersion()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Return ther server patch release version
number.
- getServerVersionString()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Return a String version of the MarkLogic
Server.
- getSession()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
The
Session
object that created this object.
- getSession()
- Method in interface com.marklogic.xcc.Request
-
The session which created this Request.
- getSouth()
- Method in interface com.marklogic.xcc.types.CtsBox
-
- getSslContext()
- Method in class com.marklogic.xcc.SecurityOptions
-
Return the SSL Context that will be used for new
XCCS connections.
- getStack()
- Method in exception com.marklogic.xcc.exceptions.QueryException
-
Get an array of
QueryStackFrame
objects that represent the query stack frame returned by the
server.
- getSymbol()
- Method in class com.marklogic.xcc.ContentCapability
-
Used internally.
- getTemporalCollection()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Get the temporal collection for this options
object.
- getTemporalVersionURI()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Get the temporal version URI for this options
object.
- getTimeoutMillis()
- Method in class com.marklogic.xcc.RequestOptions
-
Get the read timeout value (in milliseconds) for
this options object.
- getTimeoutMillis()
- Method in interface com.marklogic.xcc.spi.ServerConnection
-
A timeout value, in milliseconds, which is a
hint to the provider upon return to indicate how long this
connection should be considered valid.
- getTimeoutTime()
- Method in interface com.marklogic.xcc.spi.ServerConnection
-
Get the exact time, in milliseconds, at which
this connection is considered to be expired.
- getTimeZone()
- Method in class com.marklogic.xcc.RequestOptions
-
The (possibly null) TimeZone
object
associated with this instance.
- getTransactionMode()
- Method in interface com.marklogic.xcc.Session
-
Deprecated.
- getTransactionTimeout()
- Method in interface com.marklogic.xcc.Session
-
Get the current transaction timeout by querying
the server.
- getUpdate()
- Method in interface com.marklogic.xcc.Session
-
Returns update mode for the transaction: true,
false, or auto.
- getUpdate()
- Method in enum com.marklogic.xcc.Session.TransactionMode
-
Deprecated.
- getUri() -
Method in interface com.marklogic.xcc.Content
-
The URI with which this content should be
inserted.
- getUri()
- Method in class com.marklogic.xcc.examples.OutputStreamContent
-
- getUri()
- Method in class com.marklogic.xcc.examples.SemiBufferedContent
-
- getUri()
- Method in class com.marklogic.xcc.exceptions.QueryStackFrame
-
Get the URI of the XQuery source.
- getUser()
- Method in interface com.marklogic.xcc.ContentbaseMetaData
-
Returns the user identity associated with the
Session
from
which this object was obtained.
- getUser()
- Method in exception com.marklogic.xcc.exceptions.RequestPermissionException
-
The user to which this permission issue
applies.
- getUserCredentials()
- Method in interface com.marklogic.xcc.Session
-
Returns the user identity associated with this
Session.
- getUserName()
- Method in interface com.marklogic.xcc.UserCredentials
-
The user name associated with this credential
object.
- getUserObject()
- Method in interface com.marklogic.xcc.Session
-
Fetch the current user object set for this
Session.
- getValue()
- Method in interface com.marklogic.xcc.types.XdmVariable
-
The value of this variable.
- getValueType()
- Method in interface com.marklogic.xcc.types.XdmValue
-
The XQuery type specification instance for this
value.
- getVariables()
- Method in class com.marklogic.xcc.exceptions.QueryStackFrame
-
Get the variable bindings.
- getVariables()
- Method in interface com.marklogic.xcc.Request
-
Return an array (possibly zero length) of all
the
XdmVariable
objects currently set on this Request.
- getVersionMajor()
- Static method in class com.marklogic.xcc.Version
-
- getVersionMinor()
- Static method in class com.marklogic.xcc.Version
-
- getVersionPatch()
- Static method in class com.marklogic.xcc.Version
-
- getVersionString()
- Static method in class com.marklogic.xcc.Version
-
- getVertices()
- Method in interface com.marklogic.xcc.types.CtsPolygon
-
- getW3CCode()
- Method in exception com.marklogic.xcc.exceptions.QueryException
-
Returns the error code defined by the WC3 XQuery
spec that corresponds to this exception, if any.
- getWest()
- Method in interface com.marklogic.xcc.types.CtsBox
-
- getWholeSeconds()
- Method in class com.marklogic.xcc.types.Duration
-
- getWholeSeconds()
- Method in interface com.marklogic.xcc.types.XdmDuration
-
- getXAResource()
- Method in interface com.marklogic.xcc.Session
-
Returns an instance of the XAResource interface,
specific to this Session object.
- getXQueryVersion()
- Method in class com.marklogic.xcc.exceptions.QueryStackFrame
-
Get the XQuery version for this stack
frame
- getXQueryVersion()
- Method in exception com.marklogic.xcc.exceptions.RetryableXQueryException
-
Returns the XQuery version (0.9-ml, 1.0-ml or
1.0) of the module that threw the exception.
- getXQueryVersion()
- Method in exception com.marklogic.xcc.exceptions.XQueryException
-
Returns the XQuery version (0.9-ml, 1.0-ml or
1.0) of the module that threw the exception.
- getYears()
- Method in class com.marklogic.xcc.types.Duration
-
- getYears()
- Method in interface com.marklogic.xcc.types.XdmDuration
-
- SecurityOptions - Class in com.marklogic.xcc
-
This class contains the SSL security options to
be used by secure XCC connections.
- SecurityOptions(SSLContext)
- Constructor for class com.marklogic.xcc.SecurityOptions
-
Construct a new SecurityOptions instance with
the specified SSL context.
- SecurityOptions(SecurityOptions)
- Constructor for class com.marklogic.xcc.SecurityOptions
-
- SemiBufferedContent - Class in com.marklogic.xcc.examples
-
This is a specialized
Content
implementation that takes an
InputStream
and will
either buffer the content of the stream if it's small enough, or
copy the content to a temporary disk file otherwise.
- SemiBufferedContent(String, ContentCreateOptions, InputStream, int, File)
- Constructor for class com.marklogic.xcc.examples.SemiBufferedContent
-
Instantiate a
Content
object
that will either buffer the
InputStream
or copy it to
disk, depending on whether the stream size exceeds the provided
buffer size.
- SemiBufferedContent(String, ContentCreateOptions, InputStream, int)
- Constructor for class com.marklogic.xcc.examples.SemiBufferedContent
-
Instantiate a
Content
object
that will either buffer the
InputStream
or copy it to
disk, depending on whether the size exceeds the provided buffer
size.
- SEQUENCE
- Static variable in class com.marklogic.xcc.types.ValueType
-
- SequenceType - Class in com.marklogic.xcc.types
-
Type indicator class for values that are
sequences.
- ServerConnection - Interface in com.marklogic.xcc.spi
-
This class encapsulates a server connection as
returned from a
ConnectionProvider
instance.
- ServerConnectionException - Exception in
com.marklogic.xcc.exceptions
-
This exception indicates a problem with the
connection to the server.
- ServerConnectionException(String, Request)
- Constructor for exception com.marklogic.xcc.exceptions.ServerConnectionException
-
- ServerConnectionException(String, Request, Throwable)
- Constructor for exception com.marklogic.xcc.exceptions.ServerConnectionException
-
- ServerResponseException - Exception in
com.marklogic.xcc.exceptions
-
This exception indicates that an unrecognized
response was received from the server.
- ServerResponseException(String, Request, int, String)
- Constructor for exception com.marklogic.xcc.exceptions.ServerResponseException
-
- ServerResponseException(String, Request, int, String, Throwable)
- Constructor for exception com.marklogic.xcc.exceptions.ServerResponseException
-
- Session - Interface in com.marklogic.xcc
-
A Session object represents a conversation with
a contentbase (database) on a MarkLogic Server instance (
ContentSource
)
and holds state information related to that conversation.
- Session.TransactionMode - Enum in
com.marklogic.xcc
-
Deprecated.
- Session.Update - Enum in com.marklogic.xcc
-
Nature of a transaction: query, update or
auto-detect based on the statement.
- setAuthenticationPreemptive(boolean)
- Method in interface com.marklogic.xcc.ContentSource
-
Sets whether basic authentication should be
attempted preemptively, default is false.
- setAuthenticationPreemptive(boolean)
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setAutoCommit(boolean)
- Method in interface com.marklogic.xcc.Session
-
Switches on or off auto commit.
- setAutoCommit(boolean)
- Method in enum com.marklogic.xcc.Session.TransactionMode
-
Deprecated.
- setAutoRetryDelayMillis(int)
- Method in class com.marklogic.xcc.RequestOptions
-
Set the time to delay (in milliseconds) between
automatic query retries.
- setBufferSize(int)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set a preferred working buffer size to use for
copying to the server.
- setCacheResult(boolean)
- Method in class com.marklogic.xcc.RequestOptions
-
- setCollections(String[])
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set an array of URIs that represent collections
to which the document(s) will be added when inserted.
- setContentBase(String)
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setCount(long)
- Method in interface com.marklogic.xcc.Request
-
Set count of result items for this
request.
- setDays(int)
- Method in class com.marklogic.xcc.types.Duration
-
Sets the days value of this duration.
- setDefaultLogger(Logger)
- Method in interface com.marklogic.xcc.ContentSource
-
Set the default java.util.Logger instance which
will be inherited by new
Session
instances.
- setDefaultLogger(Logger)
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setDefaultRequestOptions(RequestOptions)
- Method in interface com.marklogic.xcc.Session
-
- setDefaultXQueryVersion(String)
- Method in class com.marklogic.xcc.RequestOptions
-
Set the default XQuery version that should apply
to this request.
- setEffectivePointInTime(BigInteger)
- Method in class com.marklogic.xcc.RequestOptions
-
Set a point-in-time timestamp value.
- setEnabledCipherSuites(String[])
- Method in class com.marklogic.xcc.SecurityOptions
-
Set the cipher suites enabled when new XCCS
connections are created.
- setEnabledProtocols(String[])
- Method in class com.marklogic.xcc.SecurityOptions
-
Set the protocol versions enabled when new XCCS
connections are created.
- setEncoding(String)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the charset encoding to be used by the
server when loading this document.
- setFormat(DocumentFormat)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the format of the document to be created to
the given type.
- setFormatBinary()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Convenience method equivalent to setFormat
(DocumentFormat.BINARY);
.
- setFormatJson()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Convenience method equivalent to setFormat
(DocumentFormat.JSON);
.
- setFormatText()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Convenience method equivalent to setFormat
(DocumentFormat.TEXT);
.
- setFormatXml()
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Convenience method equivalent to setFormat
(DocumentFormat.XML);
.
- setGraph(String)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the RDF Graph for this options object
- setHost(String)
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setHours(int)
- Method in class com.marklogic.xcc.types.Duration
-
Sets the hours value of this duration.
- setLanguage(String)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the language name to associate with inserted
documents.
- setLocale(Locale)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the effective Locale
value for
this options object.
- setLocale(Locale)
- Method in class com.marklogic.xcc.RequestOptions
-
Set (or clear) the Locale
object to
associate with this options instance.
- setLogger(Logger)
- Method in interface com.marklogic.xcc.Session
-
Set the Logger instance to which log messages
resulting from operations on this Session should be written.
- setMaxAutoRetry(int)
- Method in class com.marklogic.xcc.RequestOptions
-
The maximum number of times a retryable request
will be automatically retried before throwing an exception.
- setMetadata(Map<String, String>)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set an map of metadata key and metadata values
that represent metadata to which the document(s) will be added when
inserted.
- setMinutes(int)
- Method in class com.marklogic.xcc.types.Duration
-
Sets the minutes value of this duration.
- setModuleUri(String)
- Method in interface com.marklogic.xcc.ModuleInvoke
-
Replace the URI associated with this
Request
, which
specifies an XQuery module (server-side code) to be invoked on the
server.
- setModuleUri(String)
- Method in interface com.marklogic.xcc.ModuleSpawn
-
Replace the URI associated with this
Request
, which
specifies an XQuery module (server-side code) to be spawned (run
asynchronously) on the server.
- setMonths(int)
- Method in class com.marklogic.xcc.types.Duration
-
Sets the months value of this duration.
- setNamespace(String)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set a namespace name, which will used as the
namespace associated with inserted documents.
- setNewIntegerVariable(String, String, long)
- Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XSInteger
,
binds it to this Request and then returns the new
XSInteger
instance.
- setNewIntegerVariable(String, long)
- Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XSInteger
,
binds it to this Request and then returns the new
XSInteger
instance.
- setNewStringVariable(String, String, String)
- Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XSString
,
binds it to this Request and then returns the new
XSString
instance.
- setNewStringVariable(String, String)
- Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XSString
,
binds it to this Request and then returns the new
XSString
instance.
- setNewVariable(XName, XdmValue)
- Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XdmVariable
,
binds it to this Request and then returns the new
XdmVariable
object.
- setNewVariable(String, String, ValueType, Object)
- Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XdmVariable
,
binds it to this Request and then returns the new
XdmVariable
object.
- setNewVariable(String, ValueType, Object)
- Method in interface com.marklogic.xcc.Request
-
Convenience method that creates a new
XdmVariable
,
binds it to this Request and then returns the new
XdmVariable
.
- setNewVariables(XName, XdmValue[])
- Method in interface com.marklogic.xcc.Request
-
Creates a sequence
XdmVariable
from the input values and binds it to this Request.
- setNewVariables(String, String, ValueType, Object[])
- Method in interface com.marklogic.xcc.Request
-
Creates a sequence
XdmVariable
from the input values and binds it to this Request.
- setNewVariables(String, ValueType, Object[])
- Method in interface com.marklogic.xcc.Request
-
Creates a sequence
XdmVariable
from the input values and binds it to this Request.
- setOptions(ContentCreateOptions)
- Method in class com.marklogic.xcc.examples.ContentLoader
-
Set (or clear) an instance of
ContentCreateOptions
which defines creation options to apply to each document
loaded.
- setOptions(RequestOptions)
- Method in interface com.marklogic.xcc.Request
-
- setPassword(String)
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setPermissions(ContentPermission[])
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the permissions to be applied when documents
are inserted.
- setPlaceKeys(BigInteger[])
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the forest placement keys for this options
object as an array of BigInteger
objects.
- setPlaceKeys(long[])
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the forest placement keys as long
values.
- setPort(int)
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setPosition(long)
- Method in interface com.marklogic.xcc.Request
-
Set starting position of results for this
request.
- setQuality(int)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the quality value for this options object,
which will set on inserted documents.
- setQuery(String)
- Method in interface com.marklogic.xcc.AdhocQuery
-
Replace the XQuery code to be submitted and
evaluated with this
Request
.
- setQueryLanguage(String)
- Method in class com.marklogic.xcc.RequestOptions
-
- setRepairLevel(DocumentRepairLevel)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the document repair level for this options
object.
- setRequestName(String)
- Method in class com.marklogic.xcc.RequestOptions
-
Set a user-defined, name value to be associated
with the
Request
.
- setRequestOptions(RequestOptions)
- Method in class com.marklogic.xcc.examples.ContentFetcher
-
Set (or clear) the
RequestOptions
instance to associate with submitted queries.
- setRequestOptions(RequestOptions)
- Method in class com.marklogic.xcc.examples.ModuleRunner
-
Set (or clear) the
RequestOptions
instance to associate with submitted queries.
- setRequestOptions(RequestOptions)
- Method in class com.marklogic.xcc.examples.SimpleQueryRunner
-
Set (or clear) the
RequestOptions
instance to associate with submitted queries.
- setRequestTimeLimit(int)
- Method in class com.marklogic.xcc.RequestOptions
-
Set the "soft" time limit (in seconds) to apply
to the submitted request.
- setResolveBufferSize(int)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the entity resulution buffer size.
- setResolveEntities(boolean)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the flag indicating whether embedded
entities should be resolved during content insertion.
- setResultBufferSize(int)
- Method in class com.marklogic.xcc.RequestOptions
-
- setSign(boolean)
- Method in class com.marklogic.xcc.types.Duration
-
Sets the sign of this duration, either positive
or negative.
- setTemporalCollection(String)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the temporal collection to associate with
inserted documents.
- setTemporalVersionURI(String)
- Method in class com.marklogic.xcc.ContentCreateOptions
-
Set the temporal version URI to associate with
inserted documents.
- setTimeoutMillis(int)
- Method in class com.marklogic.xcc.RequestOptions
-
Set the timeout value, in milliseconds, for the
low-level connection.
- setTimeoutMillis(long)
- Method in interface com.marklogic.xcc.spi.ServerConnection
-
- setTimeoutTime(long)
- Method in interface com.marklogic.xcc.spi.ServerConnection
-
Set the exact time, as milliseconds since the
epoch, at which this connection is to be considered expired.
- setTimeZone(TimeZone)
- Method in class com.marklogic.xcc.RequestOptions
-
Set (or clear) the TimeZone
object
to associate with this options instance.
- setTransactionMode(Session.TransactionMode)
- Method in interface com.marklogic.xcc.Session
-
Deprecated.
- setTransactionTimeout(int)
- Method in interface com.marklogic.xcc.Session
-
Sets the timeout for transactions
- setUpdate(Session.Update)
- Method in interface com.marklogic.xcc.Session
-
Sets the this session to be in a query or update
transaction.
- setUpdate(Session.Update)
- Method in enum com.marklogic.xcc.Session.TransactionMode
-
Deprecated.
- setUrl(String)
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setUser(String)
- Method in class com.marklogic.xcc.jndi.ContentSourceBean
-
- setUserObject(Object)
- Method in interface com.marklogic.xcc.Session
-
Attach, or clear, an opaque user-provided object
to this Session.
- setVariable(XdmVariable)
- Method in interface com.marklogic.xcc.Request
-
- setWholeSeconds(long)
- Method in class com.marklogic.xcc.types.Duration
-
Sets the seconds value of this duration.
- setYears(int)
- Method in class com.marklogic.xcc.types.Duration
-
Sets the years value of this duration.
- shutdown(Logger)
- Method in interface com.marklogic.xcc.spi.ConnectionProvider
-
Tell the provider to shutdown and release any
resources being used.
- SimpleQueryRunner - Class in com.marklogic.xcc.examples
-
This is a very simple class that will submit an
XQuery string to the server and return the result.
- SimpleQueryRunner(URI)
- Constructor for class com.marklogic.xcc.examples.SimpleQueryRunner
-
Construct an instance that will submit query
requests to the server represented by the given URI.
- SingleHostAddress - Interface in com.marklogic.xcc.spi
-
This interface should be implemented by
ConnectionProvider
implementations that make socket connections to a single host and
port.
- size() - Method
in interface com.marklogic.xcc.Content
-
The size of the content, if known.
- size()
- Method in class com.marklogic.xcc.examples.OutputStreamContent
-
Unknown size.
- size()
- Method in class com.marklogic.xcc.examples.SemiBufferedContent
-
- size() -
Method in interface com.marklogic.xcc.ResultSequence
-
Returns the number of
ResultItem
s, if
known, in this ResultSequence.
- size()
- Method in interface com.marklogic.xcc.types.XdmSequence
-
Returns the size of this XdmSequence.
- spawnThread(Runnable)
- Static method in class com.marklogic.xcc.examples.OutputStreamInserter
-
Create and start a new Thread
for
the given Runnable
.
- StreamingResultException - Exception in
com.marklogic.xcc.exceptions
-
This unchecked (runtime) exception may be thrown
by some methods of streaming
ResultSequence
objects if an
IOException
occurs while processing the
streaming data.
- StreamingResultException(String, ResultSequence, Throwable)
- Constructor for exception com.marklogic.xcc.exceptions.StreamingResultException
-
- StreamingResultException(ResultSequence, Throwable)
- Constructor for exception com.marklogic.xcc.exceptions.StreamingResultException
-
- submitRequest(Request)
- Method in interface com.marklogic.xcc.Session
-