14c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson/*
24c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * Licensed to the Apache Software Foundation (ASF) under one
34c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * or more contributor license agreements. See the NOTICE file
44c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * distributed with this work for additional information
54c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * regarding copyright ownership. The ASF licenses this file
64c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * to you under the Apache License, Version 2.0 (the  "License");
74c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * you may not use this file except in compliance with the License.
84c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * You may obtain a copy of the License at
94c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson *
104c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson *     http://www.apache.org/licenses/LICENSE-2.0
114c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson *
124c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * Unless required by applicable law or agreed to in writing, software
134c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS,
144c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
154c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * See the License for the specific language governing permissions and
164c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * limitations under the License.
174c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson */
184c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson/*
194c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * $Id: XSLTVisitor.java 468643 2006-10-28 06:56:03Z minchau $
204c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson */
214c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilsonpackage org.apache.xalan.templates;
224c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
234c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilsonimport org.apache.xpath.XPathVisitor;
244c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
254c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson/**
264c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * A derivation from this class can be passed to a class that implements
274c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * the XSLTVisitable interface, to have the appropriate method called
284c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * for each component of an XSLT stylesheet.  Aside from possible other uses,
294c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * the main intention is to provide a reasonable means to perform expression
304c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson * rewriting.
314c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson */
324c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilsonpublic class XSLTVisitor extends XPathVisitor
334c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson{
344c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	/**
354c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * Visit an XSLT instruction.  Any element that isn't called by one
364c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * of the other visit methods, will be called by this method.
374c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 *
384c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @param elem The xsl instruction element object.
394c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @return true if the sub expressions should be traversed.
404c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 */
414c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	public boolean visitInstruction(ElemTemplateElement elem)
424c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	{
434c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson		return true;
444c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	}
454c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
464c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	/**
474c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * Visit an XSLT stylesheet instruction.
484c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 *
494c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @param elem The xsl instruction element object.
504c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @return true if the sub expressions should be traversed.
514c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 */
524c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	public boolean visitStylesheet(ElemTemplateElement elem)
534c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	{
544c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson		return true;
554c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	}
564c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
574c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
584c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	/**
594c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * Visit an XSLT top-level instruction.
604c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 *
614c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @param elem The xsl instruction element object.
624c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @return true if the sub expressions should be traversed.
634c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 */
644c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	public boolean visitTopLevelInstruction(ElemTemplateElement elem)
654c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	{
664c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson		return true;
674c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	}
684c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
694c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	/**
704c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * Visit an XSLT top-level instruction.
714c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 *
724c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @param elem The xsl instruction element object.
734c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @return true if the sub expressions should be traversed.
744c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 */
754c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	public boolean visitTopLevelVariableOrParamDecl(ElemTemplateElement elem)
764c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	{
774c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson		return true;
784c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	}
794c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
804c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
814c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	/**
824c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * Visit an XSLT variable or parameter declaration.
834c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 *
844c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @param elem The xsl instruction element object.
854c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @return true if the sub expressions should be traversed.
864c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 */
874c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	public boolean visitVariableOrParamDecl(ElemVariable elem)
884c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	{
894c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson		return true;
904c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	}
914c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
924c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	/**
934c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * Visit a LiteralResultElement.
944c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 *
954c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @param elem The literal result object.
964c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @return true if the sub expressions should be traversed.
974c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 */
984c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	public boolean visitLiteralResultElement(ElemLiteralResult elem)
994c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	{
1004c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson		return true;
1014c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	}
1024c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
1034c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	/**
1044c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * Visit an Attribute Value Template (at the top level).
1054c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 *
1064c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @param elem The attribute value template object.
1074c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @return true if the sub expressions should be traversed.
1084c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 */
1094c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	public boolean visitAVT(AVT elem)
1104c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	{
1114c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson		return true;
1124c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	}
1134c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
1144c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
1154c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	/**
1164c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * Visit an extension element.
1174c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @param elem The extension object.
1184c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 * @return true if the sub expressions should be traversed.
1194c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	 */
1204c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	public boolean visitExtensionElement(ElemExtensionCall elem)
1214c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	{
1224c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson		return true;
1234c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson	}
1244c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
1254c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson}
1264c7a0d97cf2b27790e6236965a1d798d710d7ec7Jesse Wilson
127