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.templates;
  58. //import org.w3c.dom.*;
  59. import org.apache.xml.dtm.DTM;
  60. import org.apache.xpath.XPathContext;
  61. import org.apache.xml.utils.FastStringBuffer;
  62. /**
  63. * <meta name="usage" content="internal"/>
  64. * Class to hold a part, either a string or XPath,
  65. * of an Attribute Value Template.
  66. */
  67. public abstract class AVTPart implements java.io.Serializable, XSLTVisitable
  68. {
  69. /**
  70. * Construct a part.
  71. */
  72. public AVTPart(){}
  73. /**
  74. * Get the AVT part as the original string.
  75. *
  76. * @return the AVT part as the original string.
  77. */
  78. public abstract String getSimpleString();
  79. /**
  80. * Write the evaluated value into the given
  81. * string buffer.
  82. *
  83. * @param xctxt The XPath context to use to evaluate this AVT.
  84. * @param buf Buffer to write into.
  85. * @param context The current source tree context.
  86. * @param nsNode The current namespace context (stylesheet tree context).
  87. * @param NodeList The current Context Node List.
  88. *
  89. * @throws javax.xml.transform.TransformerException
  90. */
  91. public abstract void evaluate(
  92. XPathContext xctxt, FastStringBuffer buf, int context,
  93. org.apache.xml.utils.PrefixResolver nsNode)
  94. throws javax.xml.transform.TransformerException;
  95. /**
  96. * Set the XPath support.
  97. *
  98. * @param support XPathContext to set.
  99. */
  100. public void setXPathSupport(XPathContext support){}
  101. /**
  102. * Tell if this expression or it's subexpressions can traverse outside
  103. * the current subtree.
  104. *
  105. * @return true if traversal outside the context node's subtree can occur.
  106. */
  107. public boolean canTraverseOutsideSubtree()
  108. {
  109. return false;
  110. }
  111. /**
  112. * This function is used to fixup variables from QNames to stack frame
  113. * indexes at stylesheet build time.
  114. * @param vars List of QNames that correspond to variables. This list
  115. * should be searched backwards for the first qualified name that
  116. * corresponds to the variable reference qname. The position of the
  117. * QName in the vector from the start of the vector will be its position
  118. * in the stack frame (but variables above the globalsTop value will need
  119. * to be offset to the current stack frame).
  120. */
  121. public abstract void fixupVariables(java.util.Vector vars, int globalsSize);
  122. }