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

package com.queplix.core.modules.config.jxb;

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

import java.io.IOException;
import java.io.Reader;
import java.io.Serializable;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Enumeration;
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;

/**
 * The focus description
 * 
 * @version $Revision$ $Date$
 */
public class Focus extends com.queplix.core.utils.jxb.JXBObject 
implements java.io.Serializable
{


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

    /**
     * The focus name
     */
    private java.lang.String _name;

    /**
     * Field _order
     */
    private java.lang.Integer _order = new java.lang.Integer("-1");

    /**
     * Field _caption
     */
    private java.lang.String _caption;

    /**
     * Field _icon
     */
    private java.lang.String _icon;

    /**
     * The sequince of subfocuses
     */
    private java.util.ArrayList _subFocusList;

    /**
     * The focus captions collection
     */
    private com.queplix.core.modules.config.jxb.Captions _captions;


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

    public Focus() 
     {
        super();
        _subFocusList = new ArrayList();
    } //-- com.queplix.core.modules.config.jxb.Focus()


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

    /**
     * Method addSubFocus
     * 
     * 
     * 
     * @param vSubFocus
     */
    public void addSubFocus(com.queplix.core.modules.config.jxb.SubFocus vSubFocus)
        throws java.lang.IndexOutOfBoundsException
    {
        _subFocusList.add(vSubFocus);
    } //-- void addSubFocus(com.queplix.core.modules.config.jxb.SubFocus) 

    /**
     * Method addSubFocus
     * 
     * 
     * 
     * @param index
     * @param vSubFocus
     */
    public void addSubFocus(int index, com.queplix.core.modules.config.jxb.SubFocus vSubFocus)
        throws java.lang.IndexOutOfBoundsException
    {
        _subFocusList.add(index, vSubFocus);
    } //-- void addSubFocus(int, com.queplix.core.modules.config.jxb.SubFocus) 

    /**
     * Method clearSubFocus
     * 
     */
    public void clearSubFocus()
    {
        _subFocusList.clear();
    } //-- void clearSubFocus() 

    /**
     * Method enumerateSubFocus
     * 
     * 
     * 
     * @return Enumeration
     */
    public java.util.Enumeration enumerateSubFocus()
    {
        return new org.exolab.castor.util.IteratorEnumeration(_subFocusList.iterator());
    } //-- java.util.Enumeration enumerateSubFocus() 

    /**
     * Returns the value of field 'caption'.
     * 
     * @return String
     * @return the value of field 'caption'.
     */
    public java.lang.String getCaption()
    {
        return this._caption;
    } //-- java.lang.String getCaption() 

    /**
     * Returns the value of field 'captions'. The field 'captions'
     * has the following description: The focus captions collection
     * 
     * @return Captions
     * @return the value of field 'captions'.
     */
    public com.queplix.core.modules.config.jxb.Captions getCaptions()
    {
        return this._captions;
    } //-- com.queplix.core.modules.config.jxb.Captions getCaptions() 

    /**
     * Returns the value of field 'icon'.
     * 
     * @return String
     * @return the value of field 'icon'.
     */
    public java.lang.String getIcon()
    {
        return this._icon;
    } //-- java.lang.String getIcon() 

    /**
     * Returns the value of field 'name'. The field 'name' has the
     * following description: The focus name
     * 
     * @return String
     * @return the value of field 'name'.
     */
    public java.lang.String getName()
    {
        return this._name;
    } //-- java.lang.String getName() 

    /**
     * Returns the value of field 'order'.
     * 
     * @return Integer
     * @return the value of field 'order'.
     */
    public java.lang.Integer getOrder()
    {
        return this._order;
    } //-- java.lang.Integer getOrder() 

    /**
     * Method getSubFocus
     * 
     * 
     * 
     * @param index
     * @return SubFocus
     */
    public com.queplix.core.modules.config.jxb.SubFocus getSubFocus(int index)
        throws java.lang.IndexOutOfBoundsException
    {
        //-- check bounds for index
        if ((index < 0) || (index > _subFocusList.size())) {
            throw new IndexOutOfBoundsException();
        }
        
        return (com.queplix.core.modules.config.jxb.SubFocus) _subFocusList.get(index);
    } //-- com.queplix.core.modules.config.jxb.SubFocus getSubFocus(int) 

    /**
     * Method getSubFocus
     * 
     * 
     * 
     * @return SubFocus
     */
    public com.queplix.core.modules.config.jxb.SubFocus[] getSubFocus()
    {
        int size = _subFocusList.size();
        com.queplix.core.modules.config.jxb.SubFocus[] mArray = new com.queplix.core.modules.config.jxb.SubFocus[size];
        for (int index = 0; index < size; index++) {
            mArray[index] = (com.queplix.core.modules.config.jxb.SubFocus) _subFocusList.get(index);
        }
        return mArray;
    } //-- com.queplix.core.modules.config.jxb.SubFocus[] getSubFocus() 

    /**
     * Method getSubFocusCount
     * 
     * 
     * 
     * @return int
     */
    public int getSubFocusCount()
    {
        return _subFocusList.size();
    } //-- int getSubFocusCount() 

    /**
     * Method isValid
     * 
     * 
     * 
     * @return boolean
     */
    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 removeSubFocus
     * 
     * 
     * 
     * @param vSubFocus
     * @return boolean
     */
    public boolean removeSubFocus(com.queplix.core.modules.config.jxb.SubFocus vSubFocus)
    {
        boolean removed = _subFocusList.remove(vSubFocus);
        return removed;
    } //-- boolean removeSubFocus(com.queplix.core.modules.config.jxb.SubFocus) 

    /**
     * Sets the value of field 'caption'.
     * 
     * @param caption the value of field 'caption'.
     */
    public void setCaption(java.lang.String caption)
    {
        this._caption = caption;
    } //-- void setCaption(java.lang.String) 

    /**
     * Sets the value of field 'captions'. The field 'captions' has
     * the following description: The focus captions collection
     * 
     * @param captions the value of field 'captions'.
     */
    public void setCaptions(com.queplix.core.modules.config.jxb.Captions captions)
    {
        this._captions = captions;
    } //-- void setCaptions(com.queplix.core.modules.config.jxb.Captions) 

    /**
     * Sets the value of field 'icon'.
     * 
     * @param icon the value of field 'icon'.
     */
    public void setIcon(java.lang.String icon)
    {
        this._icon = icon;
    } //-- void setIcon(java.lang.String) 

    /**
     * Sets the value of field 'name'. The field 'name' has the
     * following description: The focus name
     * 
     * @param name the value of field 'name'.
     */
    public void setName(java.lang.String name)
    {
        this._name = name;
    } //-- void setName(java.lang.String) 

    /**
     * Sets the value of field 'order'.
     * 
     * @param order the value of field 'order'.
     */
    public void setOrder(java.lang.Integer order)
    {
        this._order = order;
    } //-- void setOrder(java.lang.Integer) 

    /**
     * Method setSubFocus
     * 
     * 
     * 
     * @param index
     * @param vSubFocus
     */
    public void setSubFocus(int index, com.queplix.core.modules.config.jxb.SubFocus vSubFocus)
        throws java.lang.IndexOutOfBoundsException
    {
        //-- check bounds for index
        if ((index < 0) || (index > _subFocusList.size())) {
            throw new IndexOutOfBoundsException();
        }
        _subFocusList.set(index, vSubFocus);
    } //-- void setSubFocus(int, com.queplix.core.modules.config.jxb.SubFocus) 

    /**
     * Method setSubFocus
     * 
     * 
     * 
     * @param subFocusArray
     */
    public void setSubFocus(com.queplix.core.modules.config.jxb.SubFocus[] subFocusArray)
    {
        //-- copy array
        _subFocusList.clear();
        for (int i = 0; i < subFocusArray.length; i++) {
            _subFocusList.add(subFocusArray[i]);
        }
    } //-- void setSubFocus(com.queplix.core.modules.config.jxb.SubFocus) 

    /**
     * Method unmarshal
     * 
     * 
     * 
     * @param reader
     * @return Object
     */
    public static java.lang.Object unmarshal(java.io.Reader reader)
        throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
    {
        return (com.queplix.core.modules.config.jxb.Focus) Unmarshaller.unmarshal(com.queplix.core.modules.config.jxb.Focus.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() 

}
