com.marklogic.client.query

Enum QueryManager.QueryView

java.lang.Object

java.lang.Enum<QueryManager.QueryView>

com.marklogic.client.query.QueryManager.QueryView

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<QueryManager.QueryView>

Enclosing interface:

QueryManager

public static enum QueryManager.QueryView
extends java.lang.Enum<QueryManager.QueryView>

The view produced by a query.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL All views that the query can produce.
DEFAULT The view specified by the query options.
FACETS Values from different constraints for the matched documents.
METADATA Basic summary information about the matched documents.
RESULTS A list of result documents with snippets, extracted metadata, and so on.

Method Summary

Modifier and Type	Method and Description
static QueryManager.QueryView	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static QueryManager.QueryView[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final QueryManager.QueryView DEFAULT

The view specified by the query options.

RESULTS

public static final QueryManager.QueryView RESULTS

A list of result documents with snippets, extracted metadata, and so on.

FACETS

public static final QueryManager.QueryView FACETS

Values from different constraints for the matched documents.

METADATA

public static final QueryManager.QueryView METADATA

Basic summary information about the matched documents.

ALL

public static final QueryManager.QueryView ALL

All views that the query can produce.

Method Detail

values

public static QueryManager.QueryView[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QueryManager.QueryView c : QueryManager.QueryView.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QueryManager.QueryView valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null