Package org.apache.jackrabbit.oak.spi.query

Class QueryIndex.IndexPlan.Builder

java.lang.Object

org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan.Builder

Enclosing interface:

QueryIndex.IndexPlan

public static class QueryIndex.IndexPlan.Builder
extends Object

A builder for index plans.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,List<String>>	additionalMessages
protected Map<String,Object>	attributes
protected double	costPerEntry
protected double	costPerExecution
protected NodeState	definition
protected boolean	deprecated
protected long	estimatedEntryCount
protected Filter	filter
protected boolean	includesNodeData
protected boolean	isDelayed
protected boolean	isFulltextIndex
protected boolean	logWarningForPathFilterMismatch
protected String	pathPrefix
protected String	planName
protected Filter.PropertyRestriction	propRestriction
protected List<QueryIndex.OrderEntry>	sortOrder
protected boolean	supportsPathRestriction

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QueryIndex.IndexPlan.Builder	addAdditionalMessage(String level, String s)
QueryIndex.IndexPlan	build()
QueryIndex.IndexPlan.Builder	setAttribute(String key, Object value)
QueryIndex.IndexPlan.Builder	setCostPerEntry(double costPerEntry)
QueryIndex.IndexPlan.Builder	setCostPerExecution(double costPerExecution)
QueryIndex.IndexPlan.Builder	setDefinition(NodeState definition)
QueryIndex.IndexPlan.Builder	setDelayed(boolean isDelayed)
QueryIndex.IndexPlan.Builder	setDeprecated(boolean deprecated)
QueryIndex.IndexPlan.Builder	setEstimatedEntryCount(long estimatedEntryCount)
QueryIndex.IndexPlan.Builder	setFilter(Filter filter)
QueryIndex.IndexPlan.Builder	setFulltextIndex(boolean isFulltextIndex)
QueryIndex.IndexPlan.Builder	setIncludesNodeData(boolean includesNodeData)
QueryIndex.IndexPlan.Builder	setLogWarningForPathFilterMismatch(boolean value)
QueryIndex.IndexPlan.Builder	setPathPrefix(String pathPrefix)
QueryIndex.IndexPlan.Builder	setPlanName(String name)
QueryIndex.IndexPlan.Builder	setPropertyRestriction(Filter.PropertyRestriction restriction)
QueryIndex.IndexPlan.Builder	setSortOrder(List<QueryIndex.OrderEntry> sortOrder)
QueryIndex.IndexPlan.Builder	setSupportsPathRestriction(boolean supportsPathRestriction)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

costPerExecution

protected double costPerExecution

costPerEntry

protected double costPerEntry

estimatedEntryCount

protected long estimatedEntryCount

filter

protected Filter filter

isDelayed

protected boolean isDelayed

isFulltextIndex

protected boolean isFulltextIndex

includesNodeData

protected boolean includesNodeData

sortOrder

protected List<QueryIndex.OrderEntry> sortOrder

definition

protected NodeState definition

propRestriction

protected Filter.PropertyRestriction propRestriction

pathPrefix

protected String pathPrefix

supportsPathRestriction

protected boolean supportsPathRestriction

attributes

protected Map<String,Object> attributes

planName

protected String planName

deprecated

protected boolean deprecated

logWarningForPathFilterMismatch

protected boolean logWarningForPathFilterMismatch

additionalMessages

protected final Map<String,List<String>> additionalMessages

Constructor Detail

Builder

public Builder()

Method Detail

setCostPerExecution

public QueryIndex.IndexPlan.Builder setCostPerExecution(double costPerExecution)

setCostPerEntry

public QueryIndex.IndexPlan.Builder setCostPerEntry(double costPerEntry)

setEstimatedEntryCount

public QueryIndex.IndexPlan.Builder setEstimatedEntryCount(long estimatedEntryCount)

setFilter

public QueryIndex.IndexPlan.Builder setFilter(Filter filter)

setDelayed

public QueryIndex.IndexPlan.Builder setDelayed(boolean isDelayed)

addAdditionalMessage

public QueryIndex.IndexPlan.Builder addAdditionalMessage(String level,
                                                         String s)

setLogWarningForPathFilterMismatch

public QueryIndex.IndexPlan.Builder setLogWarningForPathFilterMismatch(boolean value)

setFulltextIndex

public QueryIndex.IndexPlan.Builder setFulltextIndex(boolean isFulltextIndex)

setIncludesNodeData

public QueryIndex.IndexPlan.Builder setIncludesNodeData(boolean includesNodeData)

setSortOrder

public QueryIndex.IndexPlan.Builder setSortOrder(List<QueryIndex.OrderEntry> sortOrder)

setDefinition

public QueryIndex.IndexPlan.Builder setDefinition(NodeState definition)

setPropertyRestriction

public QueryIndex.IndexPlan.Builder setPropertyRestriction(Filter.PropertyRestriction restriction)

setPathPrefix

public QueryIndex.IndexPlan.Builder setPathPrefix(String pathPrefix)

setSupportsPathRestriction

public QueryIndex.IndexPlan.Builder setSupportsPathRestriction(boolean supportsPathRestriction)

setAttribute

public QueryIndex.IndexPlan.Builder setAttribute(String key,
                                                 Object value)

setPlanName

public QueryIndex.IndexPlan.Builder setPlanName(String name)

setDeprecated

public QueryIndex.IndexPlan.Builder setDeprecated(boolean deprecated)

build

public QueryIndex.IndexPlan build()