View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package jakarta.faces.component.search;
21  
22  import java.util.Set;
23  import jakarta.faces.FactoryFinder;
24  import jakarta.faces.component.UIComponent;
25  import jakarta.faces.component.visit.VisitHint;
26  import jakarta.faces.context.FacesContext;
27  
28  /**
29   *
30   */
31  public abstract class SearchExpressionContext
32  {
33      
34      public static SearchExpressionContext createSearchExpressionContext(FacesContext context, UIComponent source)
35      {
36          return createSearchExpressionContext(context, source, null, null);
37      }
38          
39      public static SearchExpressionContext createSearchExpressionContext(
40              FacesContext context,  UIComponent source, 
41              Set<SearchExpressionHint> expressionHints, Set<VisitHint> visitHints)
42      {
43          SearchExpressionContextFactory factory
44                  = (SearchExpressionContextFactory) FactoryFinder.getFactory(
45                          FactoryFinder.SEARCH_EXPRESSION_CONTEXT_FACTORY);
46          return factory.getSearchExpressionContext(context, source, expressionHints, visitHints);
47      }
48  
49      public abstract UIComponent getSource();
50  
51      public abstract Set<VisitHint> getVisitHints();
52  
53      public abstract Set<SearchExpressionHint> getExpressionHints();
54  
55      public abstract FacesContext getFacesContext();
56      
57  }