Module jakarta.faces

Package jakarta.faces.component.search

Class SearchExpressionContext

java.lang.Object

jakarta.faces.component.search.SearchExpressionContext

Direct Known Subclasses:

SearchExpressionContextImpl

public abstract class SearchExpressionContext
extends Object

A context object that is used to hold state relating to resolve a search expression.

Since:

2.3

See Also:

• SearchExpressionHandler

Constructor Summary

Constructors

Constructor	Description
SearchExpressionContext()

Method Summary

Modifier and Type	Method	Description
static SearchExpressionContext	createSearchExpressionContext(FacesContext context, UIComponent source)	Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.
static SearchExpressionContext	createSearchExpressionContext(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints)	Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.
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 SearchKeywordResolver implementation.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchExpressionContext

public SearchExpressionContext()

Method Details

getSource

public abstract UIComponent getSource()

Returns the source / base component from which we will start to perform our search.

Returns:

the source component.

Since:

2.3

getVisitHints

public abstract Set<VisitHint> getVisitHints()

Returns hints that influence the behavior of the tree visit, if it's used by an SearchKeywordResolver implementation.

Returns:

a non-empty, unmodifiable collection of VisitHints

Since:

2.3

See Also:

• VisitContext.getHints()

getExpressionHints

public abstract Set<SearchExpressionHint> getExpressionHints()

Returns hints that influence the behavior of resolving the expression.

Returns:

a non-empty, unmodifiable collection of SearchExpressionHints

Since:

2.3

getFacesContext

public abstract FacesContext getFacesContext()

Returns the FacesContext for the current request.

Returns:

the FacesContext.

Since:

2.3

createSearchExpressionContext

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.

Parameters:

context - the FacesContext for the current request

source - the source / base component from which we will start to perform our search.

Returns:

a SearchExpressionContext instance

Since:

2.3

createSearchExpressionContext

public static SearchExpressionContext createSearchExpressionContext(FacesContext context,
 UIComponent source,
 Set<SearchExpressionHint> expressionHints,
 Set<VisitHint> visitHints)

Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.

Parameters:

context - the FacesContext for the current request

source - 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.

Returns:

a SearchExpressionContext instance

Since:

2.3