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 Ovidiu

  51.  * Predescu <ovidiu@cup.hp.com> on behalf of the Apache Software

  52.  * Foundation and was originally developed at Hewlett Packard Company.

  53.  * For more information on the Apache Software Foundation, please see

  54.  * <http://www.apache.org/>.

  55.  */

  56. 

  57. package org.apache.xalan.lib;

  58. 

  59. import org.apache.xml.dtm.ref.DTMNodeProxy;

  60. import org.apache.xalan.extensions.ExpressionContext;

  61. 

  62. import javax.xml.transform.SourceLocator;

  63. 

  64. import org.w3c.dom.Node;

  65. import org.w3c.dom.NodeList;

  66. 

  67. /**

  68.  * <code>NodeInfo</code> defines a set of XSLT extension functions to be

  69.  * used from stylesheets.

  70.  *

  71.  * @author <a href="mailto:ovidiu@cup.hp.com">Ovidiu Predescu</a>

  72.  * @since May 24, 2001

  73.  */

  74. public class NodeInfo

  75. {

  76.   /**

  77.    * <code>systemId</code> returns the system id of the current

  78.    * context node.

  79.    *

  80.    * @param context an <code>ExpressionContext</code> value

  81.    * @return a <code>String</code> value

  82.    */

  83.   public static String systemId(ExpressionContext context)

  84.   {

  85.     Node contextNode = context.getContextNode();

  86.     int nodeHandler = ((DTMNodeProxy)contextNode).getDTMNodeNumber();

  87.     SourceLocator locator = ((DTMNodeProxy)contextNode).getDTM()

  88.       .getSourceLocatorFor(nodeHandler);

  89. 

  90.     if (locator != null)

  91.       return locator.getSystemId();

  92.     else

  93.       return null;

  94.   }

  95. 

  96.   /**

  97.    * <code>systemId</code> returns the system id of the node passed as

  98.    * argument. If a node set is passed as argument, the system id of

  99.    * the first node in the set is returned.

  100.    *

  101.    * @param context an <code>ExpressionContext</code> value

  102.    * @param nodeList a <code>NodeList</code> value

  103.    * @return a <code>String</code> value

  104.    */

  105.   public static String systemId(NodeList nodeList)

  106.   {

  107.     if (nodeList == null || nodeList.getLength() == 0)

  108.       return null;

  109.     

  110.     Node node = nodeList.item(0);

  111.     int nodeHandler = ((DTMNodeProxy)node).getDTMNodeNumber();

  112.     SourceLocator locator = ((DTMNodeProxy)node).getDTM()

  113.       .getSourceLocatorFor(nodeHandler);

  114. 

  115.     if (locator != null)

  116.       return locator.getSystemId();

  117.     else

  118.       return null;

  119.   }

  120. 

  121.   /**

  122.    * <code>publicId</code> returns the public identifier of the current

  123.    * context node.

  124.    * 

  125.    * Xalan does not currently record this value, and will return null.

  126.    *

  127.    * @param context an <code>ExpressionContext</code> value

  128.    * @return a <code>String</code> value

  129.    */

  130.   public static String publicId(ExpressionContext context)

  131.   {

  132.     Node contextNode = context.getContextNode();

  133.     int nodeHandler = ((DTMNodeProxy)contextNode).getDTMNodeNumber();

  134.     SourceLocator locator = ((DTMNodeProxy)contextNode).getDTM()

  135.       .getSourceLocatorFor(nodeHandler);

  136. 

  137.     if (locator != null)

  138.       return locator.getPublicId();

  139.     else

  140.       return null;

  141.   }

  142. 

  143.   /**

  144.    * <code>publicId</code> returns the public identifier of the node passed as

  145.    * argument. If a node set is passed as argument, the public identifier of

  146.    * the first node in the set is returned.

  147.    * 

  148.    * Xalan does not currently record this value, and will return null.

  149.    *

  150.    * @param nodeList a <code>NodeList</code> value

  151.    * @return a <code>String</code> value

  152.    */

  153.   public static String publicId(NodeList nodeList)

  154.   {

  155.     if (nodeList == null || nodeList.getLength() == 0)

  156.       return null;

  157.     

  158.     Node node = nodeList.item(0);

  159.     int nodeHandler = ((DTMNodeProxy)node).getDTMNodeNumber();

  160.     SourceLocator locator = ((DTMNodeProxy)node).getDTM()

  161.       .getSourceLocatorFor(nodeHandler);

  162. 

  163.     if (locator != null)

  164.       return locator.getPublicId();

  165.     else

  166.       return null;

  167.   }

  168. 

  169.   /**

  170.    * <code>lineNumber</code> returns the line number of the current

  171.    * context node.

  172.    * 

  173.    * NOTE: Xalan does not normally record location information for each node. 

  174.    * To obtain it, you must set the custom TrAX attribute 

  175.    * "http://xml.apache.org/xalan/features/source_location"

  176.    * true in the TransformerFactory before generating the Transformer and executing

  177.    * the stylesheet. Storage cost per node will be noticably increased in this mode.

  178.    *

  179.    * @param context an <code>ExpressionContext</code> value

  180.    * @return an <code>int</code> value. This may be -1 to indicate that the

  181.    * line number is not known.

  182.    */

  183.   public static int lineNumber(ExpressionContext context)

  184.   {

  185.     Node contextNode = context.getContextNode();

  186.     int nodeHandler = ((DTMNodeProxy)contextNode).getDTMNodeNumber();

  187.     SourceLocator locator = ((DTMNodeProxy)contextNode).getDTM()

  188.       .getSourceLocatorFor(nodeHandler);

  189. 

  190.     if (locator != null)

  191.       return locator.getLineNumber();

  192.     else

  193.       return -1;

  194.   }

  195. 

  196.   /**

  197.    * <code>lineNumber</code> returns the line number of the node

  198.    * passed as argument. If a node set is passed as argument, the line

  199.    * number of the first node in the set is returned.

  200.    *

  201.    * NOTE: Xalan does not normally record location information for each node. 

  202.    * To obtain it, you must set the custom TrAX attribute 

  203.    * "http://xml.apache.org/xalan/features/source_location"

  204.    * true in the TransformerFactory before generating the Transformer and executing

  205.    * the stylesheet. Storage cost per node will be noticably increased in this mode.

  206.    *

  207.    * @param nodeList a <code>NodeList</code> value

  208.    * @return an <code>int</code> value. This may be -1 to indicate that the

  209.    * line number is not known.

  210.    */

  211.   public static int lineNumber(NodeList nodeList)

  212.   {

  213.     if (nodeList == null || nodeList.getLength() == 0)

  214.       return -1;

  215.     

  216.     Node node = nodeList.item(0);

  217.     int nodeHandler = ((DTMNodeProxy)node).getDTMNodeNumber();

  218.     SourceLocator locator = ((DTMNodeProxy)node).getDTM()

  219.       .getSourceLocatorFor(nodeHandler);

  220. 

  221.     if (locator != null)

  222.       return locator.getLineNumber();

  223.     else

  224.       return -1;

  225.   }

  226. 

  227.   /**

  228.    * <code>columnNumber</code> returns the column number of the

  229.    * current context node.

  230.    *

  231.    * NOTE: Xalan does not normally record location information for each node. 

  232.    * To obtain it, you must set the custom TrAX attribute 

  233.    * "http://xml.apache.org/xalan/features/source_location"

  234.    * true in the TransformerFactory before generating the Transformer and executing

  235.    * the stylesheet. Storage cost per node will be noticably increased in this mode.

  236.    *

  237.    * @param context an <code>ExpressionContext</code> value

  238.    * @return an <code>int</code> value. This may be -1 to indicate that the

  239.    * column number is not known.

  240.    */

  241.   public static int columnNumber(ExpressionContext context)

  242.   {

  243.     Node contextNode = context.getContextNode();

  244.     int nodeHandler = ((DTMNodeProxy)contextNode).getDTMNodeNumber();

  245.     SourceLocator locator = ((DTMNodeProxy)contextNode).getDTM()

  246.       .getSourceLocatorFor(nodeHandler);

  247. 

  248.     if (locator != null)

  249.       return locator.getColumnNumber();

  250.     else

  251.       return -1;

  252.   }

  253. 

  254.   /**

  255.    * <code>columnNumber</code> returns the column number of the node

  256.    * passed as argument. If a node set is passed as argument, the line

  257.    * number of the first node in the set is returned.

  258.    *

  259.    * NOTE: Xalan does not normally record location information for each node. 

  260.    * To obtain it, you must set the custom TrAX attribute 

  261.    * "http://xml.apache.org/xalan/features/source_location"

  262.    * true in the TransformerFactory before generating the Transformer and executing

  263.    * the stylesheet. Storage cost per node will be noticably increased in this mode.

  264.    *

  265.    * @param nodeList a <code>NodeList</code> value

  266.    * @return an <code>int</code> value. This may be -1 to indicate that the

  267.    * column number is not known.

  268.    */

  269.   public static int columnNumber(NodeList nodeList)

  270.   {

  271.     if (nodeList == null || nodeList.getLength() == 0)

  272.       return -1;

  273.     

  274.     Node node = nodeList.item(0);

  275.     int nodeHandler = ((DTMNodeProxy)node).getDTMNodeNumber();

  276.     SourceLocator locator = ((DTMNodeProxy)node).getDTM()

  277.       .getSourceLocatorFor(nodeHandler);

  278. 

  279.     if (locator != null)

  280.       return locator.getColumnNumber();

  281.     else

  282.       return -1;

  283.   }

  284. }