com.bigdata.rdf.sparql.ast.hints

Enum QueryHintScope

java.lang.Object

java.lang.Enum<QueryHintScope>

com.bigdata.rdf.sparql.ast.hints.QueryHintScope

All Implemented Interfaces:

Serializable, Comparable<QueryHintScope>

public enum QueryHintScope
extends Enum<QueryHintScope>

Type safe enumeration for the scope of a query hint. The URI for each scope is plus the name of the enumeration value. For example, http://www.bigdata.com/queryHints#Group would apply to the entire group in which that query hint was found.

Version:

$Id$

Author:

Bryan Thompson

See Also:

QueryHints, ASTQueryHintOptimizer

Enum Constant Summary

Enum Constants

Enum Constant and Description
Group The group in which the query hint appears and any direct non-group children within that group.
GroupAndSubGroups The group in which the query hint appears and any children of that group.
Prior The query hint binds on the previous non-query hint AST node which is not itself a query hint.
Query The entire query.
SubQuery The query or subquery in which the query hint appears (any of the QueryBase instances).

Method Summary

Methods

Modifier and Type	Method and Description
org.openrdf.model.URI	getURI()
static QueryHintScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryHintScope	valueOf(org.openrdf.model.URI uri)
static QueryHintScope[]	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

Query

public static final QueryHintScope Query

The entire query.

SubQuery

public static final QueryHintScope SubQuery

The query or subquery in which the query hint appears (any of the QueryBase instances).

See Also:

QueryRoot, SubqueryRoot, NamedSubqueryRoot

Group

public static final QueryHintScope Group

The group in which the query hint appears and any direct non-group children within that group.

GroupAndSubGroups

public static final QueryHintScope GroupAndSubGroups

The group in which the query hint appears and any children of that group. This does not apply to things within ServiceNodes or SubqueryRoots.

Prior

public static final QueryHintScope Prior

The query hint binds on the previous non-query hint AST node which is not itself a query hint. This may be used to bind a query hint on a StatementPatternNode, a JoinGroupNode, a UnionNode, a ServiceNode, etc. This DOES NOT bind the query hint on the children of that AST node.

Method Detail

values

public static QueryHintScope[] 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 (QueryHintScope c : QueryHintScope.values())
    System.out.println(c);

Returns:

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

valueOf

public static QueryHintScope valueOf(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:

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

NullPointerException - if the argument is null

getURI

public org.openrdf.model.URI getURI()

valueOf

public static QueryHintScope valueOf(org.openrdf.model.URI uri)