/*

   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

 */
package org.apache.batik.dom;

import org.w3c.dom.DOMException;
import org.w3c.dom.Entity;
import org.w3c.dom.Node;

This class implements the Entity interface. 
Author:
Stephane Hillion
Version:
$Id: AbstractEntity.java 1802297 2017-07-18 13:58:12Z ssteiner $/**
 * This class implements the {@link org.w3c.dom.Entity} interface.
 *
 * @author <a href="mailto:stephane@hillion.org">Stephane Hillion</a>
 * @version $Id: AbstractEntity.java 1802297 2017-07-18 13:58:12Z ssteiner $
 */
public abstract class AbstractEntity
    extends    AbstractParentNode
    implements Entity {

    
The node name.
/**
     * The node name.
     */
    protected String nodeName;

    
The public id.
/**
     * The public id.
     */
    protected String publicId;

    
The system id.
/**
     * The system id.
     */
    protected String systemId;

    
DOM: Implements Node.getNodeType(). 
Returns:
Node.ENTITY_NODE/**
     * <b>DOM</b>: Implements {@link org.w3c.dom.Node#getNodeType()}.
     * @return {@link org.w3c.dom.Node#ENTITY_NODE}
     */
    public short getNodeType() {
        return ENTITY_NODE;
    }

    
Sets the name of this node.
/**
     * Sets the name of this node.
     */
    public void setNodeName(String v) {
        nodeName = v;
    }

    
DOM: Implements Node.getNodeName(). 
Returns:
nodeName./**
     * <b>DOM</b>: Implements {@link org.w3c.dom.Node#getNodeName()}.
     * @return {@link #nodeName}.
     */
    public String getNodeName() {
        return nodeName;
    }

    
DOM: Implements Entity.getPublicId(). 
Returns:
publicId./**
     * <b>DOM</b>: Implements {@link org.w3c.dom.Entity#getPublicId()}.
     * @return {@link #publicId}.
     */
    public String getPublicId() {
        return publicId;
    }

    
Sets the public id.
/**
     * Sets the public id.
     */
    public void setPublicId(String id) {
        publicId = id;
    }

    
DOM: Implements Entity.getSystemId(). 
Returns:
systemId./**
     * <b>DOM</b>: Implements {@link org.w3c.dom.Entity#getSystemId()}.
     * @return {@link #systemId}.
     */
    public String getSystemId() {
        return systemId;
    }

    
Sets the system id.
/**
     * Sets the system id.
     */
    public void setSystemId(String id) {
        systemId = id;
    }

    
DOM: Implements Entity.getNotationName(). 
Returns:
getNodeName()./**
     * <b>DOM</b>: Implements {@link org.w3c.dom.Entity#getNotationName()}.
     * @return {@link #getNodeName()}.
     */
    public String getNotationName() {
        return getNodeName();
    }

    
Sets the notation name.
/**
     * Sets the notation name.
     */
    public void setNotationName(String name) {
        setNodeName(name);
    }

    
DOM: Implements Entity.getInputEncoding(). /**
     * <b>DOM</b>: Implements {@link org.w3c.dom.Entity#getInputEncoding()}.
     */
    public String getInputEncoding() {
        return null;
    }

    
DOM: Implements Entity.getXmlEncoding(). /**
     * <b>DOM</b>: Implements {@link org.w3c.dom.Entity#getXmlEncoding()}.
     */
    public String getXmlEncoding() {
        return null;
    }

    
DOM: Implements Entity.getXmlVersion(). /**
     * <b>DOM</b>: Implements {@link org.w3c.dom.Entity#getXmlVersion()}.
     */
    public String getXmlVersion() {
        return null;
    }

    
Exports this node to the given document.
/**
     * Exports this node to the given document.
     */
    protected Node export(Node n, AbstractDocument d) {
        super.export(n, d);
        AbstractEntity ae = (AbstractEntity)n;
        ae.nodeName = nodeName;
        ae.publicId = publicId;
        ae.systemId = systemId;
        return n;
    }

    
Deeply exports this node to the given document.
/**
     * Deeply exports this node to the given document.
     */
    protected Node deepExport(Node n, AbstractDocument d) {
        super.deepExport(n, d);
        AbstractEntity ae = (AbstractEntity)n;
        ae.nodeName = nodeName;
        ae.publicId = publicId;
        ae.systemId = systemId;
        return n;
    }

    
Copy the fields of the current node into the given node.
Params:
n – a node of the type of this./**
     * Copy the fields of the current node into the given node.
     * @param n a node of the type of this.
     */
    protected Node copyInto(Node n) {
        super.copyInto(n);
        AbstractEntity ae = (AbstractEntity)n;
        ae.nodeName = nodeName;
        ae.publicId = publicId;
        ae.systemId = systemId;
        return n;
    }

    
Deeply copy the fields of the current node into the given node.
Params:
n – a node of the type of this./**
     * Deeply copy the fields of the current node into the given node.
     * @param n a node of the type of this.
     */
    protected Node deepCopyInto(Node n) {
        super.deepCopyInto(n);
        AbstractEntity ae = (AbstractEntity)n;
        ae.nodeName = nodeName;
        ae.publicId = publicId;
        ae.systemId = systemId;
        return n;
    }

    
Checks the validity of a node to be inserted.
/**
     * Checks the validity of a node to be inserted.
     */
    protected void checkChildType(Node n, boolean replace) {
        switch (n.getNodeType()) {
        case ELEMENT_NODE:
        case PROCESSING_INSTRUCTION_NODE:
        case COMMENT_NODE:
        case TEXT_NODE:
        case CDATA_SECTION_NODE:
        case ENTITY_REFERENCE_NODE:
        case DOCUMENT_FRAGMENT_NODE:
            break;
        default:
            throw createDOMException
                (DOMException.HIERARCHY_REQUEST_ERR,
                 "child.type",
                 new Object[] {(int) getNodeType(),
                                getNodeName(),
                         (int) n.getNodeType(),
                                n.getNodeName() });
        }
    }
}