|
|||||||||||
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.Tree
Class Tree.
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 | |
Tree()
|
Method Summary | |
void |
addNewick(int index,
Newick vNewick)
|
void |
addNewick(Newick vNewick)
|
void |
addProperty(int index,
Property vProperty)
|
void |
addProperty(Property vProperty)
|
void |
addTreenode(int index,
Treenode vTreenode)
|
void |
addTreenode(Treenode vTreenode)
|
java.util.Enumeration |
enumerateNewick()
Method enumerateNewick. |
java.util.Enumeration |
enumerateProperty()
Method enumerateProperty. |
java.util.Enumeration |
enumerateTreenode()
Method enumerateTreenode. |
boolean |
equals(java.lang.Object obj)
Overrides the java.lang.Object.equals method. |
java.lang.String |
getId()
Returns the value of field 'id'. |
java.lang.String |
getModifiable()
Returns the value of field 'modifiable'. |
Newick[] |
getNewick()
Method getNewick.Returns the contents of the collection in an Array. |
Newick |
getNewick(int index)
Method getNewick. |
java.util.Vector |
getNewickAsReference()
Method getNewickAsReference.Returns a reference to '_newickList'. |
int |
getNewickCount()
Method getNewickCount. |
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. |
Provenance |
getProvenance()
Returns the value of field 'provenance'. |
java.lang.String |
getTitle()
Returns the value of field 'title'. |
Treenode[] |
getTreenode()
Method getTreenode.Returns the contents of the collection in an Array. |
Treenode |
getTreenode(int index)
Method getTreenode. |
java.util.Vector |
getTreenodeAsReference()
Method getTreenodeAsReference.Returns a reference to '_treenodeList'. |
int |
getTreenodeCount()
Method getTreenodeCount. |
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 |
removeAllNewick()
|
void |
removeAllProperty()
|
void |
removeAllTreenode()
|
boolean |
removeNewick(Newick vNewick)
Method removeNewick. |
Newick |
removeNewickAt(int index)
Method removeNewickAt. |
boolean |
removeProperty(Property vProperty)
Method removeProperty. |
Property |
removePropertyAt(int index)
Method removePropertyAt. |
boolean |
removeTreenode(Treenode vTreenode)
Method removeTreenode. |
Treenode |
removeTreenodeAt(int index)
Method removeTreenodeAt. |
void |
setId(java.lang.String id)
Sets the value of field 'id'. |
void |
setModifiable(java.lang.String modifiable)
Sets the value of field 'modifiable'. |
void |
setNewick(int index,
Newick vNewick)
|
void |
setNewick(Newick[] vNewickArray)
|
void |
setNewick(java.util.Vector vNewickList)
Sets the value of '_newickList' by copying the given Vector. |
void |
setNewickAsReference(java.util.Vector newickVector)
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 |
setProvenance(Provenance provenance)
Sets the value of field 'provenance'. |
void |
setTitle(java.lang.String title)
Sets the value of field 'title'. |
void |
setTreenode(int index,
Treenode vTreenode)
|
void |
setTreenode(Treenode[] vTreenodeArray)
|
void |
setTreenode(java.util.Vector vTreenodeList)
Sets the value of '_treenodeList' by copying the given Vector. |
void |
setTreenodeAsReference(java.util.Vector treenodeVector)
Deprecated. |
static Tree |
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 Tree()
Method Detail |
public void addNewick(Newick vNewick) throws java.lang.IndexOutOfBoundsException
vNewick
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addNewick(int index, Newick vNewick) throws java.lang.IndexOutOfBoundsException
index
- vNewick
-
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 addTreenode(Treenode vTreenode) throws java.lang.IndexOutOfBoundsException
vTreenode
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addTreenode(int index, Treenode vTreenode) throws java.lang.IndexOutOfBoundsException
index
- vTreenode
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic java.util.Enumeration enumerateNewick()
public java.util.Enumeration enumerateProperty()
public java.util.Enumeration enumerateTreenode()
public boolean equals(java.lang.Object obj)
obj
-
public java.lang.String getId()
public java.lang.String getModifiable()
public Newick getNewick(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic Newick[] getNewick()
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 getNewickAsReference()
public int getNewickCount()
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 Provenance getProvenance()
public java.lang.String getTitle()
public Treenode getTreenode(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic Treenode[] getTreenode()
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 getTreenodeAsReference()
public int getTreenodeCount()
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 removeAllNewick()
public void removeAllProperty()
public void removeAllTreenode()
public boolean removeNewick(Newick vNewick)
vNewick
-
public Newick removeNewickAt(int index)
index
-
public boolean removeProperty(Property vProperty)
vProperty
-
public Property removePropertyAt(int index)
index
-
public boolean removeTreenode(Treenode vTreenode)
vTreenode
-
public Treenode removeTreenodeAt(int index)
index
-
public void setId(java.lang.String id)
id
- the value of field 'id'.public void setModifiable(java.lang.String modifiable)
modifiable
- the value of field 'modifiable'.public void setNewick(int index, Newick vNewick) throws java.lang.IndexOutOfBoundsException
index
- vNewick
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setNewick(Newick[] vNewickArray)
vNewickArray
- public void setNewick(java.util.Vector vNewickList)
vNewickList
- the Vector to copy.public void setNewickAsReference(java.util.Vector newickVector)
newickVector
- 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 setProvenance(Provenance provenance)
provenance
- the value of field 'provenance'.public void setTitle(java.lang.String title)
title
- the value of field 'title'.public void setTreenode(int index, Treenode vTreenode) throws java.lang.IndexOutOfBoundsException
index
- vTreenode
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setTreenode(Treenode[] vTreenodeArray)
vTreenodeArray
- public void setTreenode(java.util.Vector vTreenodeList)
vTreenodeList
- the Vector to copy.public void setTreenodeAsReference(java.util.Vector treenodeVector)
treenodeVector
- the Vector to set.public static Tree 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 |