uk.ac.vamsas.objects.core
Class MapList

java.lang.Object
  extended byuk.ac.vamsas.client.Vobject
      extended byuk.ac.vamsas.objects.core.MapList
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Mapping

public class MapList
extends Vobject
implements java.io.Serializable

Class MapList.

Version:
$Revision$ $Date$
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
MapList()
           
 
Method Summary
 void deleteEnd()
           
 void deleteFrom()
           
 void deleteStart()
           
 void deleteTo()
           
 boolean equals(java.lang.Object obj)
          Overrides the java.lang.Object.equals method.
 long getEnd()
          Returns the value of field 'end'.
 long getFrom()
          Returns the value of field 'from'.
 long getStart()
          Returns the value of field 'start'.
 long getTo()
          Returns the value of field 'to'.
 boolean hasEnd()
          Method hasEnd.
 boolean hasFrom()
          Method hasFrom.
 int hashCode()
          Overrides the java.lang.Object.hashCode method.
 boolean hasStart()
          Method hasStart.
 boolean hasTo()
          Method hasTo.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setEnd(long end)
          Sets the value of field 'end'.
 void setFrom(long from)
          Sets the value of field 'from'.
 void setStart(long start)
          Sets the value of field 'start'.
 void setTo(long to)
          Sets the value of field 'to'.
static MapList 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

MapList

public MapList()
Method Detail

deleteEnd

public void deleteEnd()

deleteFrom

public void deleteFrom()

deleteStart

public void deleteStart()

deleteTo

public void deleteTo()

equals

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

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

getEnd

public long getEnd()
Returns the value of field 'end'. The field 'end' has the following description: Offset to last position in database entry that last (offset) position in sequence maps to

Returns:
the value of field 'End'.

getFrom

public long getFrom()
Returns the value of field 'from'. The field 'from' has the following description: Offset to first position in dataset sequence record that start position on 'onto' maps to

Returns:
the value of field 'From'.

getStart

public long getStart()
Returns the value of field 'start'. The field 'start' has the following description: Offset to first position in database entry that first (or offset) position in sequence maps to

Returns:
the value of field 'Start'.

getTo

public long getTo()
Returns the value of field 'to'. The field 'to' has the following description: Offset to last position in dataset sequence record that end position on 'onto' maps to

Returns:
the value of field 'To'.

hasEnd

public boolean hasEnd()
Method hasEnd.

Returns:
true if at least one End has been added

hasFrom

public boolean hasFrom()
Method hasFrom.

Returns:
true if at least one From has been added

hasStart

public boolean hasStart()
Method hasStart.

Returns:
true if at least one Start has been added

hasTo

public boolean hasTo()
Method hasTo.

Returns:
true if at least one To has been added

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

setEnd

public void setEnd(long end)
Sets the value of field 'end'. The field 'end' has the following description: Offset to last position in database entry that last (offset) position in sequence maps to

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

setFrom

public void setFrom(long from)
Sets the value of field 'from'. The field 'from' has the following description: Offset to first position in dataset sequence record that start position on 'onto' maps to

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

setStart

public void setStart(long start)
Sets the value of field 'start'. The field 'start' has the following description: Offset to first position in database entry that first (or offset) position in sequence maps to

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

setTo

public void setTo(long to)
Sets the value of field 'to'. The field 'to' has the following description: Offset to last position in dataset sequence record that end position on 'onto' maps to

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

unmarshal

public static MapList 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.MapList
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