/*
 * This class was automatically generated with 
 * <a href="http://www.castor.org">Castor 0.9.5.3</a>, using an XML
 * Schema.
 * $Id$
 */

  //---------------------------------/
 //- Imported classes and packages -/
//---------------------------------/

import java.io.IOException;
import java.io.Reader;
import java.io.Serializable;
import java.io.Writer;
import java.util.Enumeration;
import java.util.Vector;
import org.exolab.castor.xml.MarshalException;
import org.exolab.castor.xml.Marshaller;
import org.exolab.castor.xml.Unmarshaller;
import org.exolab.castor.xml.ValidationException;
import org.xml.sax.ContentHandler;

/**
 * Class Layer.
 * 
 * @version $Revision$ $Date$
 */
public class Layer implements java.io.Serializable {


      //--------------------------/
     //- Class/Member Variables -/
    //--------------------------/

    /**
     * Field _ringList
     */
    private java.util.Vector _ringList;


      //----------------/
     //- Constructors -/
    //----------------/

    public Layer() {
        super();
        _ringList = new Vector();
    } //-- Layer()


      //-----------/
     //- Methods -/
    //-----------/

    /**
     * Method addRing
     * 
     * @param vRing
     */
    public void addRing(Ring vRing)
        throws java.lang.IndexOutOfBoundsException
    {
        _ringList.addElement(vRing);
    } //-- void addRing(Ring) 

    /**
     * Method addRing
     * 
     * @param index
     * @param vRing
     */
    public void addRing(int index, Ring vRing)
        throws java.lang.IndexOutOfBoundsException
    {
        _ringList.insertElementAt(vRing, index);
    } //-- void addRing(int, Ring) 

    /**
     * Method enumerateRing
     */
    public java.util.Enumeration enumerateRing()
    {
        return _ringList.elements();
    } //-- java.util.Enumeration enumerateRing() 

    /**
     * Method getRing
     * 
     * @param index
     */
    public Ring getRing(int index)
        throws java.lang.IndexOutOfBoundsException
    {
        //-- check bounds for index
        if ((index < 0) || (index > _ringList.size())) {
            throw new IndexOutOfBoundsException();
        }
        
        return (Ring) _ringList.elementAt(index);
    } //-- Ring getRing(int) 

    /**
     * Method getRing
     */
    public Ring[] getRing()
    {
        int size = _ringList.size();
        Ring[] mArray = new Ring[size];
        for (int index = 0; index < size; index++) {
            mArray[index] = (Ring) _ringList.elementAt(index);
        }
        return mArray;
    } //-- Ring[] getRing() 

    /**
     * Method getRingCount
     */
    public int getRingCount()
    {
        return _ringList.size();
    } //-- int getRingCount() 

    /**
     * Method isValid
     */
    public boolean isValid()
    {
        try {
            validate();
        }
        catch (org.exolab.castor.xml.ValidationException vex) {
            return false;
        }
        return true;
    } //-- boolean isValid() 

    /**
     * Method marshal
     * 
     * @param out
     */
    public void marshal(java.io.Writer out)
        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        
        Marshaller.marshal(this, out);
    } //-- void marshal(java.io.Writer) 

    /**
     * Method marshal
     * 
     * @param handler
     */
    public void marshal(org.xml.sax.ContentHandler handler)
        throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        
        Marshaller.marshal(this, handler);
    } //-- void marshal(org.xml.sax.ContentHandler) 

    /**
     * Method removeAllRing
     */
    public void removeAllRing()
    {
        _ringList.removeAllElements();
    } //-- void removeAllRing() 

    /**
     * Method removeRing
     * 
     * @param index
     */
    public Ring removeRing(int index)
    {
        java.lang.Object obj = _ringList.elementAt(index);
        _ringList.removeElementAt(index);
        return (Ring) obj;
    } //-- Ring removeRing(int) 

    /**
     * Method setRing
     * 
     * @param index
     * @param vRing
     */
    public void setRing(int index, Ring vRing)
        throws java.lang.IndexOutOfBoundsException
    {
        //-- check bounds for index
        if ((index < 0) || (index > _ringList.size())) {
            throw new IndexOutOfBoundsException();
        }
        _ringList.setElementAt(vRing, index);
    } //-- void setRing(int, Ring) 

    /**
     * Method setRing
     * 
     * @param ringArray
     */
    public void setRing(Ring[] ringArray)
    {
        //-- copy array
        _ringList.removeAllElements();
        for (int i = 0; i < ringArray.length; i++) {
            _ringList.addElement(ringArray[i]);
        }
    } //-- void setRing(Ring) 

    /**
     * Method unmarshal
     * 
     * @param reader
     */
    public static java.lang.Object unmarshal(java.io.Reader reader)
        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        return (Layer) Unmarshaller.unmarshal(Layer.class, reader);
    } //-- java.lang.Object unmarshal(java.io.Reader) 

    /**
     * Method validate
     */
    public void validate()
        throws org.exolab.castor.xml.ValidationException
    {
        org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();
        validator.validate(this);
    } //-- void validate() 

}