com.marklogic.client.query.KeyValueQueryDefinition Maven / Gradle / Ivy
/*
* Copyright 2012-2015 MarkLogic Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.marklogic.client.query;
import java.util.Map;
/**
* @deprecated Use Query By Example instead for easy-to-write and much more full-featured key/value search.
*
* For instance:
* {@code
*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 QueryManager#newRawCombinedQueryDefinitionAs(Format, Object)
* @see QueryManager#newRawCombinedQueryDefinitionAs(Format, Object, String)
* @see QueryManager#newRawQueryByExampleDefinition(StructureWriteHandle)
* @see QueryManager#newRawQueryByExampleDefinition(StructureWriteHandle, String)
* @see MarkLogic Java Application Developer's Guide
* > Searching
* > Prototype a Query Using Query By Example
*/
@Deprecated
public interface KeyValueQueryDefinition extends QueryDefinition, Map {
}