1. /*
  2. * The Apache Software License, Version 1.1
  3. *
  4. *
  5. * Copyright (c) 1999 The Apache Software Foundation. All rights
  6. * reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. *
  12. * 1. Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. *
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in
  17. * the documentation and/or other materials provided with the
  18. * distribution.
  19. *
  20. * 3. The end-user documentation included with the redistribution,
  21. * if any, must include the following acknowledgment:
  22. * "This product includes software developed by the
  23. * Apache Software Foundation (http://www.apache.org/)."
  24. * Alternately, this acknowledgment may appear in the software itself,
  25. * if and wherever such third-party acknowledgments normally appear.
  26. *
  27. * 4. The names "Xalan" and "Apache Software Foundation" must
  28. * not be used to endorse or promote products derived from this
  29. * software without prior written permission. For written
  30. * permission, please contact apache@apache.org.
  31. *
  32. * 5. Products derived from this software may not be called "Apache",
  33. * nor may "Apache" appear in their name, without prior written
  34. * permission of the Apache Software Foundation.
  35. *
  36. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  37. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  38. * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  39. * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  40. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  41. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  42. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  43. * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  44. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  45. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  46. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  47. * SUCH DAMAGE.
  48. * ====================================================================
  49. *
  50. * This software consists of voluntary contributions made by many
  51. * individuals on behalf of the Apache Software Foundation and was
  52. * originally based on software copyright (c) 1999, Lotus
  53. * Development Corporation., http://www.lotus.com. For more
  54. * information on the Apache Software Foundation, please see
  55. * <http://www.apache.org/>.
  56. */
  57. package org.apache.xalan.transformer;
  58. import org.apache.xalan.templates.ElemTemplate;
  59. import org.apache.xalan.templates.ElemTemplateElement;
  60. import org.w3c.dom.Node;
  61. import org.w3c.dom.traversal.NodeIterator;
  62. import javax.xml.transform.Transformer;
  63. /**
  64. * This interface is meant to be used by a consumer of
  65. * SAX2 events produced by Xalan, and enables the consumer
  66. * to get information about the state of the transform. It
  67. * is primarily intended as a tooling interface. A content
  68. * handler can get a reference to a TransformState by implementing
  69. * the TransformerClient interface. Xalan will check for
  70. * that interface before it calls startDocument, and, if it
  71. * is implemented, pass in a TransformState reference to the
  72. * setTransformState method.
  73. *
  74. * <p>Note that the current stylesheet and root stylesheet can
  75. * be retrieved from the ElemTemplateElement obtained from
  76. * either getCurrentElement() or getCurrentTemplate().</p>
  77. */
  78. public interface TransformState
  79. {
  80. /**
  81. * Retrieves the stylesheet element that produced
  82. * the SAX event.
  83. *
  84. * <p>Please note that the ElemTemplateElement returned may
  85. * be in a default template, and thus may not be
  86. * defined in the stylesheet.</p>
  87. *
  88. * @return the stylesheet element that produced the SAX event.
  89. */
  90. ElemTemplateElement getCurrentElement();
  91. /**
  92. * This method retrieves the current context node
  93. * in the source tree.
  94. *
  95. * @return the current context node in the source tree.
  96. */
  97. Node getCurrentNode();
  98. /**
  99. * This method retrieves the xsl:template
  100. * that is in effect, which may be a matched template
  101. * or a named template.
  102. *
  103. * <p>Please note that the ElemTemplate returned may
  104. * be a default template, and thus may not have a template
  105. * defined in the stylesheet.</p>
  106. *
  107. * @return the xsl:template that is in effect
  108. */
  109. ElemTemplate getCurrentTemplate();
  110. /**
  111. * This method retrieves the xsl:template
  112. * that was matched. Note that this may not be
  113. * the same thing as the current template (which
  114. * may be from getCurrentElement()), since a named
  115. * template may be in effect.
  116. *
  117. * <p>Please note that the ElemTemplate returned may
  118. * be a default template, and thus may not have a template
  119. * defined in the stylesheet.</p>
  120. *
  121. * @return the xsl:template that was matched.
  122. */
  123. ElemTemplate getMatchedTemplate();
  124. /**
  125. * Retrieves the node in the source tree that matched
  126. * the template obtained via getMatchedTemplate().
  127. *
  128. * @return the node in the source tree that matched
  129. * the template obtained via getMatchedTemplate().
  130. */
  131. Node getMatchedNode();
  132. /**
  133. * Get the current context node list.
  134. *
  135. * @return the current context node list.
  136. */
  137. NodeIterator getContextNodeList();
  138. /**
  139. * Get the TrAX Transformer object in effect.
  140. *
  141. * @return the TrAX Transformer object in effect.
  142. */
  143. Transformer getTransformer();
  144. }