com.marklogic.client.query

Interface RawQueryByExampleDefinition

All Superinterfaces:

QueryDefinition, RawQueryDefinition

public interface RawQueryByExampleDefinition
extends RawQueryDefinition

A RawQueryByExampleDefinition provides access to a simple query by example in an JSON or XML representation. For instance:

QueryManager queryMgr = databaseClient.newQueryManager();
String rawXMLQuery = "{ \"$query\": { \"author\": \"Mark Twain\" } }";
StringHandle qbeHandle = new StringHandle(rawXMLQuery).withFormat(Format.JSON);
RawQueryByExampleDefinition query = queryMgr.newRawQueryByExampleDefinition(qbeHandle, "myoptions");
SearchHandle resultsHandle = queryMgr.search(query, new SearchHandle());

See Also:

QueryManager.newRawCombinedQueryDefinitionAs(Format, Object), QueryManager.newRawCombinedQueryDefinitionAs(Format, Object, String), QueryManager.newRawQueryByExampleDefinition(StructureWriteHandle), QueryManager.newRawQueryByExampleDefinition(StructureWriteHandle, String), MarkLogic Java Application Developer's Guide > Searching > Prototype a Query Using Query By Example

Field Summary

Fields

Modifier and Type	Field and Description
static String	QBE_NS The namespace of the built-in vocabulary for an Query by Example in XML format.

Method Summary

Modifier and Type	Method and Description
RawQueryByExampleDefinition	withHandle(StructureWriteHandle handle) Specifies the handle for the JSON or XML representation of a query by example and returns the query definition.

Methods inherited from interface com.marklogic.client.query.RawQueryDefinition

getHandle, setHandle

Methods inherited from interface com.marklogic.client.query.QueryDefinition

getCollections, getDirectory, getOptionsName, getResponseTransform, setCollections, setDirectory, setOptionsName, setResponseTransform

Field Detail

QBE_NS

static final String QBE_NS

The namespace of the built-in vocabulary for an Query by Example in XML format.

See Also:

Constant Field Values

Method Detail

withHandle

RawQueryByExampleDefinition withHandle(StructureWriteHandle handle)

Specifies the handle for the JSON or XML representation of a query by example and returns the query definition.

Parameters:

handle - the JSON or XML handle.

Returns:

the query definition.