com.marklogic.client.query.RawQueryByExampleDefinition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client-api

The official MarkLogic Java client API.

There is a newer version: 4.0.1

/*
 * Copyright 2013-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 com.marklogic.client.io.marker.StructureWriteHandle;

/**
 * A RawQueryByExampleDefinition provides access to a simple
 * query by example in an JSON or XML representation.
 */
public interface RawQueryByExampleDefinition extends RawQueryDefinition {
	/**
	 * The namespace of the built-in vocabulary for an Query by Example
	 * in XML format.
	 */
	final public static String QBE_NS =
		"http://marklogic.com/appservices/querybyexample";

	/**
	 * Specifies the handle for the JSON or XML representation
	 * of a query by example and returns the query definition.
	 * @param handle	the JSON or XML handle.
	 * @return	the query definition.
	 */
	public RawQueryByExampleDefinition withHandle(StructureWriteHandle handle);
}