uk.ac.leeds.ccg.andyt.projects.moses.io
Class AbstractDataRecord

java.lang.Object
  extended by uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractDataRecord
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable
Direct Known Subclasses:
AbstractCASDataRecord, HSARDataRecord, ISARDataRecord

public abstract class AbstractDataRecord
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

Abstract class for a data record.

See Also:
Serialized Form

Field Summary
protected  long _RecordID
          An individual sequencial identifier.
 
Constructor Summary
AbstractDataRecord()
           
 
Method Summary
protected  void _Init()
          Initialise.
protected  void _Init(AbstractDataRecord aAbstractDataRecord)
          Initialise from aAbstractDataRecord.
 int compareTo(java.lang.Object object)
          Method required by Comparable
 boolean equals(java.lang.Object object)
           
 long get_RecordID()
           
static long getNumberOfBitsInByte()
           
 long getSizeInBytes()
           
 int hashCode()
           
 java.lang.String toCSVString()
           
 java.lang.String toCSVStringFields()
           
 java.lang.String toString()
           
 void write(java.io.RandomAccessFile aRandomAccessFile)
          Writes out: this._RecordID as a long this.hashCode as a int to aRandomAccessFile.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

_RecordID

protected long _RecordID
An individual sequencial identifier.

Constructor Detail

AbstractDataRecord

public AbstractDataRecord()
Method Detail

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getNumberOfBitsInByte

public static long getNumberOfBitsInByte()
Returns:
8 (assumed to be the number of bits in a byte).

get_RecordID

public long get_RecordID()
Returns:
A copy of this._RecordID

_Init

protected void _Init(AbstractDataRecord aAbstractDataRecord)
Initialise from aAbstractDataRecord.


_Init

protected void _Init()
Initialise.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
A String description of this.

toCSVString

public java.lang.String toCSVString()
Returns:
A Comma Seperated Version (CSV) String of the values of the Fields of this.

toCSVStringFields

public java.lang.String toCSVStringFields()
Returns:
A Comma Seperated Version (CSV) String of the names of the Variables as returned in toString().

write

public void write(java.io.RandomAccessFile aRandomAccessFile)
           throws java.io.IOException
Writes out: to aRandomAccessFile.

Parameters:
aRandomAccessFile - The RandomAccessFile written to.
Throws:
java.io.IOException

equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class java.lang.Object
See Also:
Object.equals(Object)

compareTo

public int compareTo(java.lang.Object object)
Method required by Comparable

Specified by:
compareTo in interface java.lang.Comparable
See Also:
Comparable.compareTo(Object)

getSizeInBytes

public long getSizeInBytes()
Returns:
The size (in bytes) of this as a long.