Metacat

/**

 *        Name: BasicElement.java

 *     Purpose: A Class that represents an XML element and its contents

 *   Copyright: 2000 Regents of the University of California and the

 *              National Center for Ecological Analysis and Synthesis

 *     Authors: Matt Jones

 *

 *     Version: '$Id: BasicElement.java 74 2000-05-05 00:37:58Z jones $'

 */

package edu.ucsb.nceas.metacat;

import java.io.IOException;

import java.util.Hashtable;

import java.util.Enumeration;

/** A Class that represents an XML element and its contents */

public class BasicElement {

    private long		element_id;

    private String		tagname;

    private StringBuffer	content;

    private long		parent_id;

    private Hashtable	attributes;

    private int         childNum;

    private int         nodeIndex;

    /** Construct a Basic Element */

    public BasicElement () {

      content = new StringBuffer();

      attributes = new Hashtable(); 

    }

    /** Construct a Basic Element 

     *

     * @param tagname the name of the element

     * @param parent_id the id number of the parent element

     * @param nodeIndex - number of the element in the order for a given parent node

     * Every element initializes childNum to 0 when created and has interface incChildNum

     * when new child is created

     */

    public BasicElement (String tagname, long parent_id, int nodeIndex) {

      this();

      this.tagname = tagname;

      this.parent_id = parent_id;

      this.nodeIndex = nodeIndex;

      this.childNum = 0;

    }

    /** Construct a Basic Element 

     *

     * @param element_id the id number of the element

     * @param tagname the name of the element

     * @param parent_id the id number of the parent element

     */

    public BasicElement (long element_id, String tagname, long parent_id, int nodeIndex) {

      this(tagname,parent_id,nodeIndex);

      this.element_id = element_id;

    }

    /** convert the element to a string representation for display */

    public String toString ()

    {

	StringBuffer value = new StringBuffer();

	value.append('<');

	value.append(getTagName());

	value.append(getAttributes().toString());

	value.append('>');

        // Process children recursively here?

        // Or do it in ReaderElement using a stack so we don;t have the 

        // whole thing in memory at once?

	//value.append("</");

	//value.append(getTagName());

	//value.append('>');

	return value.toString();

    }

    /** Get the id of this element */

    public long getElementID() 

    { 

      return element_id; 

    }

    /** Set the id of this element */

    public void setElementID(long element_id) 

    { 

      this.element_id = element_id; 

    }

    /** Get the parent id of this element */

    public long getParentID() 

    { 

      return parent_id; 

    }

    /** Set the parent id of this element */

    public void setParentID(long parent_id) 

    { 

      this.parent_id = parent_id; 

    }

    /** Get the name of this element */

    public String getTagName() 

    { 

      return tagname; 

    }

    /** Set the tagname of this element */

    public void setTagName(String tagname) 

    { 

      this.tagname = tagname; 

    }

    /** Get the attributes as a string */

    public String getAttributes() {

      StringBuffer buf = new StringBuffer();

      String attName = null;

      String attValue = null;

      Enumeration attList = attributes.keys();

      while (attList.hasMoreElements()) {

        attName = (String)attList.nextElement();

        attValue = (String)attributes.get(attName);

        buf.append(" ").append(attName).append("=\"").append(attValue).append("\"");        

      }

      return buf.toString();      

    }

    /** Add a new attribute to this element, or set its value */

    public void setAttribute(String attName, String attValue) {

      if (attName != null) {

        // Enter the attribute in the hash table

        attributes.put(attName, attValue);

      } else {

        System.err.println("Attribute name must not be null!");

      }

    }

    /** Get an attribute value by name */

    public String getAttribute(String attName) {

      return (String)attributes.get(attName);

    }

    /** Append to the content of the element */

    public void appendContent(char[] cbuf, int start, int len) {

      this.content.append( cbuf, start, len );

    }

    /** Append to the content of the element */

    public void appendContent(String new_content) {

      this.content.append( new_content );

    }

    /** Get the content of the element */

    public String getContent() {

      return this.content.toString();

    }

    /** Get nodeIndex of the element */

    public int getNodeIndex() {

      return this.nodeIndex;

    }

    /** increase childNum when new child for the element is created */

    public int incChildNum() {

      return ++this.childNum;    

    }    

}