backtrack
[vamsas.git] / src / org / vamsas / objects / core / RangeType.java
diff --git a/src/org/vamsas/objects/core/RangeType.java b/src/org/vamsas/objects/core/RangeType.java
new file mode 100644 (file)
index 0000000..c0d6571
--- /dev/null
@@ -0,0 +1,452 @@
+/*\r
+ * This class was automatically generated with \r
+ * <a href="http://www.castor.org">Castor 0.9.9M2</a>, using an XML\r
+ * Schema.\r
+ * $Id$\r
+ */\r
+\r
+package org.vamsas.objects.core;\r
+\r
+  //---------------------------------/\r
+ //- Imported classes and packages -/\r
+//---------------------------------/\r
+\r
+import java.io.Reader;\r
+import java.io.Serializable;\r
+import java.io.Writer;\r
+import java.util.Enumeration;\r
+import java.util.Vector;\r
+import org.exolab.castor.xml.Marshaller;\r
+import org.exolab.castor.xml.Unmarshaller;\r
+import org.exolab.castor.xml.ValidationException;\r
+\r
+/**\r
+ * Specify an ordered set of positions and/or regions on the\r
+ * principle\r
+ *  dimension of some associated vamsas object Keeping to jaxb-1.0\r
+ * specification for the moment - this choice should\r
+ *  become a substitution group when we use jaxb-2.0 capable\r
+ * bindings\r
+ *  \r
+ * \r
+ * @version $Revision$ $Date$\r
+ */\r
+public abstract class RangeType extends org.vamsas.client.Vobject \r
+implements java.io.Serializable\r
+{\r
+\r
+\r
+      //--------------------------/\r
+     //- Class/Member Variables -/\r
+    //--------------------------/\r
+\r
+    /**\r
+     * Internal choice value storage\r
+     */\r
+    private java.lang.Object _choiceValue;\r
+\r
+    /**\r
+     * a position within the associated object's coordinate system\r
+     *  \r
+     */\r
+    private java.util.Vector _posList;\r
+\r
+    /**\r
+     * a region from start to end, with flag for inclusivity of\r
+     *  terminii \r
+     */\r
+    private java.util.Vector _segList;\r
+\r
+\r
+      //----------------/\r
+     //- Constructors -/\r
+    //----------------/\r
+\r
+    public RangeType() \r
+     {\r
+        super();\r
+        _posList = new Vector();\r
+        _segList = new Vector();\r
+    } //-- org.vamsas.objects.core.RangeType()\r
+\r
+\r
+      //-----------/\r
+     //- Methods -/\r
+    //-----------/\r
+\r
+    /**\r
+     * Method addPos\r
+     * \r
+     * \r
+     * \r
+     * @param vPos\r
+     */\r
+    public void addPos(org.vamsas.objects.core.Pos vPos)\r
+        throws java.lang.IndexOutOfBoundsException\r
+    {\r
+        _posList.addElement(vPos);\r
+    } //-- void addPos(org.vamsas.objects.core.Pos) \r
+\r
+    /**\r
+     * Method addPos\r
+     * \r
+     * \r
+     * \r
+     * @param index\r
+     * @param vPos\r
+     */\r
+    public void addPos(int index, org.vamsas.objects.core.Pos vPos)\r
+        throws java.lang.IndexOutOfBoundsException\r
+    {\r
+        _posList.insertElementAt(vPos, index);\r
+    } //-- void addPos(int, org.vamsas.objects.core.Pos) \r
+\r
+    /**\r
+     * Method addSeg\r
+     * \r
+     * \r
+     * \r
+     * @param vSeg\r
+     */\r
+    public void addSeg(org.vamsas.objects.core.Seg vSeg)\r
+        throws java.lang.IndexOutOfBoundsException\r
+    {\r
+        _segList.addElement(vSeg);\r
+    } //-- void addSeg(org.vamsas.objects.core.Seg) \r
+\r
+    /**\r
+     * Method addSeg\r
+     * \r
+     * \r
+     * \r
+     * @param index\r
+     * @param vSeg\r
+     */\r
+    public void addSeg(int index, org.vamsas.objects.core.Seg vSeg)\r
+        throws java.lang.IndexOutOfBoundsException\r
+    {\r
+        _segList.insertElementAt(vSeg, index);\r
+    } //-- void addSeg(int, org.vamsas.objects.core.Seg) \r
+\r
+    /**\r
+     * Method enumeratePos\r
+     * \r
+     * \r
+     * \r
+     * @return Enumeration\r
+     */\r
+    public java.util.Enumeration enumeratePos()\r
+    {\r
+        return _posList.elements();\r
+    } //-- java.util.Enumeration enumeratePos() \r
+\r
+    /**\r
+     * Method enumerateSeg\r
+     * \r
+     * \r
+     * \r
+     * @return Enumeration\r
+     */\r
+    public java.util.Enumeration enumerateSeg()\r
+    {\r
+        return _segList.elements();\r
+    } //-- java.util.Enumeration enumerateSeg() \r
+\r
+    /**\r
+     * Note: hashCode() has not been overriden\r
+     * \r
+     * @param obj\r
+     * @return boolean\r
+     */\r
+    public boolean equals(java.lang.Object obj)\r
+    {\r
+        if ( this == obj )\r
+            return true;\r
+        \r
+        if (super.equals(obj)==false)\r
+            return false;\r
+        \r
+        if (obj instanceof RangeType) {\r
+        \r
+            RangeType temp = (RangeType)obj;\r
+            if (this._choiceValue != null) {\r
+                if (temp._choiceValue == null) return false;\r
+                else if (!(this._choiceValue.equals(temp._choiceValue))) \r
+                    return false;\r
+            }\r
+            else if (temp._choiceValue != null)\r
+                return false;\r
+            if (this._posList != null) {\r
+                if (temp._posList == null) return false;\r
+                else if (!(this._posList.equals(temp._posList))) \r
+                    return false;\r
+            }\r
+            else if (temp._posList != null)\r
+                return false;\r
+            if (this._segList != null) {\r
+                if (temp._segList == null) return false;\r
+                else if (!(this._segList.equals(temp._segList))) \r
+                    return false;\r
+            }\r
+            else if (temp._segList != null)\r
+                return false;\r
+            return true;\r
+        }\r
+        return false;\r
+    } //-- boolean equals(java.lang.Object) \r
+\r
+    /**\r
+     * Returns the value of field 'choiceValue'. The field\r
+     * 'choiceValue' has the following description: Internal choice\r
+     * value storage\r
+     * \r
+     * @return Object\r
+     * @return the value of field 'choiceValue'.\r
+     */\r
+    public java.lang.Object getChoiceValue()\r
+    {\r
+        return this._choiceValue;\r
+    } //-- java.lang.Object getChoiceValue() \r
+\r
+    /**\r
+     * Method getPos\r
+     * \r
+     * \r
+     * \r
+     * @param index\r
+     * @return Pos\r
+     */\r
+    public org.vamsas.objects.core.Pos getPos(int index)\r
+        throws java.lang.IndexOutOfBoundsException\r
+    {\r
+        //-- check bounds for index\r
+        if ((index < 0) || (index > _posList.size())) {\r
+            throw new IndexOutOfBoundsException("getPos: Index value '"+index+"' not in range [0.."+_posList.size()+ "]");\r
+        }\r
+        \r
+        return (org.vamsas.objects.core.Pos) _posList.elementAt(index);\r
+    } //-- org.vamsas.objects.core.Pos getPos(int) \r
+\r
+    /**\r
+     * Method getPos\r
+     * \r
+     * \r
+     * \r
+     * @return Pos\r
+     */\r
+    public org.vamsas.objects.core.Pos[] getPos()\r
+    {\r
+        int size = _posList.size();\r
+        org.vamsas.objects.core.Pos[] mArray = new org.vamsas.objects.core.Pos[size];\r
+        for (int index = 0; index < size; index++) {\r
+            mArray[index] = (org.vamsas.objects.core.Pos) _posList.elementAt(index);\r
+        }\r
+        return mArray;\r
+    } //-- org.vamsas.objects.core.Pos[] getPos() \r
+\r
+    /**\r
+     * Method getPosCount\r
+     * \r
+     * \r
+     * \r
+     * @return int\r
+     */\r
+    public int getPosCount()\r
+    {\r
+        return _posList.size();\r
+    } //-- int getPosCount() \r
+\r
+    /**\r
+     * Method getSeg\r
+     * \r
+     * \r
+     * \r
+     * @param index\r
+     * @return Seg\r
+     */\r
+    public org.vamsas.objects.core.Seg getSeg(int index)\r
+        throws java.lang.IndexOutOfBoundsException\r
+    {\r
+        //-- check bounds for index\r
+        if ((index < 0) || (index > _segList.size())) {\r
+            throw new IndexOutOfBoundsException("getSeg: Index value '"+index+"' not in range [0.."+_segList.size()+ "]");\r
+        }\r
+        \r
+        return (org.vamsas.objects.core.Seg) _segList.elementAt(index);\r
+    } //-- org.vamsas.objects.core.Seg getSeg(int) \r
+\r
+    /**\r
+     * Method getSeg\r
+     * \r
+     * \r
+     * \r
+     * @return Seg\r
+     */\r
+    public org.vamsas.objects.core.Seg[] getSeg()\r
+    {\r
+        int size = _segList.size();\r
+        org.vamsas.objects.core.Seg[] mArray = new org.vamsas.objects.core.Seg[size];\r
+        for (int index = 0; index < size; index++) {\r
+            mArray[index] = (org.vamsas.objects.core.Seg) _segList.elementAt(index);\r
+        }\r
+        return mArray;\r
+    } //-- org.vamsas.objects.core.Seg[] getSeg() \r
+\r
+    /**\r
+     * Method getSegCount\r
+     * \r
+     * \r
+     * \r
+     * @return int\r
+     */\r
+    public int getSegCount()\r
+    {\r
+        return _segList.size();\r
+    } //-- int getSegCount() \r
+\r
+    /**\r
+     * Method isValid\r
+     * \r
+     * \r
+     * \r
+     * @return boolean\r
+     */\r
+    public boolean isValid()\r
+    {\r
+        try {\r
+            validate();\r
+        }\r
+        catch (org.exolab.castor.xml.ValidationException vex) {\r
+            return false;\r
+        }\r
+        return true;\r
+    } //-- boolean isValid() \r
+\r
+    /**\r
+     * Method removeAllPos\r
+     * \r
+     */\r
+    public void removeAllPos()\r
+    {\r
+        _posList.removeAllElements();\r
+    } //-- void removeAllPos() \r
+\r
+    /**\r
+     * Method removeAllSeg\r
+     * \r
+     */\r
+    public void removeAllSeg()\r
+    {\r
+        _segList.removeAllElements();\r
+    } //-- void removeAllSeg() \r
+\r
+    /**\r
+     * Method removePos\r
+     * \r
+     * \r
+     * \r
+     * @param index\r
+     * @return Pos\r
+     */\r
+    public org.vamsas.objects.core.Pos removePos(int index)\r
+    {\r
+        java.lang.Object obj = _posList.elementAt(index);\r
+        _posList.removeElementAt(index);\r
+        return (org.vamsas.objects.core.Pos) obj;\r
+    } //-- org.vamsas.objects.core.Pos removePos(int) \r
+\r
+    /**\r
+     * Method removeSeg\r
+     * \r
+     * \r
+     * \r
+     * @param index\r
+     * @return Seg\r
+     */\r
+    public org.vamsas.objects.core.Seg removeSeg(int index)\r
+    {\r
+        java.lang.Object obj = _segList.elementAt(index);\r
+        _segList.removeElementAt(index);\r
+        return (org.vamsas.objects.core.Seg) obj;\r
+    } //-- org.vamsas.objects.core.Seg removeSeg(int) \r
+\r
+    /**\r
+     * Method setPos\r
+     * \r
+     * \r
+     * \r
+     * @param index\r
+     * @param vPos\r
+     */\r
+    public void setPos(int index, org.vamsas.objects.core.Pos vPos)\r
+        throws java.lang.IndexOutOfBoundsException\r
+    {\r
+        //-- check bounds for index\r
+        if ((index < 0) || (index > _posList.size())) {\r
+            throw new IndexOutOfBoundsException("setPos: Index value '"+index+"' not in range [0.."+_posList.size()+ "]");\r
+        }\r
+        _posList.setElementAt(vPos, index);\r
+    } //-- void setPos(int, org.vamsas.objects.core.Pos) \r
+\r
+    /**\r
+     * Method setPos\r
+     * \r
+     * \r
+     * \r
+     * @param posArray\r
+     */\r
+    public void setPos(org.vamsas.objects.core.Pos[] posArray)\r
+    {\r
+        //-- copy array\r
+        _posList.removeAllElements();\r
+        for (int i = 0; i < posArray.length; i++) {\r
+            _posList.addElement(posArray[i]);\r
+        }\r
+    } //-- void setPos(org.vamsas.objects.core.Pos) \r
+\r
+    /**\r
+     * Method setSeg\r
+     * \r
+     * \r
+     * \r
+     * @param index\r
+     * @param vSeg\r
+     */\r
+    public void setSeg(int index, org.vamsas.objects.core.Seg vSeg)\r
+        throws java.lang.IndexOutOfBoundsException\r
+    {\r
+        //-- check bounds for index\r
+        if ((index < 0) || (index > _segList.size())) {\r
+            throw new IndexOutOfBoundsException("setSeg: Index value '"+index+"' not in range [0.."+_segList.size()+ "]");\r
+        }\r
+        _segList.setElementAt(vSeg, index);\r
+    } //-- void setSeg(int, org.vamsas.objects.core.Seg) \r
+\r
+    /**\r
+     * Method setSeg\r
+     * \r
+     * \r
+     * \r
+     * @param segArray\r
+     */\r
+    public void setSeg(org.vamsas.objects.core.Seg[] segArray)\r
+    {\r
+        //-- copy array\r
+        _segList.removeAllElements();\r
+        for (int i = 0; i < segArray.length; i++) {\r
+            _segList.addElement(segArray[i]);\r
+        }\r
+    } //-- void setSeg(org.vamsas.objects.core.Seg) \r
+\r
+    /**\r
+     * Method validate\r
+     * \r
+     */\r
+    public void validate()\r
+        throws org.exolab.castor.xml.ValidationException\r
+    {\r
+        org.exolab.castor.xml.Validator validator = new org.exolab.castor.xml.Validator();\r
+        validator.validate(this);\r
+    } //-- void validate() \r
+\r
+}\r