Module jakarta.faces

Package jakarta.faces.component.search

Class SearchExpressionContextFactory

java.lang.Object

jakarta.faces.component.search.SearchExpressionContextFactory

All Implemented Interfaces:

FacesWrapper<SearchExpressionContextFactory>

Direct Known Subclasses:

SearchExpressionContextFactoryImpl

public abstract class SearchExpressionContextFactory
extends Object
implements FacesWrapper<SearchExpressionContextFactory>

Provide for separation of interface and implementation for the SearchExpressionContext contract. Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped() to access the instance being wrapped.

Since:

2.3

Constructor Summary

Constructors

Constructor	Description
SearchExpressionContextFactory(SearchExpressionContextFactory wrapped)	If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and Type	Method	Description
abstract SearchExpressionContext	getSearchExpressionContext(FacesContext context, UIComponent source, Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints)	Creates a SearchExpressionContext instance for use with the SearchExpressionHandler.
SearchExpressionContextFactory	getWrapped()	If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchExpressionContextFactory

public SearchExpressionContextFactory(SearchExpressionContextFactory wrapped)

If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The getWrapped() will then return the implementation being wrapped.

Parameters:

wrapped - The implementation being wrapped.

Method Details

getWrapped

public SearchExpressionContextFactory getWrapped()

If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Specified by:

getWrapped in interface FacesWrapper<SearchExpressionContextFactory>

Returns:

the wrapped instance.

getSearchExpressionContext

public abstract SearchExpressionContext getSearchExpressionContext(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