uk.ac.vamsas.objects.core
Class DataSetAnnotations

java.lang.Object
  extended byuk.ac.vamsas.client.Vobject
      extended byuk.ac.vamsas.objects.core.RangeType
          extended byuk.ac.vamsas.objects.core.RangeAnnotation
              extended byuk.ac.vamsas.objects.core.DataSetAnnotations
All Implemented Interfaces:
java.io.Serializable

public class DataSetAnnotations
extends RangeAnnotation
implements java.io.Serializable

Class DataSetAnnotations.

Version:
$Revision: 496 $ $Date: 2007-06-28 14:51:44 +0100 (Thu, 28 Jun 2007) $
See Also:
Serialized Form

Field Summary
 
Fields inherited from class uk.ac.vamsas.client.Vobject
__added_since_last_read, __last_hash, __stored_in_document, __updated_since_last_read, __visited, __vorba, registerable, V_parent, vorbaId
 
Constructor Summary
DataSetAnnotations()
           
 
Method Summary
 void addSeqRef(int index, java.lang.Object vSeqRef)
           
 void addSeqRef(java.lang.Object vSeqRef)
           
 java.util.Enumeration enumerateSeqRef()
          Method enumerateSeqRef.
 boolean equals(java.lang.Object obj)
          Overrides the java.lang.Object.equals method.
 Provenance getProvenance()
          Returns the value of field 'provenance'.
 java.lang.Object[] getSeqRef()
          Method getSeqRef.Returns the contents of the collection in an Array.
 java.lang.Object getSeqRef(int index)
          Method getSeqRef.
 java.util.Vector getSeqRefAsReference()
          Method getSeqRefAsReference.Returns a reference to '_seqRef'.
 int getSeqRefCount()
          Method getSeqRefCount.
 int hashCode()
          Overrides the java.lang.Object.hashCode method.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void removeAllSeqRef()
           
 boolean removeSeqRef(java.lang.Object vSeqRef)
          Method removeSeqRef.
 java.lang.Object removeSeqRefAt(int index)
          Method removeSeqRefAt.
 void setProvenance(Provenance provenance)
          Sets the value of field 'provenance'.
 void setSeqRef(int index, java.lang.Object vSeqRef)
           
 void setSeqRef(java.lang.Object[] vSeqRefArray)
           
 void setSeqRef(java.util.Vector vSeqRefList)
          Sets the value of '_seqRef' by copying the given Vector.
 void setSeqRefAsReference(java.util.Vector seqRefVector)
          Deprecated.  
static RangeType unmarshal(java.io.Reader reader)
          Method unmarshal.
 void validate()
           
 
Methods inherited from class uk.ac.vamsas.objects.core.RangeAnnotation
addAnnotationElement, addAnnotationElement, addLink, addLink, addProperty, addProperty, addScore, addScore, enumerateAnnotationElement, enumerateLink, enumerateProperty, enumerateScore, getAnnotationElement, getAnnotationElement, getAnnotationElementAsReference, getAnnotationElementCount, getDescription, getGroup, getId, getLabel, getLink, getLink, getLinkAsReference, getLinkCount, getModifiable, getProperty, getProperty, getPropertyAsReference, getPropertyCount, getScore, getScore, getScoreAsReference, getScoreCount, getStatus, getType, removeAllAnnotationElement, removeAllLink, removeAllProperty, removeAllScore, removeAnnotationElement, removeAnnotationElementAt, removeLink, removeLinkAt, removeProperty, removePropertyAt, removeScore, removeScoreAt, setAnnotationElement, setAnnotationElement, setAnnotationElement, setAnnotationElementAsReference, setDescription, setGroup, setId, setLabel, setLink, setLink, setLink, setLinkAsReference, setModifiable, setProperty, setProperty, setProperty, setPropertyAsReference, setScore, setScore, setScore, setScoreAsReference, setStatus, setType
 
Methods inherited from class uk.ac.vamsas.objects.core.RangeType
addPos, addPos, addSeg, addSeg, enumeratePos, enumerateSeg, getChoiceValue, getPos, getPos, getPosAsReference, getPosCount, getSeg, getSeg, getSegAsReference, getSegCount, removeAllPos, removeAllSeg, removePos, removePosAt, removeSeg, removeSegAt, setPos, setPos, setPos, setPosAsReference, setSeg, setSeg, setSeg, setSegAsReference
 
Methods inherited from class uk.ac.vamsas.client.Vobject
__callHash, __ensure_instance_ids, __ensure_instance_ids, __getInstanceIdField, __getLHash, __setFinalHash, __setInitHash, doHash, finalize, get__last_hash, getV_parent, getVorbaId, is__stored_in_document, isNewInDocument, isRegisterable, isRegistered, isUpdated, merge, set__added_since_last_read, set__stored_in_document, set__updated_since_last_read, setInstanceIdField, setRegisterable, setV_parent, setVorbaId
 
Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataSetAnnotations

public DataSetAnnotations()
Method Detail

addSeqRef

public void addSeqRef(java.lang.Object vSeqRef)
               throws java.lang.IndexOutOfBoundsException
Parameters:
vSeqRef -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addSeqRef

public void addSeqRef(int index,
                      java.lang.Object vSeqRef)
               throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vSeqRef -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

enumerateSeqRef

public java.util.Enumeration enumerateSeqRef()
Method enumerateSeqRef.

Returns:
an Enumeration over all java.lang.Object elements

equals

public boolean equals(java.lang.Object obj)
Overrides the java.lang.Object.equals method.

Overrides:
equals in class RangeAnnotation
Parameters:
obj -
Returns:
true if the objects are equal.

getProvenance

public Provenance getProvenance()
Returns the value of field 'provenance'.

Returns:
the value of field 'Provenance'.

getSeqRef

public java.lang.Object getSeqRef(int index)
                           throws java.lang.IndexOutOfBoundsException
Method getSeqRef.

Parameters:
index -
Returns:
the value of the java.lang.Object at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getSeqRef

public java.lang.Object[] getSeqRef()
Method getSeqRef.Returns the contents of the collection in an Array.

Note: Just in case the collection contents are changing in another thread, we pass a 0-length Array of the correct type into the API call. This way we know that the Array returned is of exactly the correct length.

Returns:
this collection as an Array

getSeqRefAsReference

public java.util.Vector getSeqRefAsReference()
Method getSeqRefAsReference.Returns a reference to '_seqRef'. No type checking is performed on any modifications to the Vector.

Returns:
a reference to the Vector backing this class

getSeqRefCount

public int getSeqRefCount()
Method getSeqRefCount.

Returns:
the size of this collection

hashCode

public int hashCode()
Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:
hashCode in class RangeAnnotation
Returns:
a hash code value for the object.

isValid

public boolean isValid()
Method isValid.

Overrides:
isValid in class RangeAnnotation
Returns:
true if this object is valid according to the schema

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Overrides:
marshal in class RangeAnnotation
Parameters:
out -
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
Overrides:
marshal in class RangeAnnotation
Parameters:
handler -
Throws:
java.io.IOException - if an IOException occurs during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

removeAllSeqRef

public void removeAllSeqRef()

removeSeqRef

public boolean removeSeqRef(java.lang.Object vSeqRef)
Method removeSeqRef.

Parameters:
vSeqRef -
Returns:
true if the object was removed from the collection.

removeSeqRefAt

public java.lang.Object removeSeqRefAt(int index)
Method removeSeqRefAt.

Parameters:
index -
Returns:
the element removed from the collection

setProvenance

public void setProvenance(Provenance provenance)
Sets the value of field 'provenance'.

Parameters:
provenance - the value of field 'provenance'.

setSeqRef

public void setSeqRef(int index,
                      java.lang.Object vSeqRef)
               throws java.lang.IndexOutOfBoundsException
Parameters:
index -
vSeqRef -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

setSeqRef

public void setSeqRef(java.lang.Object[] vSeqRefArray)
Parameters:
vSeqRefArray -

setSeqRef

public void setSeqRef(java.util.Vector vSeqRefList)
Sets the value of '_seqRef' by copying the given Vector. All elements will be checked for type safety.

Parameters:
vSeqRefList - the Vector to copy.

setSeqRefAsReference

public void setSeqRefAsReference(java.util.Vector seqRefVector)
Deprecated.  

Sets the value of '_seqRef' by setting it to the given Vector. No type checking is performed.

Parameters:
seqRefVector - the Vector to set.

unmarshal

public static RangeType unmarshal(java.io.Reader reader)
                           throws org.exolab.castor.xml.MarshalException,
                                  org.exolab.castor.xml.ValidationException
Method unmarshal.

Parameters:
reader -
Returns:
the unmarshaled uk.ac.vamsas.objects.core.RangeType
Throws:
org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException
Overrides:
validate in class RangeAnnotation
Throws:
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema