|
|||||||||||
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.VamsasDocument
Class VamsasDocument.
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 | |
VamsasDocument()
|
Method Summary | |
void |
addApplicationData(ApplicationData vApplicationData)
|
void |
addApplicationData(int index,
ApplicationData vApplicationData)
|
void |
addAttachment(Attachment vAttachment)
|
void |
addAttachment(int index,
Attachment vAttachment)
|
void |
addVAMSAS(int index,
VAMSAS vVAMSAS)
|
void |
addVAMSAS(VAMSAS vVAMSAS)
|
java.util.Enumeration |
enumerateApplicationData()
Method enumerateApplicationData. |
java.util.Enumeration |
enumerateAttachment()
Method enumerateAttachment. |
java.util.Enumeration |
enumerateVAMSAS()
Method enumerateVAMSAS. |
boolean |
equals(java.lang.Object obj)
Overrides the java.lang.Object.equals method. |
ApplicationData[] |
getApplicationData()
Method getApplicationData.Returns the contents of the collection in an Array. |
ApplicationData |
getApplicationData(int index)
Method getApplicationData. |
java.util.Vector |
getApplicationDataAsReference()
Method getApplicationDataAsReference.Returns a reference to '_applicationDataList'. |
int |
getApplicationDataCount()
Method getApplicationDataCount. |
Attachment[] |
getAttachment()
Method getAttachment.Returns the contents of the collection in an Array. |
Attachment |
getAttachment(int index)
Method getAttachment. |
java.util.Vector |
getAttachmentAsReference()
Method getAttachmentAsReference.Returns a reference to '_attachmentList'. |
int |
getAttachmentCount()
Method getAttachmentCount. |
LockFile |
getLockFile()
Returns the value of field 'lockFile'. |
Provenance |
getProvenance()
Returns the value of field 'provenance'. |
VAMSAS[] |
getVAMSAS()
Method getVAMSAS.Returns the contents of the collection in an Array. |
VAMSAS |
getVAMSAS(int index)
Method getVAMSAS. |
java.util.Vector |
getVAMSASAsReference()
Method getVAMSASAsReference.Returns a reference to '_VAMSASList'. |
int |
getVAMSASCount()
Method getVAMSASCount. |
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 |
removeAllApplicationData()
|
void |
removeAllAttachment()
|
void |
removeAllVAMSAS()
|
boolean |
removeApplicationData(ApplicationData vApplicationData)
Method removeApplicationData. |
ApplicationData |
removeApplicationDataAt(int index)
Method removeApplicationDataAt. |
boolean |
removeAttachment(Attachment vAttachment)
Method removeAttachment. |
Attachment |
removeAttachmentAt(int index)
Method removeAttachmentAt. |
boolean |
removeVAMSAS(VAMSAS vVAMSAS)
Method removeVAMSAS. |
VAMSAS |
removeVAMSASAt(int index)
Method removeVAMSASAt. |
void |
setApplicationData(ApplicationData[] vApplicationDataArray)
|
void |
setApplicationData(int index,
ApplicationData vApplicationData)
|
void |
setApplicationData(java.util.Vector vApplicationDataList)
Sets the value of '_applicationDataList' by copying the given Vector. |
void |
setApplicationDataAsReference(java.util.Vector applicationDataVector)
Deprecated. |
void |
setAttachment(Attachment[] vAttachmentArray)
|
void |
setAttachment(int index,
Attachment vAttachment)
|
void |
setAttachment(java.util.Vector vAttachmentList)
Sets the value of '_attachmentList' by copying the given Vector. |
void |
setAttachmentAsReference(java.util.Vector attachmentVector)
Deprecated. |
void |
setLockFile(LockFile lockFile)
Sets the value of field 'lockFile'. |
void |
setProvenance(Provenance provenance)
Sets the value of field 'provenance'. |
void |
setVAMSAS(int index,
VAMSAS vVAMSAS)
|
void |
setVAMSAS(VAMSAS[] vVAMSASArray)
|
void |
setVAMSAS(java.util.Vector vVAMSASList)
Sets the value of '_VAMSASList' by copying the given Vector. |
void |
setVAMSASAsReference(java.util.Vector VAMSASVector)
Deprecated. |
void |
setVersion(java.lang.String version)
Sets the value of field 'version'. |
static VamsasDocument |
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 VamsasDocument()
Method Detail |
public void addApplicationData(ApplicationData vApplicationData) throws java.lang.IndexOutOfBoundsException
vApplicationData
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addApplicationData(int index, ApplicationData vApplicationData) throws java.lang.IndexOutOfBoundsException
index
- vApplicationData
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addAttachment(Attachment vAttachment) throws java.lang.IndexOutOfBoundsException
vAttachment
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addAttachment(int index, Attachment vAttachment) throws java.lang.IndexOutOfBoundsException
index
- vAttachment
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addVAMSAS(VAMSAS vVAMSAS) throws java.lang.IndexOutOfBoundsException
vVAMSAS
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void addVAMSAS(int index, VAMSAS vVAMSAS) throws java.lang.IndexOutOfBoundsException
index
- vVAMSAS
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic java.util.Enumeration enumerateApplicationData()
public java.util.Enumeration enumerateAttachment()
public java.util.Enumeration enumerateVAMSAS()
public boolean equals(java.lang.Object obj)
obj
-
public ApplicationData getApplicationData(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic ApplicationData[] getApplicationData()
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 getApplicationDataAsReference()
public int getApplicationDataCount()
public Attachment getAttachment(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic Attachment[] getAttachment()
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 getAttachmentAsReference()
public int getAttachmentCount()
public LockFile getLockFile()
public Provenance getProvenance()
public VAMSAS getVAMSAS(int index) throws java.lang.IndexOutOfBoundsException
index
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic VAMSAS[] getVAMSAS()
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 getVAMSASAsReference()
public int getVAMSASCount()
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 removeAllApplicationData()
public void removeAllAttachment()
public void removeAllVAMSAS()
public boolean removeApplicationData(ApplicationData vApplicationData)
vApplicationData
-
public ApplicationData removeApplicationDataAt(int index)
index
-
public boolean removeAttachment(Attachment vAttachment)
vAttachment
-
public Attachment removeAttachmentAt(int index)
index
-
public boolean removeVAMSAS(VAMSAS vVAMSAS)
vVAMSAS
-
public VAMSAS removeVAMSASAt(int index)
index
-
public void setApplicationData(int index, ApplicationData vApplicationData) throws java.lang.IndexOutOfBoundsException
index
- vApplicationData
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setApplicationData(ApplicationData[] vApplicationDataArray)
vApplicationDataArray
- public void setApplicationData(java.util.Vector vApplicationDataList)
vApplicationDataList
- the Vector to copy.public void setApplicationDataAsReference(java.util.Vector applicationDataVector)
applicationDataVector
- the Vector to set.public void setAttachment(int index, Attachment vAttachment) throws java.lang.IndexOutOfBoundsException
index
- vAttachment
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setAttachment(Attachment[] vAttachmentArray)
vAttachmentArray
- public void setAttachment(java.util.Vector vAttachmentList)
vAttachmentList
- the Vector to copy.public void setAttachmentAsReference(java.util.Vector attachmentVector)
attachmentVector
- the Vector to set.public void setLockFile(LockFile lockFile)
lockFile
- the value of field 'lockFile'.public void setProvenance(Provenance provenance)
provenance
- the value of field 'provenance'.public void setVAMSAS(int index, VAMSAS vVAMSAS) throws java.lang.IndexOutOfBoundsException
index
- vVAMSAS
-
java.lang.IndexOutOfBoundsException
- if the index given is outside the bounds of the collectionpublic void setVAMSAS(VAMSAS[] vVAMSASArray)
vVAMSASArray
- public void setVAMSAS(java.util.Vector vVAMSASList)
vVAMSASList
- the Vector to copy.public void setVAMSASAsReference(java.util.Vector VAMSASVector)
VAMSASVector
- the Vector to set.public void setVersion(java.lang.String version)
version
- the value of field 'version'.public static VamsasDocument 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 |