uk.ac.vamsas.objects.core
Class Entry

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

public class Entry
extends Vobject
implements java.io.Serializable

Class Entry.

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
Entry()
           
 
Method Summary
 void addInput(Input vInput)
           
 void addInput(int index, Input vInput)
           
 void addParam(int index, Param vParam)
           
 void addParam(Param vParam)
           
 void addProperty(int index, Property vProperty)
           
 void addProperty(Property vProperty)
           
 java.util.Enumeration enumerateInput()
          Method enumerateInput.
 java.util.Enumeration enumerateParam()
          Method enumerateParam.
 java.util.Enumeration enumerateProperty()
          Method enumerateProperty.
 boolean equals(java.lang.Object obj)
          Overrides the java.lang.Object.equals method.
 java.lang.String getAction()
          Returns the value of field 'action'.
 java.lang.String getApp()
          Returns the value of field 'app'.
 java.util.Date getDate()
          Returns the value of field 'date'.
 java.lang.String getId()
          Returns the value of field 'id'.
 Input[] getInput()
          Method getInput.Returns the contents of the collection in an Array.
 Input getInput(int index)
          Method getInput.
 java.util.Vector getInputAsReference()
          Method getInputAsReference.Returns a reference to '_inputList'.
 int getInputCount()
          Method getInputCount.
 Param[] getParam()
          Method getParam.Returns the contents of the collection in an Array.
 Param getParam(int index)
          Method getParam.
 java.util.Vector getParamAsReference()
          Method getParamAsReference.Returns a reference to '_paramList'.
 int getParamCount()
          Method getParamCount.
 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 getUser()
          Returns the value of field 'user'.
 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 removeAllInput()
           
 void removeAllParam()
           
 void removeAllProperty()
           
 boolean removeInput(Input vInput)
          Method removeInput.
 Input removeInputAt(int index)
          Method removeInputAt.
 boolean removeParam(Param vParam)
          Method removeParam.
 Param removeParamAt(int index)
          Method removeParamAt.
 boolean removeProperty(Property vProperty)
          Method removeProperty.
 Property removePropertyAt(int index)
          Method removePropertyAt.
 void setAction(java.lang.String action)
          Sets the value of field 'action'.
 void setApp(java.lang.String app)
          Sets the value of field 'app'.
 void setDate(java.util.Date date)
          Sets the value of field 'date'.
 void setId(java.lang.String id)
          Sets the value of field 'id'.
 void setInput(Input[] vInputArray)
           
 void setInput(int index, Input vInput)
           
 void setInput(java.util.Vector vInputList)
          Sets the value of '_inputList' by copying the given Vector.
 void setInputAsReference(java.util.Vector inputVector)
          Deprecated.  
 void setParam(int index, Param vParam)
           
 void setParam(Param[] vParamArray)
           
 void setParam(java.util.Vector vParamList)
          Sets the value of '_paramList' by copying the given Vector.
 void setParamAsReference(java.util.Vector paramVector)
          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 setUser(java.lang.String user)
          Sets the value of field 'user'.
static Entry 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

Entry

public Entry()
Method Detail

addInput

public void addInput(Input vInput)
              throws java.lang.IndexOutOfBoundsException
Parameters:
vInput -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addInput

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

addParam

public void addParam(Param vParam)
              throws java.lang.IndexOutOfBoundsException
Parameters:
vParam -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addParam

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

addProperty

public void addProperty(Property vProperty)
                 throws java.lang.IndexOutOfBoundsException
Parameters:
vProperty -
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

addProperty

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

enumerateInput

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

Returns:
an Enumeration over all uk.ac.vamsas.objects.core.Input elements

enumerateParam

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

Returns:
an Enumeration over all uk.ac.vamsas.objects.core.Param elements

enumerateProperty

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

Returns:
an Enumeration over all uk.ac.vamsas.objects.core.Property elements

equals

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

Parameters:
obj -
Returns:
true if the objects are equal.

getAction

public java.lang.String getAction()
Returns the value of field 'action'. The field 'action' has the following description: Did what

Returns:
the value of field 'Action'.

getApp

public java.lang.String getApp()
Returns the value of field 'app'. The field 'app' has the following description: With which application

Returns:
the value of field 'App'.

getDate

public java.util.Date getDate()
Returns the value of field 'date'. The field 'date' has the following description: When

Returns:
the value of field 'Date'.

getId

public java.lang.String getId()
Returns the value of field 'id'. The field 'id' has the following description: Primary Key for vamsas object referencing

Returns:
the value of field 'Id'.

getInput

public Input getInput(int index)
               throws java.lang.IndexOutOfBoundsException
Method getInput.

Parameters:
index -
Returns:
the value of the uk.ac.vamsas.objects.core.Input at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getInput

public Input[] getInput()
Method getInput.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

getInputAsReference

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

Returns:
a reference to the Vector backing this class

getInputCount

public int getInputCount()
Method getInputCount.

Returns:
the size of this collection

getParam

public Param getParam(int index)
               throws java.lang.IndexOutOfBoundsException
Method getParam.

Parameters:
index -
Returns:
the value of the uk.ac.vamsas.objects.core.Param at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getParam

public Param[] getParam()
Method getParam.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

getParamAsReference

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

Returns:
a reference to the Vector backing this class

getParamCount

public int getParamCount()
Method getParamCount.

Returns:
the size of this collection

getProperty

public Property getProperty(int index)
                     throws java.lang.IndexOutOfBoundsException
Method getProperty.

Parameters:
index -
Returns:
the value of the uk.ac.vamsas.objects.core.Property at the given index
Throws:
java.lang.IndexOutOfBoundsException - if the index given is outside the bounds of the collection

getProperty

public Property[] getProperty()
Method getProperty.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

getPropertyAsReference

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

Returns:
a reference to the Vector backing this class

getPropertyCount

public int getPropertyCount()
Method getPropertyCount.

Returns:
the size of this collection

getUser

public java.lang.String getUser()
Returns the value of field 'user'. The field 'user' has the following description: Who

Returns:
the value of field 'User'.

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 Vobject
Returns:
a hash code value for the object.

isValid

public boolean isValid()
Method isValid.

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
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
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

removeAllInput

public void removeAllInput()

removeAllParam

public void removeAllParam()

removeAllProperty

public void removeAllProperty()

removeInput

public boolean removeInput(Input vInput)
Method removeInput.

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

removeInputAt

public Input removeInputAt(int index)
Method removeInputAt.

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

removeParam

public boolean removeParam(Param vParam)
Method removeParam.

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

removeParamAt

public Param removeParamAt(int index)
Method removeParamAt.

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

removeProperty

public boolean removeProperty(Property vProperty)
Method removeProperty.

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

removePropertyAt

public Property removePropertyAt(int index)
Method removePropertyAt.

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

setAction

public void setAction(java.lang.String action)
Sets the value of field 'action'. The field 'action' has the following description: Did what

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

setApp

public void setApp(java.lang.String app)
Sets the value of field 'app'. The field 'app' has the following description: With which application

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

setDate

public void setDate(java.util.Date date)
Sets the value of field 'date'. The field 'date' has the following description: When

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

setId

public void setId(java.lang.String id)
Sets the value of field 'id'. The field 'id' has the following description: Primary Key for vamsas object referencing

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

setInput

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

setInput

public void setInput(Input[] vInputArray)
Parameters:
vInputArray -

setInput

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

Parameters:
vInputList - the Vector to copy.

setInputAsReference

public void setInputAsReference(java.util.Vector inputVector)
Deprecated.  

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

Parameters:
inputVector - the Vector to set.

setParam

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

setParam

public void setParam(Param[] vParamArray)
Parameters:
vParamArray -

setParam

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

Parameters:
vParamList - the Vector to copy.

setParamAsReference

public void setParamAsReference(java.util.Vector paramVector)
Deprecated.  

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

Parameters:
paramVector - the Vector to set.

setProperty

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

setProperty

public void setProperty(Property[] vPropertyArray)
Parameters:
vPropertyArray -

setProperty

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

Parameters:
vPropertyList - the Vector to copy.

setPropertyAsReference

public void setPropertyAsReference(java.util.Vector propertyVector)
Deprecated.  

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

Parameters:
propertyVector - the Vector to set.

setUser

public void setUser(java.lang.String user)
Sets the value of field 'user'. The field 'user' has the following description: Who

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

unmarshal

public static Entry 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.Entry
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
Throws:
org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema