IndexedDocumentFactory xref

View Javadoc

    1   /*
    2    * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
    3    *
    4    * This software is open source.
    5    * See the bottom of this file for the licence.
    6    */
    7
    8   package org.dom4j.util;
    9
    10  import org.dom4j.DocumentFactory;
    11  import org.dom4j.Element;
    12  import org.dom4j.QName;
    13
    14  /***
    15   * <p>
    16   * <code>IndexedDocumentFactory</code> is a factory of XML objects which
    17   * create indexed Element implementations to allow quicker lookup via name of
    18   * Element and Attributes though at the expense of more memory used to create
    19   * the name indexes.
    20   * </p>
    21   *
    22   * @author <a href="mailto:jstrachan@apache.org">James Strachan </a>
    23   * @version $Revision: 1.9 $
    24   */
    25  public class IndexedDocumentFactory extends DocumentFactory {
    26      /*** The Singleton instance */
    27      protected static transient IndexedDocumentFactory singleton
    28              = new IndexedDocumentFactory();
    29
    30      /***
    31       * <p>
    32       * Access to the singleton instance of this factory.
    33       * </p>
    34       *
    35       * @return the default singleon instance
    36       */
    37      public static DocumentFactory getInstance() {
    38          return singleton;
    39      }
    40
    41      // DocumentFactory methods
    42      // -------------------------------------------------------------------------
    43      public Element createElement(QName qname) {
    44          return new IndexedElement(qname);
    45      }
    46
    47      public Element createElement(QName qname, int attributeCount) {
    48          return new IndexedElement(qname, attributeCount);
    49      }
    50  }
    51
    52  /*
    53   * Redistribution and use of this software and associated documentation
    54   * ("Software"), with or without modification, are permitted provided that the
    55   * following conditions are met:
    56   *
    57   * 1. Redistributions of source code must retain copyright statements and
    58   * notices. Redistributions must also contain a copy of this document.
    59   *
    60   * 2. Redistributions in binary form must reproduce the above copyright notice,
    61   * this list of conditions and the following disclaimer in the documentation
    62   * and/or other materials provided with the distribution.
    63   *
    64   * 3. The name "DOM4J" must not be used to endorse or promote products derived
    65   * from this Software without prior written permission of MetaStuff, Ltd. For
    66   * written permission, please contact dom4j-info@metastuff.com.
    67   *
    68   * 4. Products derived from this Software may not be called "DOM4J" nor may
    69   * "DOM4J" appear in their names without prior written permission of MetaStuff,
    70   * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
    71   *
    72   * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
    73   *
    74   * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
    75   * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    76   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    77   * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
    78   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    79   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    80   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    81   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    82   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    83   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    84   * POSSIBILITY OF SUCH DAMAGE.
    85   *
    86   * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
    87   */