|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.vamsas.client.Vobject
uk.ac.vamsas.objects.core.RangeType
uk.ac.vamsas.objects.core.RangeAnnotation
Annotation for a rangeSpec - values can be attached for the whole specification, and to each position within the spec. following the orientation specified by the ordered set of rangeSpec (pos, seg) elements.
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 | |
RangeAnnotation()
|
Method Summary | |
void |
addAnnotationElement(AnnotationElement vAnnotationElement)
|
void |
addAnnotationElement(int index,
AnnotationElement vAnnotationElement)
|
void |
addLink(int index,
Link vLink)
|
void |
addLink(Link vLink)
|
void |
addProperty(int index,
Property vProperty)
|
void |
addProperty(Property vProperty)
|
void |
addScore(int index,
Score vScore)
|
void |
addScore(Score vScore)
|
java.util.Enumeration |
enumerateAnnotationElement()
Method enumerateAnnotationElement. |
java.util.Enumeration |
enumerateLink()
Method enumerateLink. |
java.util.Enumeration |
enumerateProperty()
Method enumerateProperty. |
java.util.Enumeration |
enumerateScore()
Method enumerateScore. |
boolean |
equals(java.lang.Object obj)
Overrides the java.lang.Object.equals method. |
AnnotationElement[] |
getAnnotationElement()
Method getAnnotationElement.Returns the contents of the collection in an Array. |
AnnotationElement |
getAnnotationElement(int index)
Method getAnnotationElement. |
java.util.Vector |
getAnnotationElementAsReference()
Method getAnnotationElementAsReference.Returns a reference to '_annotationElementList'. |
int |
getAnnotationElementCount()
Method getAnnotationElementCount. |
java.lang.String |
getDescription()
Returns the value of field 'description'. |
java.lang.String |
getGroup()
Returns the value of field 'group'. |
java.lang.String |
getId()
Returns the value of field 'id'. |
java.lang.String |
getLabel()
Returns the value of field 'label'. |
Link[] |
getLink()
Method getLink.Returns the contents of the collection in an Array. |
Link |
getLink(int index)
Method getLink. |
java.util.Vector |
getLinkAsReference()
Method getLinkAsReference.Returns a reference to '_linkList'. |
int |
getLinkCount()
Method getLinkCount. |
java.lang.String |
getModifiable()
Returns the value of field 'modifiable'. |
Property[] |
getProperty()
Method getProperty.Returns the contents of the collection in an Array. |
Property |
getProperty(int index)
Method getProperty. |
java.util.Vector |
getPropertyAsReference()
Method getPropertyAsReference.Returns a reference to '_propertyList'. |
int |
getPropertyCount()
Method getPropertyCount. |
Score[] |
getScore()
Method getScore.Returns the contents of the collection in an Array. |
Score |
getScore(int index)
Method getScore. |
java.util.Vector |
getScoreAsReference()
Method getScoreAsReference.Returns a reference to '_scoreList'. |
int |
getScoreCount()
Method getScoreCount. |
java.lang.String |
getStatus()
Returns the value of field 'status'. |
java.lang.String |
getType()
Returns the value of field 'type'. |
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 |
removeAllAnnotationElement()
|
void |
removeAllLink()
|
void |
removeAllProperty()
|
void |
removeAllScore()
|
boolean |
removeAnnotationElement(AnnotationElement vAnnotationElement)
Method removeAnnotationElement. |
AnnotationElement |
removeAnnotationElementAt(int index)
Method removeAnnotationElementAt. |
boolean |
removeLink(Link vLink)
Method removeLink. |
Link |
removeLinkAt(int index)
Method removeLinkAt. |
boolean |
removeProperty(Property vProperty)
Method removeProperty. |
Property |
removePropertyAt(int index)
Method removePropertyAt. |
boolean |
removeScore(Score vScore)
Method removeScore. |
Score |
removeScoreAt(int index)
Method removeScoreAt. |
void |
setAnnotationElement(AnnotationElement[] vAnnotationElementArray)
|
void |
setAnnotationElement(int index,
AnnotationElement vAnnotationElement)
|
void |
setAnnotationElement(java.util.Vector vAnnotationElementList)
Sets the value of '_annotationElementList' by copying the given Vector. |
void |
setAnnotationElementAsReference(java.util.Vector annotationElementVector)
Deprecated. |
void |
setDescription(java.lang.String description)
Sets the value of field 'description'. |
void |
setGroup(java.lang.String group)
Sets the value of field 'group'. |
void |
setId(java.lang.String id)
Sets the value of field 'id'. |
void |
setLabel(java.lang.String label)
Sets the value of field 'label'. |
void |
setLink(int index,
Link vLink)
|
void |
setLink(Link[] vLinkArray)
|
void |
setLink(java.util.Vector vLinkList)
Sets the value of '_linkList' by copying the given Vector. |
void |
setLinkAsReference(java.util.Vector linkVector)
Deprecated. |
void |
setModifiable(java.lang.String modifiable)
Sets the value of field 'modifiable'. |
void |
setProperty(int index,
Property vProperty)
|
void |
setProperty(Property[] vPropertyArray)
|
void |
setProperty(java.util.Vector vPropertyList)
Sets the value of '_propertyList' by copying the given Vector. |
void |
setPropertyAsReference(java.util.Vector propertyVector)
Deprecated. |
void |
setScore(int index,
Score vScore)
|
void |
setScore(Score[] vScoreArray)
|
void |
setScore(java.util.Vector vScoreList)
Sets the value of '_scoreList' by copying the given Vector. |
void |
setScoreAsReference(java.util.Vector scoreVector)
Deprecated. |
void |
setStatus(java.lang.String status)
Sets the value of field 'status'. |
void |
setType(java.lang.String type)
Sets the value of field 'type'. |
static RangeType |
unmarshal(java.io.Reader reader)
Method unmarshal. |
void |
validate()
|
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 |
public RangeAnnotation()
Method Detail |
public void addAnnotationElement(AnnotationElement vAnnotationElement) throws java.lang.IndexOutOfBoundsException
vAnnotationElement
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addAnnotationElement(int index, AnnotationElement vAnnotationElement) throws java.lang.IndexOutOfBoundsException
index
- vAnnotationElement
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addLink(Link vLink) throws java.lang.IndexOutOfBoundsException
vLink
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addLink(int index, Link vLink) throws java.lang.IndexOutOfBoundsException
index
- vLink
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addProperty(Property vProperty) throws java.lang.IndexOutOfBoundsException
vProperty
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addProperty(int index, Property vProperty) throws java.lang.IndexOutOfBoundsException
index
- vProperty
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addScore(Score vScore) throws java.lang.IndexOutOfBoundsException
vScore
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addScore(int index, Score vScore) throws java.lang.IndexOutOfBoundsException
index
- vScore
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic java.util.Enumeration enumerateAnnotationElement()
public java.util.Enumeration enumerateLink()
public java.util.Enumeration enumerateProperty()
public java.util.Enumeration enumerateScore()
public boolean equals(java.lang.Object obj)
equals
in class RangeType
obj
-
public AnnotationElement getAnnotationElement(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic AnnotationElement[] getAnnotationElement()
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.
public java.util.Vector getAnnotationElementAsReference()
public int getAnnotationElementCount()
public java.lang.String getDescription()
public java.lang.String getGroup()
public java.lang.String getId()
public java.lang.String getLabel()
public Link getLink(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic Link[] getLink()
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.
public java.util.Vector getLinkAsReference()
public int getLinkCount()
public java.lang.String getModifiable()
public Property getProperty(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic Property[] getProperty()
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.
public java.util.Vector getPropertyAsReference()
public int getPropertyCount()
public Score getScore(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic Score[] getScore()
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.
public java.util.Vector getScoreAsReference()
public int getScoreCount()
public java.lang.String getStatus()
public java.lang.String getType()
public int hashCode()
The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3
hashCode
in class RangeType
public boolean isValid()
isValid
in class RangeType
public void marshal(java.io.Writer out) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
out
-
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 schemapublic void marshal(org.xml.sax.ContentHandler handler) throws java.io.IOException, org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
handler
-
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
marshalingpublic void removeAllAnnotationElement()
public void removeAllLink()
public void removeAllProperty()
public void removeAllScore()
public boolean removeAnnotationElement(AnnotationElement vAnnotationElement)
vAnnotationElement
-
public AnnotationElement removeAnnotationElementAt(int index)
index
-
public boolean removeLink(Link vLink)
vLink
-
public Link removeLinkAt(int index)
index
-
public boolean removeProperty(Property vProperty)
vProperty
-
public Property removePropertyAt(int index)
index
-
public boolean removeScore(Score vScore)
vScore
-
public Score removeScoreAt(int index)
index
-
public void setAnnotationElement(int index, AnnotationElement vAnnotationElement) throws java.lang.IndexOutOfBoundsException
index
- vAnnotationElement
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setAnnotationElement(AnnotationElement[] vAnnotationElementArray)
vAnnotationElementArray
- public void setAnnotationElement(java.util.Vector vAnnotationElementList)
vAnnotationElementList
- the Vector to copy.public void setAnnotationElementAsReference(java.util.Vector annotationElementVector)
annotationElementVector
- the Vector to set.public void setDescription(java.lang.String description)
description
- the value of field 'description'.public void setGroup(java.lang.String group)
group
- the value of field 'group'.public void setId(java.lang.String id)
id
- the value of field 'id'.public void setLabel(java.lang.String label)
label
- the value of field 'label'.public void setLink(int index, Link vLink) throws java.lang.IndexOutOfBoundsException
index
- vLink
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setLink(Link[] vLinkArray)
vLinkArray
- public void setLink(java.util.Vector vLinkList)
vLinkList
- the Vector to copy.public void setLinkAsReference(java.util.Vector linkVector)
linkVector
- the Vector to set.public void setModifiable(java.lang.String modifiable)
modifiable
- the value of field 'modifiable'.public void setProperty(int index, Property vProperty) throws java.lang.IndexOutOfBoundsException
index
- vProperty
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setProperty(Property[] vPropertyArray)
vPropertyArray
- public void setProperty(java.util.Vector vPropertyList)
vPropertyList
- the Vector to copy.public void setPropertyAsReference(java.util.Vector propertyVector)
propertyVector
- the Vector to set.public void setScore(int index, Score vScore) throws java.lang.IndexOutOfBoundsException
index
- vScore
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setScore(Score[] vScoreArray)
vScoreArray
- public void setScore(java.util.Vector vScoreList)
vScoreList
- the Vector to copy.public void setScoreAsReference(java.util.Vector scoreVector)
scoreVector
- the Vector to set.public void setStatus(java.lang.String status)
status
- the value of field 'status'.public void setType(java.lang.String type)
type
- the value of field 'type'.public static RangeType unmarshal(java.io.Reader reader) throws org.exolab.castor.xml.MarshalException, org.exolab.castor.xml.ValidationException
reader
-
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 schemapublic void validate() throws org.exolab.castor.xml.ValidationException
validate
in class RangeType
org.exolab.castor.xml.ValidationException
- if this object is an invalid instance according to the schema
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |