|
|||||||||||
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.DbRef
Store a list of database references for this sequence record - with optional mapping from database sequence to the given sequence record
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 | |
DbRef()
|
Method Summary | |
void |
addLink(int index,
Link vLink)
|
void |
addLink(Link vLink)
|
void |
addMap(int index,
Map vMap)
|
void |
addMap(Map vMap)
|
void |
addProperty(int index,
Property vProperty)
|
void |
addProperty(Property vProperty)
|
java.util.Enumeration |
enumerateLink()
Method enumerateLink. |
java.util.Enumeration |
enumerateMap()
Method enumerateMap. |
java.util.Enumeration |
enumerateProperty()
Method enumerateProperty. |
boolean |
equals(java.lang.Object obj)
Overrides the java.lang.Object.equals method. |
java.lang.String |
getAccessionId()
Returns the value of field 'accessionId'. |
java.lang.String |
getId()
Returns the value of field 'id'. |
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. |
Map[] |
getMap()
Method getMap.Returns the contents of the collection in an Array. |
Map |
getMap(int index)
Method getMap. |
java.util.Vector |
getMapAsReference()
Method getMapAsReference.Returns a reference to '_mapList'. |
int |
getMapCount()
Method getMapCount. |
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. |
java.lang.String |
getSource()
Returns the value of field 'source'. |
java.lang.String |
getVersion()
Returns the value of field 'version'. |
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 |
removeAllLink()
|
void |
removeAllMap()
|
void |
removeAllProperty()
|
boolean |
removeLink(Link vLink)
Method removeLink. |
Link |
removeLinkAt(int index)
Method removeLinkAt. |
boolean |
removeMap(Map vMap)
Method removeMap. |
Map |
removeMapAt(int index)
Method removeMapAt. |
boolean |
removeProperty(Property vProperty)
Method removeProperty. |
Property |
removePropertyAt(int index)
Method removePropertyAt. |
void |
setAccessionId(java.lang.String accessionId)
Sets the value of field 'accessionId'. |
void |
setId(java.lang.String id)
Sets the value of field 'id'. |
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 |
setMap(int index,
Map vMap)
|
void |
setMap(Map[] vMapArray)
|
void |
setMap(java.util.Vector vMapList)
Sets the value of '_mapList' by copying the given Vector. |
void |
setMapAsReference(java.util.Vector mapVector)
Deprecated. |
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 |
setSource(java.lang.String source)
Sets the value of field 'source'. |
void |
setVersion(java.lang.String version)
Sets the value of field 'version'. |
static DbRef |
unmarshal(java.io.Reader reader)
Method unmarshal. |
void |
validate()
|
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 DbRef()
Method Detail |
public 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 addMap(Map vMap) throws java.lang.IndexOutOfBoundsException
vMap
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addMap(int index, Map vMap) throws java.lang.IndexOutOfBoundsException
index
- vMap
-
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 java.util.Enumeration enumerateLink()
public java.util.Enumeration enumerateMap()
public java.util.Enumeration enumerateProperty()
public boolean equals(java.lang.Object obj)
obj
-
public java.lang.String getAccessionId()
public java.lang.String getId()
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 Map getMap(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic Map[] getMap()
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 getMapAsReference()
public int getMapCount()
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 java.lang.String getSource()
public java.lang.String getVersion()
public int hashCode()
The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3
hashCode
in class Vobject
public boolean isValid()
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 removeAllLink()
public void removeAllMap()
public void removeAllProperty()
public boolean removeLink(Link vLink)
vLink
-
public Link removeLinkAt(int index)
index
-
public boolean removeMap(Map vMap)
vMap
-
public Map removeMapAt(int index)
index
-
public boolean removeProperty(Property vProperty)
vProperty
-
public Property removePropertyAt(int index)
index
-
public void setAccessionId(java.lang.String accessionId)
accessionId
- the value of field 'accessionId'.public void setId(java.lang.String id)
id
- the value of field 'id'.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 setMap(int index, Map vMap) throws java.lang.IndexOutOfBoundsException
index
- vMap
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setMap(Map[] vMapArray)
vMapArray
- public void setMap(java.util.Vector vMapList)
vMapList
- the Vector to copy.public void setMapAsReference(java.util.Vector mapVector)
mapVector
- the Vector to set.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 setSource(java.lang.String source)
source
- the value of field 'source'.public void setVersion(java.lang.String version)
version
- the value of field 'version'.public static DbRef 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
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 |