/*

   Derby - Class org.apache.derby.impl.sql.compile.SubstituteExpressionVisitor

   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.derby.impl.sql.compile;

import org.apache.derby.shared.common.error.StandardException;
import org.apache.derby.iapi.sql.compile.Visitable;
import org.apache.derby.iapi.sql.compile.Visitor;

/**
 * Replaces a <em>source</em> expression with a <em>target</em>
 * expression.  
 * 
 */
class SubstituteExpressionVisitor implements Visitor 
{
	private ValueNode source;
	private ValueNode target;
    private Class<?>  skipOverClass;
	
	SubstituteExpressionVisitor(
            ValueNode s, ValueNode t, Class<?> skipThisClass)
	{
		source = s;
		target = t;
		skipOverClass = skipThisClass;
	}

	/**
	 * used by GroupByNode to process expressions by complexity level.
	 */
    ValueNode getSource()
	{
		return source;
	}

	public Visitable visit(Visitable node) throws StandardException 
	{
		if (!(node instanceof ValueNode))
		{
			return node;
		}
		
		ValueNode nd = (ValueNode)node;
		if (nd.isEquivalent(source)) 
		{
			return target;
		} 
		else 
		{
			return node;
		}
	}

	public boolean stopTraversal() 
	{
		return false;
	}

	public boolean skipChildren(Visitable node) 
	{
		return (skipOverClass == null) ?
				false:
				skipOverClass.isInstance(node);
	}

	public boolean visitChildrenFirst(Visitable node)
	{
		return false;
	}
}
