javax.faces.component.search.SearchKeywordResolver Maven / Gradle / Ivy
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2016 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.component.search;
import javax.faces.component.UIComponent;
/**
* A SearchKeywordResolver is responsible for
* resolving a single keyword. Implementations must support the following set
* of {@code SearchKeywordResolver} implementations, each with the associated
* behavior.
*
*
*
*
* List of required supported keywords and
* their behaviors
*
*
*
* Search Keyword
*
* Behavior
*
*
*
*
*
* @all
*
* All components in the view
*
*
*
* @child(n)
*
* The nth child of the base component
*
*
*
* @composite
*
* The composite component parent of the base component
*
*
*
* @form
*
* The closest form ancestor of the base component
*
*
*
* @id(id)
*
* Resolves to the components with the specified component id (not
* clientId). This is useful when the exact location of the component
* tree is unknown, but must be used with caution when there multiple
* occurrences of the given id within the view.
*
*
*
* @namingcontainer
*
* The closest {@link javax.faces.component.NamingContainer}
* ancestor component of the base component
*
*
*
* @next
*
* The next component in the view after the base component
*
*
*
* @none
*
* No component
*
*
*
* @parent
*
* The parent of the base component
*
*
*
* @previous
*
* The previous component to the base component
*
*
*
* @root
*
* The {@link javax.faces.component.UIViewRoot}
*
*
*
* @this
*
* The base component
*
*
*
*
* New {@link SearchKeywordResolver}s can be registered via
* {@link javax.faces.application.Application#addSearchKeywordResolver(javax.faces.component.search.SearchKeywordResolver)}
* or in the application configuration resources.
*
*
* <application>
* <search-keyword-resolver>...</search-keyword-resolver>
* </application>
*
*
*
* @since 2.3
*/
public abstract class SearchKeywordResolver {
/**
* Try to resolve one or multiple {@link UIComponent}s based on the keyword and calls
* {@link SearchKeywordContext#invokeContextCallback(javax.faces.component.UIComponent)} for each resolved component.
*
*
* @param searchKeywordContext the {@code SearchKeywordContext}
* @param current the previous resolved component or the source component (if called for the first keyword in the chain)
* @param keyword the keyword
*
* @since 2.3
*/
public abstract void resolve(SearchKeywordContext searchKeywordContext, UIComponent current, String keyword);
/**
* Checks if the current instance of the {@link SearchKeywordResolver}
* is responsible for resolving the keyword.
*
* @param searchExpressionContext the {@link SearchExpressionContext}
* @param keyword the keyword
*
* @return true if it's responsible for resolving this keyword
*
* @since 2.3
*/
public abstract boolean isResolverForKeyword(SearchExpressionContext searchExpressionContext, String keyword);
/**
* A passthrough keyword is a keyword, that according to the context,
* does not require to be resolved on the server, and can be passed "unresolved" to the client.
*
* @param searchExpressionContext the {@link SearchExpressionContext}
* @param keyword the keyword
*
* @return true if it's passthrough keyword.
*
* @since 2.3
*/
public boolean isPassthrough(SearchExpressionContext searchExpressionContext, String keyword) {
return false;
}
/**
* A leaf keyword is a keyword that does not allow to be combined with keywords
* or id chains to the right.
* For example: @none:@parent.
*
* @param searchExpressionContext the {@link SearchExpressionContext}
* @param keyword the keyword
*
* @return true if it's leaf keyword.
*
* @since 2.3
*/
public boolean isLeaf(SearchExpressionContext searchExpressionContext, String keyword) {
return false;
}
}