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

java.lang.Object
  uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractDataRecord
      uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractCASDataRecord
          uk.ac.leeds.ccg.andyt.projects.moses.io.CASKS023DataRecord

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class CASKS023DataRecord
extends AbstractCASDataRecord

For representing CAS KS023 Records and providing safe access to the data.

See Also:

Serialized Form

Field Summary

protected int	allCommunalEstablishments KS0230001 = allCommunalEstablishments
protected int	numberOfResidents KS0230002 = householdsComprisingOnePensioner

Fields inherited from class uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractCASDataRecord

Zone_Code

Fields inherited from class uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractDataRecord

_RecordID

Constructor Summary

CASKS023DataRecord()
Creates a new CASKS023Record

CASKS023DataRecord(CASKS023DataRecord cASKS023Record)
Creates a new CASKS023Record cloned from cASKS023Record

CASKS023DataRecord(long RecordID, java.lang.String line)
Creates a new CASKS023DataRecord

CASKS023DataRecord(java.io.RandomAccessFile aRandomAccessFile)
Creates a new CASKS017Record

Method Summary

protected void	_Init() Initialises all fields.
CASKS023DataRecord	aggregate(CASKS023DataRecord aCASKS023DataRecord)
CASKS023DataRecord	aggregate(CASKS023DataRecord aCASKS023DataRecord, long newRecordID, char[] newZone_Code)
int	getAllCommunalEstablishments() Returns a copy of this.allCommunalEstablishments
int	getNumberOfResidents() Returns a copy of this.numberOfResidents
long	getSizeInBytes() Returns the size of this Record in bytes as a long.
protected void	init(CASKS023DataRecord cASKS023Record) Initialises all fields from those in cASKS023Record.
java.lang.String	toCSVString()
java.lang.String	toCSVStringFields()
java.lang.String	toString() Returns a string description of this;
void	write(java.io.RandomAccessFile aRandomAccessFile) Writes this to aRandomAccessFile at the current position.
void	write(java.io.RandomAccessFile aRandomAccessFile, boolean avoidCallToSuper) Writes this to aRandomAccessFile at the current position.

Methods inherited from class uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractCASDataRecord

equals, getZone_Code, hashCode, init, write

Methods inherited from class uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractDataRecord

_Init, compareTo, get_RecordID, getNumberOfBitsInByte

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

allCommunalEstablishments

protected int allCommunalEstablishments

KS0230001 = allCommunalEstablishments

numberOfResidents

protected int numberOfResidents

KS0230002 = householdsComprisingOnePensioner

Constructor Detail

CASKS023DataRecord

public CASKS023DataRecord()

Creates a new CASKS023Record

CASKS023DataRecord

public CASKS023DataRecord(CASKS023DataRecord cASKS023Record)

Creates a new CASKS023Record cloned from cASKS023Record

Parameters:

cASKS023Record - The CASKS023Record from which this is cloned.

CASKS023DataRecord

public CASKS023DataRecord(long RecordID,
                          java.lang.String line)
                   throws java.io.IOException

Creates a new CASKS023DataRecord

Parameters:

RecordID - The RecordID to be assigned to this

line - The Comma Seperated Value String

Throws:

java.io.IOException

CASKS023DataRecord

public CASKS023DataRecord(java.io.RandomAccessFile aRandomAccessFile)
                   throws java.io.IOException

Creates a new CASKS017Record

Parameters:

aRandomAccessFile -

Throws:

java.io.IOException

Method Detail

_Init

protected void _Init()

Initialises all fields.

Overrides:

_Init in class AbstractCASDataRecord

init

protected void init(CASKS023DataRecord cASKS023Record)

Initialises all fields from those in cASKS023Record.

Parameters:

cASKS023Record - The CASKS023Record thats fields are used to initialise this.

toString

public java.lang.String toString()

Returns a string description of this;

Overrides:

toString in class AbstractCASDataRecord

Returns:

A String description of this.

toCSVString

public java.lang.String toCSVString()

Overrides:

toCSVString in class AbstractCASDataRecord

Returns:

A Comma Seperated Version (CSV) String of the values of the Fields of this.

toCSVStringFields

public java.lang.String toCSVStringFields()

Overrides:

toCSVStringFields in class AbstractCASDataRecord

Returns:

A Comma Seperated Version (CSV) String of the names of the Fields of this

getAllCommunalEstablishments

public int getAllCommunalEstablishments()

Returns a copy of this.allCommunalEstablishments

getNumberOfResidents

public int getNumberOfResidents()

Returns a copy of this.numberOfResidents

write

public void write(java.io.RandomAccessFile aRandomAccessFile)

Writes this to aRandomAccessFile at the current position.

Overrides:

write in class AbstractCASDataRecord

Parameters:

aRandomAccessFile - The RandomAccessFile this is written to.

See Also:

AbstractDataRecord.write(RandomAccessFile)

write

public void write(java.io.RandomAccessFile aRandomAccessFile,
                  boolean avoidCallToSuper)

Writes this to aRandomAccessFile at the current position.

Parameters:

aRandomAccessFile - The RandomAccessFile this is written to.

avoidCallToSuper - If true super.write() is not called

aggregate

public CASKS023DataRecord aggregate(CASKS023DataRecord aCASKS023DataRecord)

Parameters:

aCASKS023DataRecord - The CASKS023DataRecord to be aggregated with this.

Returns:

An aggregated CASKS023DataRecord where: RecordID = this.RecordID Zone_Code = this.Zone_Code For aggregating CASKS023DataRecords. User needs to take care in aggregating to ensure aggregation does not compromise (introduce error) based on the numbers used (i.e. numbers may not be precise or have sufficient magnitude).

aggregate

public CASKS023DataRecord aggregate(CASKS023DataRecord aCASKS023DataRecord,
                                    long newRecordID,
                                    char[] newZone_Code)

Parameters:

aCASKS023DataRecord - The CASKS023DataRecord to be aggregated with this.

newRecordID - The RecordID assigned to result.

newZone_Code - The Zone_Code assigned to result.

Returns:

An aggregated CASKS023DataRecord where: RecordID = newRecordID Zone_Code = newZone_Code For aggregating CASKS023DataRecords. User needs to take care in aggregating to ensure aggregation does not compromise (introduce error) based on the numbers used (i.e. numbers may not be precise or have sufficient magnitude).

getSizeInBytes

public long getSizeInBytes()

Returns the size of this Record in bytes as a long. This does not account for serialVersionUID. A boolean is assumed to be the same size as an int in bytes.

Overrides:

getSizeInBytes in class AbstractCASDataRecord

Returns:

The size (in bytes) of this as a long. This does not account for the private Fields serialVersionUID.