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.xml.utils;

  58. 

  59. 

  60. /**

  61.  * The standard SAX implementation of LocatorImpl is not serializable,

  62.  * limiting its utility as "a persistent snapshot of a locator".

  63.  * This is a quick hack to make it so. Note that it makes more sense

  64.  * in many cases to set up fields to hold this data rather than pointing

  65.  * at another object... but that decision should be made on architectural

  66.  * grounds rather than serializability.

  67.  *<p>

  68.  * It isn't clear whether subclassing LocatorImpl and adding serialization

  69.  * methods makes more sense than copying it and just adding Serializable

  70.  * to its interface. Since it's so simple, I've taken the latter approach

  71.  * for now.

  72.  *

  73.  * @see org.xml.sax.helpers.LocatorImpl

  74.  * @see org.xml.sax.Locator Locator

  75.  * @since XalanJ2

  76.  * @author Joe Kesselman

  77.  * @version 1.0

  78.  */

  79. public class SerializableLocatorImpl

  80. implements org.xml.sax.Locator, java.io.Serializable

  81. 

  82. {

  83.     /**

  84.      * Zero-argument constructor.

  85.      *

  86.      * <p>SAX says "This will not normally be useful, since the main purpose

  87.      * of this class is to make a snapshot of an existing Locator." In fact,

  88.      * it _is_ sometimes useful when you want to construct a new Locator

  89.      * pointing to a specific location... which, after all, is why the

  90.      * setter methods are provided.

  91.      * </p>

  92.      */

  93.     public SerializableLocatorImpl ()

  94.     {

  95.     }

  96.     

  97.     

  98.     /**

  99.      * Copy constructor.

  100.      *

  101.      * <p>Create a persistent copy of the current state of a locator.

  102.      * When the original locator changes, this copy will still keep

  103.      * the original values (and it can be used outside the scope of

  104.      * DocumentHandler methods).</p>

  105.      *

  106.      * @param locator The locator to copy.

  107.      */

  108.     public SerializableLocatorImpl (org.xml.sax.Locator locator)

  109.     {

  110.         setPublicId(locator.getPublicId());

  111.         setSystemId(locator.getSystemId());

  112.         setLineNumber(locator.getLineNumber());

  113.         setColumnNumber(locator.getColumnNumber());

  114.     }

  115.     

  116.     

  117.     ////////////////////////////////////////////////////////////////////

  118.     // Implementation of org.xml.sax.Locator

  119.     ////////////////////////////////////////////////////////////////////

  120.     

  121.     

  122.     /**

  123.      * Return the saved public identifier.

  124.      *

  125.      * @return The public identifier as a string, or null if none

  126.      *         is available.

  127.      * @see org.xml.sax.Locator#getPublicId

  128.      * @see #setPublicId

  129.      */

  130.     public String getPublicId ()

  131.     {

  132.         return publicId;

  133.     }

  134.     

  135.     

  136.     /**

  137.      * Return the saved system identifier.

  138.      *

  139.      * @return The system identifier as a string, or null if none

  140.      *         is available.

  141.      * @see org.xml.sax.Locator#getSystemId

  142.      * @see #setSystemId

  143.      */

  144.     public String getSystemId ()

  145.     {

  146.         return systemId;

  147.     }

  148.     

  149.     

  150.     /**

  151.      * Return the saved line number (1-based).

  152.      *

  153.      * @return The line number as an integer, or -1 if none is available.

  154.      * @see org.xml.sax.Locator#getLineNumber

  155.      * @see #setLineNumber

  156.      */

  157.     public int getLineNumber ()

  158.     {

  159.         return lineNumber;

  160.     }

  161.     

  162.     

  163.     /**

  164.      * Return the saved column number (1-based).

  165.      *

  166.      * @return The column number as an integer, or -1 if none is available.

  167.      * @see org.xml.sax.Locator#getColumnNumber

  168.      * @see #setColumnNumber

  169.      */

  170.     public int getColumnNumber ()

  171.     {

  172.         return columnNumber;

  173.     }

  174.     

  175.     

  176.     ////////////////////////////////////////////////////////////////////

  177.     // Setters for the properties (not in org.xml.sax.Locator)

  178.     ////////////////////////////////////////////////////////////////////

  179.     

  180.     

  181.     /**

  182.      * Set the public identifier for this locator.

  183.      *

  184.      * @param publicId The new public identifier, or null 

  185.      *        if none is available.

  186.      * @see #getPublicId

  187.      */

  188.     public void setPublicId (String publicId)

  189.     {

  190.         this.publicId = publicId;

  191.     }

  192.     

  193.     

  194.     /**

  195.      * Set the system identifier for this locator.

  196.      *

  197.      * @param systemId The new system identifier, or null 

  198.      *        if none is available.

  199.      * @see #getSystemId

  200.      */

  201.     public void setSystemId (String systemId)

  202.     {

  203.         this.systemId = systemId;

  204.     }

  205.     

  206.     

  207.     /**

  208.      * Set the line number for this locator (1-based).

  209.      *

  210.      * @param lineNumber The line number, or -1 if none is available.

  211.      * @see #getLineNumber

  212.      */

  213.     public void setLineNumber (int lineNumber)

  214.     {

  215.         this.lineNumber = lineNumber;

  216.     }

  217.     

  218.     

  219.     /**

  220.      * Set the column number for this locator (1-based).

  221.      *

  222.      * @param columnNumber The column number, or -1 if none is available.

  223.      * @see #getColumnNumber

  224.      */

  225.     public void setColumnNumber (int columnNumber)

  226.     {

  227.         this.columnNumber = columnNumber;

  228.     }

  229.     

  230.     

  231.     ////////////////////////////////////////////////////////////////////

  232.     // Internal state.

  233.     ////////////////////////////////////////////////////////////////////

  234.     

  235.     /**

  236.      * The public ID.

  237.      * @serial

  238.      */

  239.     private String publicId;

  240.     

  241.     /**

  242.      * The system ID.

  243.      * @serial

  244.      */

  245.     private String systemId;

  246.     

  247.     /**

  248.      * The line number.

  249.      * @serial

  250.      */

  251.     private int lineNumber;

  252.     

  253.     /**

  254.      * The column number.

  255.      * @serial

  256.      */

  257.     private int columnNumber;

  258.     

  259. }

  260. 

  261. // end of LocatorImpl.java