- /*
- * The Apache Software License, Version 1.1
- *
- *
- * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
- * reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Xerces" and "Apache Software Foundation" must
- * not be used to endorse or promote products derived from this
- * software without prior written permission. For written
- * permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * nor may "Apache" appear in their name, without prior written
- * permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation and was
- * originally based on software copyright (c) 1999, International
- * Business Machines, Inc., http://www.apache.org. For more
- * information on the Apache Software Foundation, please see
- * <http://www.apache.org/>.
- */
-
- package com.sun.org.apache.xerces.internal.dom;
-
-
- /**
- * Entity nodes hold the reference data for an XML Entity -- either
- * parsed or unparsed. The nodeName (inherited from Node) will contain
- * the name (if any) of the Entity. Its data will be contained in the
- * Entity's children, in exactly the structure which an
- * EntityReference to this name will present within the document's
- * body.
- * <P>
- * Note that this object models the actual entity, _not_ the entity
- * declaration or the entity reference.
- * <P>
- * An XML processor may choose to completely expand entities before
- * the structure model is passed to the DOM; in this case, there will
- * be no EntityReferences in the DOM tree.
- * <P>
- * Quoting the 10/01 DOM Proposal,
- * <BLOCKQUOTE>
- * "The DOM Level 1 does not support editing Entity nodes; if a user
- * wants to make changes to the contents of an Entity, every related
- * EntityReference node has to be replaced in the structure model by
- * a clone of the Entity's contents, and then the desired changes
- * must be made to each of those clones instead. All the
- * descendants of an Entity node are readonly."
- * </BLOCKQUOTE>
- * I'm interpreting this as: It is the parser's responsibilty to call
- * the non-DOM operation setReadOnly(true,true) after it constructs
- * the Entity. Since the DOM explicitly decided not to deal with this,
- * _any_ answer will involve a non-DOM operation, and this is the
- * simplest solution.
- *
- *
- * @version $Id: DeferredEntityImpl.java,v 1.17 2003/11/13 22:47:15 elena Exp $
- * @since PR-DOM-Level-1-19980818.
- */
- public class DeferredEntityImpl
- extends EntityImpl
- implements DeferredNode {
-
- //
- // Constants
- //
-
- /** Serialization version. */
- static final long serialVersionUID = 4760180431078941638L;
-
- //
- // Data
- //
-
- /** Node index. */
- protected transient int fNodeIndex;
-
- //
- // Constructors
- //
-
- /**
- * This is the deferred constructor. Only the fNodeIndex is given here.
- * All other data, can be requested from the ownerDocument via the index.
- */
- DeferredEntityImpl(DeferredDocumentImpl ownerDocument, int nodeIndex) {
- super(ownerDocument, null);
-
- fNodeIndex = nodeIndex;
- needsSyncData(true);
- needsSyncChildren(true);
-
- } // <init>(DeferredDocumentImpl,int)
-
- //
- // DeferredNode methods
- //
-
- /** Returns the node index. */
- public int getNodeIndex() {
- return fNodeIndex;
- }
-
- //
- // Protected methods
- //
-
- /**
- * Synchronize the entity data. This is special because of the way
- * that the "fast" version stores the information.
- */
- protected void synchronizeData() {
-
- // no need to sychronize again
- needsSyncData(false);
-
- // get the node data
- DeferredDocumentImpl ownerDocument =
- (DeferredDocumentImpl)this.ownerDocument;
- name = ownerDocument.getNodeName(fNodeIndex);
-
- // get the entity data
- publicId = ownerDocument.getNodeValue(fNodeIndex);
- systemId = ownerDocument.getNodeURI(fNodeIndex);
- int extraDataIndex = ownerDocument.getNodeExtra(fNodeIndex);
- ownerDocument.getNodeType(extraDataIndex);
-
- notationName = ownerDocument.getNodeName(extraDataIndex);
-
- // encoding and version DOM L3
- version = ownerDocument.getNodeValue(extraDataIndex);
- encoding = ownerDocument.getNodeURI(extraDataIndex);
-
- // baseURI, actualEncoding DOM L3
- int extraIndex2 = ownerDocument.getNodeExtra(extraDataIndex);
- baseURI = ownerDocument.getNodeName(extraIndex2);
- inputEncoding = ownerDocument.getNodeValue(extraIndex2);
-
- } // synchronizeData()
-
- /** Synchronize the children. */
- protected void synchronizeChildren() {
-
- // no need to synchronize again
- needsSyncChildren(false);
-
- isReadOnly(false);
- DeferredDocumentImpl ownerDocument =
- (DeferredDocumentImpl) ownerDocument();
- ownerDocument.synchronizeChildren(this, fNodeIndex);
- setReadOnly(true, true);
-
- } // synchronizeChildren()
-
- } // class DeferredEntityImpl