jakarta.faces.component.search.SearchExpressionHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of myfaces-api Show documentation

The public API classes of the Apache MyFaces CORE JSF-2.1 project

There is a newer version: 4.1.0-RC3

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package jakarta.faces.component.search;

import java.util.List;
import jakarta.faces.component.ContextCallback;
import jakarta.faces.component.UIComponent;
import jakarta.faces.context.FacesContext;

/**
 *
 */
public abstract class SearchExpressionHandler
{

    protected static final char[] EXPRESSION_SEPARATOR_CHARS = new char[]
    {
        ',', ' '
    };
    public static final String KEYWORD_PREFIX = "@";

    public abstract String resolveClientId(SearchExpressionContext searchExpressionContext, String expression);

    public abstract List resolveClientIds(
            SearchExpressionContext searchExpressionContext, String expressions);

    public abstract void resolveComponent(SearchExpressionContext searchExpressionContext, String expression,
            ContextCallback callback);

    public abstract void resolveComponents(SearchExpressionContext searchExpressionContext, String expressions,
            ContextCallback callback);

    public void invokeOnComponent(SearchExpressionContext searchExpressionContext,
            String expressions, ContextCallback topCallback)
    {
        invokeOnComponent(searchExpressionContext, searchExpressionContext.getSource(), expressions, topCallback);
    }

    public abstract void invokeOnComponent(SearchExpressionContext searchExpressionContext,
            UIComponent previous, String expression, ContextCallback topCallback);

    public abstract String[] splitExpressions(FacesContext context, String expressions);

    public abstract boolean isPassthroughExpression(SearchExpressionContext searchExpressionContext, String expression);

    public abstract boolean isValidExpression(SearchExpressionContext searchExpressionContext, String expression);
    
    public char[] getExpressionSeperatorChars(FacesContext context)
    {
        return EXPRESSION_SEPARATOR_CHARS;
    }

}