oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/AstVisitorBase.java

/*
 * 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 org.apache.jackrabbit.oak.query.ast;

import org.apache.jackrabbit.oak.query.QueryImpl;

/**
 * The base class to visit all elements.
 */
public abstract class AstVisitorBase implements AstVisitor {

    /**
     * Calls accept on each of the attached constraints of the AND node.
     */
    @Override
    public boolean visit(AndImpl node) {
        for (ConstraintImpl constraint : node.getConstraints()) {
            constraint.accept(this);
        }
        return true;
    }

    /**
     * Calls accept on the two operands in the comparison node.
     */
    @Override
    public boolean visit(ComparisonImpl node) {
        node.getOperand1().accept(this);
        node.getOperand2().accept(this);
        return true;
    }
    
    /**
     * Calls accept on the all operands in the "in" node.
     */
    @Override
    public boolean visit(InImpl node) {
        node.getOperand1().accept(this);
        for (StaticOperandImpl s : node.getOperand2()) {
            s.accept(this);
        }
        return true;
    }

    /**
     * Calls accept on the static operand in the fulltext search constraint.
     */
    @Override
    public boolean visit(FullTextSearchImpl node) {
        node.getFullTextSearchExpression().accept(this);
        return true;
    }
    
    /**
     * Calls accept on the static operand in the native search constraint.
     */
    @Override
    public boolean visit(NativeFunctionImpl node) {
        node.getNativeSearchExpression().accept(this);
        return true;
    }
    
    /**
     * Calls accept on the static operand in the similar search constraint.
     */
    @Override
    public boolean visit(SimilarImpl node) {
        node.getPathExpression().accept(this);
        return true;
    }
    
    /**
     * Calls accept on the static operand in the spellcheck search constraint.
     */
    @Override
    public boolean visit(SpellcheckImpl node) {
        node.getExpression().accept(this);
        return true;
    }

    /**
     * Calls accept on the static operand in the suggest search constraint.
     */
    @Override
    public boolean visit(SuggestImpl node) {
        node.getExpression().accept(this);
        return true;
    }

    /**
     * Calls accept on the two sources and the join condition in the join node.
     */
    @Override
    public boolean visit(JoinImpl node) {
        node.getLeft().accept(this);
        node.getRight().accept(this);
        node.getJoinCondition().accept(this);
        return true;
    }

    /**
     * Calls accept on the property value in the length node.
     */
    @Override
    public boolean visit(LengthImpl node) {
        return node.getOperand().accept(this);
    }

    /**
     * Calls accept on the dynamic operand in the lower-case node.
     */
    @Override
    public boolean visit(LowerCaseImpl node) {
        return node.getOperand().accept(this);
    }

    /**
     * Calls accept on the dynamic operand in the coalesce node.
     */
    @Override
    public boolean visit(CoalesceImpl node) {
        node.getOperand1().accept(this);
        node.getOperand2().accept(this);
        return true;
    }

    /**
     * Calls accept on the constraint in the NOT node.
     */
    @Override
    public boolean visit(NotImpl node) {
        return node.getConstraint().accept(this);
    }

    /**
     * Calls accept on the dynamic operand in the ordering node.
     */
    @Override
    public boolean visit(OrderingImpl node) {
        return node.getOperand().accept(this);
    }

    /**
     * Calls accept on each of the attached constraints of the OR node.
     */
    @Override
    public boolean visit(OrImpl node) {
        for (ConstraintImpl constraint : node.getConstraints()) {
            constraint.accept(this);
        }
        return true;
    }

    /**
     * Calls accept on the following contained QOM nodes:
     * <ul>
     * <li>Source</li>
     * <li>Constraints</li>
     * <li>Orderings</li>
     * <li>Columns</li>
     * </ul>
     *
     * @param query the query to visit
     */
    public void visit(QueryImpl query) {
        query.getSource().accept(this);
        ConstraintImpl constraint = query.getConstraint();
        if (constraint != null) {
            constraint.accept(this);
        }
        OrderingImpl[] orderings = query.getOrderings();
        if (orderings != null) {
            for (OrderingImpl ordering : orderings) {
                ordering.accept(this);
            }
        }
        ColumnImpl[] columns = query.getColumns();
        for (ColumnImpl column : columns) {
            column.accept(this);
        }
    }

    /**
     * Calls accept on the dynamic operand in the lower-case node.
     */
    @Override
    public boolean visit(UpperCaseImpl node) {
        return node.getOperand().accept(this);
    }

}