org.enhydra.apache.xerces.dom.EntityImpl Maven / Gradle / Ivy
The newest version!
/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999 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 [email protected].
*
* 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
*
* Note that this object models the actual entity, _not_ the entity
* declaration or the entity reference.
*
* 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.
*
* Quoting the 10/01 DOM Proposal,
*
* "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."
*
* 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
* @since PR-DOM-Level-1-19980818.
*/
public class EntityImpl
extends ParentNode
implements Entity {
//
// Constants
//
/** Serialization version. */
static final long serialVersionUID = -3575760943444303423L;
//
// Data
//
/** Entity name. */
protected String name;
/** Public identifier. */
protected String publicId;
/** System identifier. */
protected String systemId;
/** Encoding */
protected String encoding;
/** Version */
protected String version;
/** Notation name. */
protected String notationName;
//
// Constructors
//
/** Factory constructor. */
public EntityImpl(CoreDocumentImpl ownerDoc, String name) {
super(ownerDoc);
this.name = name;
isReadOnly(true);
}
//
// Node methods
//
/**
* A short integer indicating what type of node this is. The named
* constants for this value are defined in the org.w3c.dom.Node interface.
*/
public short getNodeType() {
return Node.ENTITY_NODE;
}
/**
* Returns the entity name
*/
public String getNodeName() {
if (needsSyncData()) {
synchronizeData();
}
return name;
}
/** Clone node. */
public Node cloneNode(boolean deep) {
EntityImpl newentity = (EntityImpl)super.cloneNode(deep);
return newentity;
}
//
// Entity methods
//
/**
* The public identifier associated with the entity. If not specified,
* this will be null.
*/
public String getPublicId() {
if (needsSyncData()) {
synchronizeData();
}
return publicId;
} // getPublicId():String
/**
* The system identifier associated with the entity. If not specified,
* this will be null.
*/
public String getSystemId() {
if (needsSyncData()) {
synchronizeData();
}
return systemId;
} // getSystemId():String
/**
* DOM Level 3 WD - experimental
* the version number of this entity, when it is an external parsed entity.
*/
public String getVersion() {
if (needsSyncData()) {
synchronizeData();
}
return version;
} // getVersion():String
/**
* DOM Level 3 WD - experimental
* the encoding of this entity, when it is an external parsed entity.
*/
public String getEncoding() {
if (needsSyncData()) {
synchronizeData();
}
return encoding;
} // getVersion():String
/**
* Unparsed entities -- which contain non-XML data -- have a
* "notation name" which tells applications how to deal with them.
* Parsed entities, which are in XML format, don't need this and
* set it to null.
*/
public String getNotationName() {
if (needsSyncData()) {
synchronizeData();
}
return notationName;
} // getNotationName():String
//
// Public methods
//
/**
* DOM Level 2: The public identifier associated with the entity. If not specified,
* this will be null. */
public void setPublicId(String id) {
if (needsSyncData()) {
synchronizeData();
}
publicId = id;
} // setPublicId(String)
/**
* DOM Level 3 WD - experimental
* encoding - An attribute specifying, as part of the text declaration,
* the encoding of this entity, when it is an external parsed entity.
* This is null otherwise
*/
public void setEncoding(String value) {
if (needsSyncData()) {
synchronizeData();
}
encoding = value;
} // setEncoding (String)
/**
* DOM Level 3 WD - experimental
* version - An attribute specifying, as part of the text declaration,
* the version number of this entity, when it is an external parsed entity.
* This is null otherwise
*/
public void setVersion(String value) {
if (needsSyncData()) {
synchronizeData();
}
version = value;
} // setVersion (String)
/**
* DOM Level 2: The system identifier associated with the entity. If not
* specified, this will be null.
*/
public void setSystemId(String id) {
if (needsSyncData()) {
synchronizeData();
}
systemId = id;
} // setSystemId(String)
/**
* DOM Level 2: Unparsed entities -- which contain non-XML data -- have a
* "notation name" which tells applications how to deal with them.
* Parsed entities, which are in XML format, don't need this and
* set it to null.
*/
public void setNotationName(String name) {
if (needsSyncData()) {
synchronizeData();
}
notationName = name;
} // setNotationName(String)
/* (non-Javadoc)
* @see org.w3c.dom.Entity#getInputEncoding()
*/
public String getInputEncoding() {
// TODO Auto-generated method stub
return null;
}
/* (non-Javadoc)
* @see org.w3c.dom.Entity#getXmlEncoding()
*/
public String getXmlEncoding() {
// TODO Auto-generated method stub
return null;
}
/* (non-Javadoc)
* @see org.w3c.dom.Entity#getXmlVersion()
*/
public String getXmlVersion() {
// TODO Auto-generated method stub
return null;
}
} // class EntityImpl