Package org.hibernate.search.backend.lucene.search.projection.impl

Class ProjectionRequestContext

java.lang.Object

org.hibernate.search.backend.lucene.search.projection.impl.ProjectionRequestContext

public final class ProjectionRequestContext
extends Object

Constructor Summary

Constructors

Constructor	Description
ProjectionRequestContext(ExtractionRequirements.Builder extractionRequirementsBuilder, LuceneAbstractSearchHighlighter globalHighlighter, Map<String,LuceneAbstractSearchHighlighter> namedHighlighters, QueryParameters parameters)

Method Summary

Modifier and Type	Method	Description
String	absoluteCurrentFieldPath()
String	absoluteCurrentNestedFieldPath()
void	checkValidField(String absoluteFieldPath)
ProjectionRequestContext	forField(String absoluteFieldPath, boolean nestedObject)
LuceneAbstractSearchHighlighter	highlighter(String name)
boolean	projectionCardinalityCorrectlyAddressed(String requiredContextAbsoluteFieldPath)
NamedValues	queryParameters()
void	requireAllStoredFields()
void	requireNestedObjects(Collection<String> paths)
void	requireScore()
void	requireStoredField(String absoluteFieldPath, String nestedDocumentPath)
ProjectionRequestContext	root()

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectionRequestContext

public ProjectionRequestContext(ExtractionRequirements.Builder extractionRequirementsBuilder,
 LuceneAbstractSearchHighlighter globalHighlighter,
 Map<String,LuceneAbstractSearchHighlighter> namedHighlighters,
 QueryParameters parameters)

Method Details

requireAllStoredFields

public void requireAllStoredFields()

requireNestedObjects

public void requireNestedObjects(Collection<String> paths)

requireStoredField

public void requireStoredField(String absoluteFieldPath,
 String nestedDocumentPath)

requireScore

public void requireScore()

checkValidField

public void checkValidField(String absoluteFieldPath)

root

public ProjectionRequestContext root()

forField

public ProjectionRequestContext forField(String absoluteFieldPath,
 boolean nestedObject)

absoluteCurrentNestedFieldPath

public String absoluteCurrentNestedFieldPath()

projectionCardinalityCorrectlyAddressed

public boolean projectionCardinalityCorrectlyAddressed(String requiredContextAbsoluteFieldPath)

absoluteCurrentFieldPath

public String absoluteCurrentFieldPath()

highlighter

public LuceneAbstractSearchHighlighter highlighter(String name)

queryParameters

public NamedValues queryParameters()