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

java.lang.Object
  extended by uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractDataRecord
      extended by uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractCASDataRecord
          extended by uk.ac.leeds.ccg.andyt.projects.moses.io.CASKS016DataRecord
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable

public class CASKS016DataRecord
extends AbstractCASDataRecord

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

See Also:
Serialized Form

Field Summary
protected  int allHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure
          KS0160010 =allHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure
protected  int allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding
          KS0160009 =allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding
protected  int allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits
          KS0160008 =allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits
protected  int allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement
          KS0160007 =allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement
protected  int allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowDetached
          KS0160004 = allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowDetached
protected  int allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowSemiDetached
          KS0160005 = allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowSemiDetached
protected  int allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace
          KS0160006 =allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace
protected  int allHouseholdSpacesWithNoResidentsSecondResidenceHolidayAccommodation
          KS0160003 = allHouseholdSpacesWithNoResidentsSecondResidenceHolidayAccommodation
protected  int allHouseholdSpacesWithNoResidentsVacant
          KS0160002 = allHouseholdSpacesWithNoResidentsVacant
protected  int allHouseholdSpacesWithResidents
          KS0160001 = allHouseholdSpacesWithResidents
 
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
CASKS016DataRecord()
          Creates a new CASKS12bRecord
CASKS016DataRecord(boolean initZero)
          Creates a new CASKS016DataRecord
CASKS016DataRecord(CASKS016DataRecord aCASKS016Record)
          Creates a new CASKS016Record cloned from aCASKS016Record
CASKS016DataRecord(java.io.RandomAccessFile aRandomAccessFile)
          Creates a new CASKS016Record
 
Method Summary
protected  void _Init()
          Initialises.
 CASKS016DataRecord aggregate(CASKS016DataRecord aCASKS016DataRecord)
           
 CASKS016DataRecord aggregate(CASKS016DataRecord aCASKS016DataRecord, long newRecordID, char[] newZone_Code)
           
 int getAllHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure()
          Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure
 int getAllHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding()
          Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding
 int getAllHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits()
          Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits
 int getAllHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement()
          Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement
 int getAllHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowDetached()
          Returns a copy of this.
 int getAllHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowSemiDetached()
          Returns a copy of this.
 int getAllHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace()
          Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace
 int getAllHouseholdSpacesWithNoResidentsSecondResidenceHolidayAccommodation()
          Returns a copy of this.
 int getAllHouseholdSpacesWithNoResidentsVacant()
          Returns a copy of this.allHouseholdSpacesWithNoResidentsVacant
 int getAllHouseholdSpacesWithResidents()
          Returns a copy of this.allHouseholdSpacesWithResidents
 long getSizeInBytes()
          Returns the size of this Record in bytes as a long.
protected  void initZero()
          Initialises to zero.
 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

allHouseholdSpacesWithResidents

protected int allHouseholdSpacesWithResidents
KS0160001 = allHouseholdSpacesWithResidents


allHouseholdSpacesWithNoResidentsVacant

protected int allHouseholdSpacesWithNoResidentsVacant
KS0160002 = allHouseholdSpacesWithNoResidentsVacant


allHouseholdSpacesWithNoResidentsSecondResidenceHolidayAccommodation

protected int allHouseholdSpacesWithNoResidentsSecondResidenceHolidayAccommodation
KS0160003 = allHouseholdSpacesWithNoResidentsSecondResidenceHolidayAccommodation


allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowDetached

protected int allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowDetached
KS0160004 = allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowDetached


allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowSemiDetached

protected int allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowSemiDetached
KS0160005 = allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowSemiDetached


allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace

protected int allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace
KS0160006 =allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace


allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement

protected int allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement
KS0160007 =allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement


allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits

protected int allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits
KS0160008 =allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits


allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding

protected int allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding
KS0160009 =allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding


allHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure

protected int allHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure
KS0160010 =allHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure

Constructor Detail

CASKS016DataRecord

public CASKS016DataRecord()
Creates a new CASKS12bRecord


CASKS016DataRecord

public CASKS016DataRecord(CASKS016DataRecord aCASKS016Record)
Creates a new CASKS016Record cloned from aCASKS016Record

Parameters:
aCASKS016Record - The CASKS016Record from which this is cloned.

CASKS016DataRecord

public CASKS016DataRecord(boolean initZero)
Creates a new CASKS016DataRecord

Parameters:
initZero - To ensure initZero() is used instead of _Init()

CASKS016DataRecord

public CASKS016DataRecord(java.io.RandomAccessFile aRandomAccessFile)
Creates a new CASKS016Record

Parameters:
aRandomAccessFile -
Method Detail

_Init

protected void _Init()
Initialises.

Overrides:
_Init in class AbstractCASDataRecord

initZero

protected void initZero()
Initialises to zero.


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

getAllHouseholdSpacesWithResidents

public int getAllHouseholdSpacesWithResidents()
Returns a copy of this.allHouseholdSpacesWithResidents


getAllHouseholdSpacesWithNoResidentsVacant

public int getAllHouseholdSpacesWithNoResidentsVacant()
Returns a copy of this.allHouseholdSpacesWithNoResidentsVacant


getAllHouseholdSpacesWithNoResidentsSecondResidenceHolidayAccommodation

public int getAllHouseholdSpacesWithNoResidentsSecondResidenceHolidayAccommodation()
Returns a copy of this. allHouseholdSpacesWithNoResidentsSecondResidenceHolidayAccommodation


getAllHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowDetached

public int getAllHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowDetached()
Returns a copy of this. allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowDetached


getAllHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowSemiDetached

public int getAllHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowSemiDetached()
Returns a copy of this. allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowSemiDetached


getAllHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace

public int getAllHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace()
Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeWholeHouseOrbungalowTerracedIncludingEndTerrace


getAllHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement

public int getAllHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement()
Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPurposeBuiltBlockOfFlatsOrTenement


getAllHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits

public int getAllHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits()
Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentPartOfAConvertedOrSharedHouseIncludingBedSits


getAllHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding

public int getAllHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding()
Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeFlatMaisonetteOrApartmentInACommercialBuilding


getAllHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure

public int getAllHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure()
Returns a copy of this.allHouseholdSpacesWhichAreOfAccommodationTypeCaravanOrOtherMobileOrTemporaryStructure


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 CASKS016DataRecord aggregate(CASKS016DataRecord aCASKS016DataRecord)
Parameters:
aCASKS016DataRecord - The CASKS016DataRecord to be aggregated with this.
Returns:
An aggregated CASKS016DataRecord where: RecordID = this.RecordID Zone_Code = this.Zone_Code For aggregating CASKS016DataRecords. 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 CASKS016DataRecord aggregate(CASKS016DataRecord aCASKS016DataRecord,
                                    long newRecordID,
                                    char[] newZone_Code)
Parameters:
aCASKS016DataRecord - The CASKS016DataRecord to be aggregated with this.
newRecordID - The RecordID assigned to result.
newZone_Code - The Zone_Code assigned to result.
Returns:
An aggregated CASKS016DataRecord where: RecordID = newRecordID Zone_Code = newZone_Code For aggregating CASKS016DataRecords. 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.