org.eigenbase.xom.DOMWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eigenbase-xom Show documentation
XML object model for Java
The newest version!
/*
// Licensed to Julian Hyde under one or more contributor license
// agreements. See the NOTICE file distributed with this work for
// additional information regarding copyright ownership.
//
// Julian Hyde 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.eigenbase.xom;

/**
 * DOMWrapper implements a Wrapper around the Element class from any DOM-style
 * XML parser.  The wrapper is used to isolate ElementParser, ElementDef, and
 * all ElementDef subclasses from the specifics of the underlying XML
 * parser.
 */
public interface DOMWrapper {

    /**
     * UNKNOWN is used for DOM Element types unsupported by the
     * wrapper.
     */
    public static final int UNKNOWN = 0;

    /**
     * FREETEXT is a type of DOM Element representing a piece of text (but not
     * a CDATA section).  For example, Some text.  FREETEXT
     * elements always have a tag name of NULL and have no children.  It
     * maps to a {@link TextDef}.
     */
    public static final int FREETEXT = 1;

    /**
     * ELEMENT is a type of DOM Element representing a named tag, possibly
     * containing attributes, child elements, and text.  It maps to a {@link
     * ElementDef} (or a generated class derived from it), or a {@link
     * GenericDef}.
     */
    public static final int ELEMENT = 2;

    /**
     * COMMENT is a type of DOM Element representing an XML comment.  It maps
     * to a {@link CommentDef}.
     */
    public static final int COMMENT = 3;

    /**
     * CDATA is a type of DOM Element representing a piece of text embedded in
     * a CDATA section, for example,
     * <![CDATA[Some text]]>.
     * CDATA elements always have a tag name of NULL and have no children.  It
     * maps to a {@link CdataDef}.
     */
    public static final int CDATA = 4;

    /**
     * Returns the type of this element/node.  DOMWrapper supports only four
     * possibilities: {@link #FREETEXT}, {@link #ELEMENT}, {@link #COMMENT},
     * {@link #CDATA}.
     */
    public int getType();

    /**
     * Returns the tag name of this element, or null for TEXT elements.
     */
    public String getTagName();

    /**
     * Returns the value of the attribute with the given attrName.  If the
     * attribute is not defined, this method returns null.
     */
    public String getAttribute(String attrName);

    /**
     * Returns a list of attribute names.
     */
    public String[] getAttributeNames();

    /**
     * Returns a flattened representation of the text inside thie element.
     * For a TEXT element, this returns the text itself.  For an ELEMENT
     * element, this returns all pieces of text within the element,
     * with all markup removed.
     */
    public String getText();

    /**
     * Returns this node serialized as XML.
     */
    public String toXML();

    /**
     * Returns all children of this element, including TEXT elements, as
     * an array of DOMWrappers.
     */
    public DOMWrapper[] getChildren();

    /**
     * Returns all element children of this element as an array of
     * DOMWrappers.
     */
    public DOMWrapper[] getElementChildren();

    /**
     * Returns the location of this element.
     */
    public Location getLocation();
}


// End DOMWrapper.java