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. 

  59. import java.util.Vector;

  60. 

  61. import org.apache.xml.dtm.DTM;

  62. 

  63. import javax.xml.transform.TransformerException;

  64. 

  65. import org.apache.xpath.*;

  66. import org.apache.xml.utils.QName;

  67. 

  68. import java.util.StringTokenizer;

  69. 

  70. import org.apache.xalan.transformer.TransformerImpl;

  71. 

  72. /**

  73.  * <meta name="usage" content="advanced"/>

  74.  * Implement xsl:use.

  75.  * This acts as a superclass for ElemCopy, ElemAttributeSet,

  76.  * ElemElement, and ElemLiteralResult, on order to implement

  77.  * shared behavior the use-attribute-sets attribute.

  78.  * @see <a href="http://www.w3.org/TR/xslt#attribute-sets">attribute-sets in XSLT Specification</a>

  79.  */

  80. public class ElemUse extends ElemTemplateElement

  81. {

  82. 

  83.   /**

  84.    * The value of the "use-attribute-sets" attribute.

  85.    * @serial

  86.    */

  87.   private QName m_attributeSetsNames[] = null;

  88. 

  89.   /**

  90.    * Set the "use-attribute-sets" attribute.

  91.    * Attribute sets are used by specifying a use-attribute-sets

  92.    * attribute on xsl:element, xsl:copy (see [7.5 Copying]) or

  93.    * xsl:attribute-set elements. The value of the use-attribute-sets

  94.    * attribute is a whitespace-separated list of names of attribute

  95.    * sets. Each name is specified as a QName, which is expanded as

  96.    * described in [2.4 Qualified Names].

  97.    *

  98.    * @param v The value to set for the "use-attribute-sets" attribute. 

  99.    */

  100.   public void setUseAttributeSets(Vector v)

  101.   {

  102. 

  103.     int n = v.size();

  104. 

  105.     m_attributeSetsNames = new QName[n];

  106. 

  107.     for (int i = 0; i < n; i++)

  108.     {

  109.       m_attributeSetsNames[i] = (QName) v.elementAt(i);

  110.     }

  111.   }

  112. 

  113.   /**

  114.    * Set the "use-attribute-sets" attribute.

  115.    * Attribute sets are used by specifying a use-attribute-sets

  116.    * attribute on xsl:element, xsl:copy (see [7.5 Copying]) or

  117.    * xsl:attribute-set elements. The value of the use-attribute-sets

  118.    * attribute is a whitespace-separated list of names of attribute

  119.    * sets. Each name is specified as a QName, which is expanded as

  120.    * described in [2.4 Qualified Names].

  121.    *

  122.    * @param v The value to set for the "use-attribute-sets" attribute. 

  123.    */

  124.   public void setUseAttributeSets(QName[] v)

  125.   {

  126.     m_attributeSetsNames = v;

  127.   }

  128. 

  129.   /**

  130.    * Get the "use-attribute-sets" attribute.

  131.    * Attribute sets are used by specifying a use-attribute-sets

  132.    * attribute on xsl:element, xsl:copy (see [7.5 Copying]) or

  133.    * xsl:attribute-set elements, or a xsl:use-attribute-sets attribute on

  134.    * Literal Result Elements.

  135.    * The value of the use-attribute-sets

  136.    * attribute is a whitespace-separated list of names of attribute

  137.    * sets. Each name is specified as a QName, which is expanded as

  138.    * described in [2.4 Qualified Names].

  139.    *

  140.    * @return The value of the "use-attribute-sets" attribute. 

  141.    */

  142.   public QName[] getUseAttributeSets()

  143.   {

  144.     return m_attributeSetsNames;

  145.   }

  146.   

  147.   /**

  148.    * Add the attributes from the named attribute sets to the attribute list.

  149.    * TODO: Error handling for: "It is an error if there are two attribute sets

  150.    * with the same expanded-name and with equal import precedence and that both

  151.    * contain the same attribute unless there is a definition of the attribute

  152.    * set with higher import precedence that also contains the attribute."

  153.    *

  154.    * @param transformer non-null reference to the the current transform-time state.

  155.    * @param stylesheet The owning root stylesheet

  156.    * @param attributeSetsNames List of attribute sets names to apply

  157.    * @param sourceNode non-null reference to the <a href="http://www.w3.org/TR/xslt#dt-current-node">current source node</a>.

  158.    * @param mode reference, which may be null, to the <a href="http://www.w3.org/TR/xslt#modes">current mode</a>.

  159.    *

  160.    * @throws TransformerException

  161.    */

  162.   public void applyAttrSets(

  163.           TransformerImpl transformer, StylesheetRoot stylesheet)

  164.             throws TransformerException

  165.   {

  166.     applyAttrSets(transformer, stylesheet, m_attributeSetsNames);

  167.   }

  168. 

  169.   /**

  170.    * Add the attributes from the named attribute sets to the attribute list.

  171.    * TODO: Error handling for: "It is an error if there are two attribute sets

  172.    * with the same expanded-name and with equal import precedence and that both

  173.    * contain the same attribute unless there is a definition of the attribute

  174.    * set with higher import precedence that also contains the attribute."

  175.    *

  176.    * @param transformer non-null reference to the the current transform-time state.

  177.    * @param stylesheet The owning root stylesheet

  178.    * @param attributeSetsNames List of attribute sets names to apply

  179.    * @param sourceNode non-null reference to the <a href="http://www.w3.org/TR/xslt#dt-current-node">current source node</a>.

  180.    * @param mode reference, which may be null, to the <a href="http://www.w3.org/TR/xslt#modes">current mode</a>.

  181.    *

  182.    * @throws TransformerException

  183.    */

  184.   private void applyAttrSets(

  185.           TransformerImpl transformer, StylesheetRoot stylesheet, QName attributeSetsNames[])

  186.             throws TransformerException

  187.   {

  188. 

  189.     if (null != attributeSetsNames)

  190.     {

  191.       int nNames = attributeSetsNames.length;

  192. 

  193.       for (int i = 0; i < nNames; i++)

  194.       {

  195.         QName qname = attributeSetsNames[i];

  196.         Vector attrSets = stylesheet.getAttributeSetComposed(qname);

  197. 

  198.         if (null != attrSets)

  199.         {

  200.           int nSets = attrSets.size();

  201. 

  202.           // Highest priority attribute set will be at the top,

  203.           // so process it last.

  204.           for (int k = nSets-1; k >= 0 ; k--)

  205.           {

  206.             ElemAttributeSet attrSet =

  207.               (ElemAttributeSet) attrSets.elementAt(k);

  208. 

  209.             attrSet.execute(transformer);

  210.           }

  211.         }

  212.       }

  213.     }

  214.   }

  215. 

  216.   /**

  217.    * Copy attributes specified by use-attribute-sets to the result tree.

  218.    * Specifying a use-attribute-sets attribute is equivalent to adding

  219.    * xsl:attribute elements for each of the attributes in each of the

  220.    * named attribute sets to the beginning of the content of the element

  221.    * with the use-attribute-sets attribute, in the same order in which

  222.    * the names of the attribute sets are specified in the use-attribute-sets

  223.    * attribute. It is an error if use of use-attribute-sets attributes

  224.    * on xsl:attribute-set elements causes an attribute set to directly

  225.    * or indirectly use itself.

  226.    *

  227.    * @param transformer non-null reference to the the current transform-time state.

  228.    * @param sourceNode non-null reference to the <a href="http://www.w3.org/TR/xslt#dt-current-node">current source node</a>.

  229.    * @param mode reference, which may be null, to the <a href="http://www.w3.org/TR/xslt#modes">current mode</a>.

  230.    *

  231.    * @throws TransformerException

  232.    */

  233.   public void execute(

  234.           TransformerImpl transformer)

  235.             throws TransformerException

  236.   {

  237.     if (TransformerImpl.S_DEBUG)

  238.       transformer.getTraceManager().fireTraceEvent(this);

  239. 

  240.     if (null != m_attributeSetsNames)

  241.     {

  242.       applyAttrSets(transformer, getStylesheetRoot(),

  243.                     m_attributeSetsNames);

  244.     }

  245.     

  246.     if (TransformerImpl.S_DEBUG)

  247. 	  transformer.getTraceManager().fireTraceEndEvent(this); 

  248.   }

  249. }