public abstract class SearchExpressionContext extends Object
A context object that is used to hold state relating to resolve a search expression.
SearchExpressionHandler
Constructor and Description |
---|
SearchExpressionContext() |
Modifier and Type | Method and Description |
---|---|
static SearchExpressionContext |
createSearchExpressionContext(FacesContext context,
UIComponent source)
Creates a |
static SearchExpressionContext |
createSearchExpressionContext(FacesContext context,
UIComponent source,
Set<SearchExpressionHint> expressionHints,
Set<VisitHint> visitHints)
Creates a |
abstract Set<SearchExpressionHint> |
getExpressionHints()
Returns hints that influence the behavior of resolving the expression. |
abstract FacesContext |
getFacesContext()
Returns the FacesContext for the current request. |
abstract UIComponent |
getSource()
Returns the source / base component from which we will start to perform our search. |
abstract Set<VisitHint> |
getVisitHints()
Returns hints that influence the behavior of the tree visit,
if it's used by an |
public abstract UIComponent getSource()
Returns the source / base component from which we will start to perform our search.
public abstract Set<VisitHint> getVisitHints()
Returns hints that influence the behavior of the tree visit,
if it's used by an SearchKeywordResolver
implementation.
VisitHint
sVisitContext.getHints()
public abstract Set<SearchExpressionHint> getExpressionHints()
Returns hints that influence the behavior of resolving the expression.
SearchExpressionHint
spublic abstract FacesContext getFacesContext()
Returns the FacesContext for the current request.
public static SearchExpressionContext createSearchExpressionContext(FacesContext context, UIComponent source)
Creates a SearchExpressionContext
instance
for use with the SearchExpressionHandler
.
This method can be used to obtain a SearchExpressionContext instance
without any VisitHint
or SearchExpressionHint
.
context
- the FacesContext for the current requestsource
- the source / base component from which we will start to perform our search.SearchExpressionContext
instancepublic static SearchExpressionContext createSearchExpressionContext(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints)
Creates a SearchExpressionContext
instance
for use with the SearchExpressionHandler
.
context
- the FacesContext for the current requestsource
- the source / base component from which we will start to perform our search.expressionHints
- the SearchExpressionHint to apply to the search.
If null
, no hints are applied.visitHints
- the VisitHints to apply to the visit, if used by a SearchKeywordResolver
.
If null
, no hints are applied.SearchExpressionContext
instanceCopyright © 2019 Eclipse Foundation.
Use is subject to license terms.