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

java.lang.Object
  uk.ac.leeds.ccg.andyt.projects.moses.utilities.AbstractLog
      uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractDataHandler
          uk.ac.leeds.ccg.andyt.projects.moses.io.AbstractCASDataHandler

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AbstractOutputDataHandler, CAS001DataHandler, CAS002DataHandler, CAS003DataHandler, CAS044DataHandler, CASAreaEastingNorthingDataHandler, CASDataHandler, CASDataHandler_GA_IPS, CASKS002DataHandler, CASKS006DataHandler, CASKS008DataHandler, CASKS010DataHandler, CASKS013DataHandler, CASKS015DataHandler, CASKS017DataHandler, CASKS020DataHandler, CASKS023DataHandler, CASKS09bDataHandler, CASKS09cDataHandler, CASKS12bDataHandler, CASKS12cDataHandler, CASKS14bDataHandler, CASKS14cDataHandler, CASUV003DataHandler, MarkOutputDataHandler_1, MarkOutputDataHandler_2, SWSDataHandler, ToyModelDataHandler, ToyModelHSARDataHandler

public abstract class AbstractCASDataHandler
extends AbstractDataHandler

For handling AbstractCASDataRecords.

See Also:

AbstractCASDataRecord, Serialized Form

Field Summary

protected CAS001DataHandler	_CAS001DataHandler CAS001DataHandler
protected CAS003DataHandler	_CAS003DataHandler CAS003DataHandler
protected java.util.HashMap	_LookUpMSOAfromOAHashMap For storing a look up table for converting from OA to MSOA Zone Code
protected java.util.HashMap	_RecordIDZoneCodeHashMap For storing a one to one mapping of: long AbstractCASDataRecord.RecordID as keys and String Zone Code as values.

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

_Directory, _File, _RandomAccessFile, _RecordLength

Fields inherited from class uk.ac.leeds.ccg.andyt.projects.moses.utilities.AbstractLog

_Logger, _Logger_FileHandler

Constructor Summary

AbstractCASDataHandler()

Method Summary

java.util.HashMap<java.lang.String,java.lang.String>	get_LookUpMSOAfromOAHashMap() TODO docs
CAS001DataHandler	getCAS001DataHandler() Returns this._CAS001DataHandler
CAS003DataHandler	getCAS003DataHandler() Returns this._CAS003DataHandler
protected AbstractCASDataRecord	getDataRecord(char[] Zone_Code)
abstract AbstractCASDataRecord	getDataRecord(long RecordID)
AbstractCASDataRecord	getDataRecord(java.lang.String aZoneCode)
java.util.TreeSet<java.lang.String>	getLADCodes_TreeSet()
java.util.HashSet<java.lang.String>	getMSOACodes_HashSet()
java.util.HashSet	getMSOACodes_HashSet(java.lang.String startOfMSOACodes_String)
java.util.HashSet<java.lang.String>	getOACodes_HashSet()
java.util.HashSet	getOACodes_HashSet(java.lang.String startOfOACodes_String)
java.util.TreeSet<java.lang.String>	getOACodes_TreeSet()
java.util.HashMap	getRecordIDZoneCode_HashMap()
protected java.util.HashMap	getRecordIDZoneCodeHashMap()
java.util.HashMap	getZoneCodeRecordID_HashMap()
protected static java.lang.Object[]	parseLine(java.lang.String line) TODO docs
void	printOAMSOACodes(long startRecordID, long endRecordID) For checking OA MSOA Codes
void	write(java.io.RandomAccessFile aRandomAccessFile, java.util.TreeMap aggregateOAToMSOA) Writes aggregateOAToMSOA to aRandomAccessFile

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

get_Directory, get_RecordLength, getNDataRecords, init, init, load, print

Methods inherited from class uk.ac.leeds.ccg.andyt.projects.moses.utilities.AbstractLog

init_Logger, init_Logger, init_Logger, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_CAS001DataHandler

protected CAS001DataHandler _CAS001DataHandler

CAS001DataHandler

_CAS003DataHandler

protected CAS003DataHandler _CAS003DataHandler

CAS003DataHandler

_RecordIDZoneCodeHashMap

protected java.util.HashMap _RecordIDZoneCodeHashMap

For storing a one to one mapping of: long AbstractCASDataRecord.RecordID as keys and String Zone Code as values.

_LookUpMSOAfromOAHashMap

protected java.util.HashMap _LookUpMSOAfromOAHashMap

For storing a look up table for converting from OA to MSOA Zone Code

Constructor Detail

AbstractCASDataHandler

public AbstractCASDataHandler()

Method Detail

getCAS001DataHandler

public CAS001DataHandler getCAS001DataHandler()

Returns this._CAS001DataHandler

getCAS003DataHandler

public CAS003DataHandler getCAS003DataHandler()

Returns this._CAS003DataHandler

getDataRecord

public abstract AbstractCASDataRecord getDataRecord(long RecordID)

Specified by:

getDataRecord in class AbstractDataHandler

Parameters:

RecordID - The RecordID of the AbstractCASDataRecord to be returned.

Returns:

An AbstractCASDataRecord for the given RecordID

getDataRecord

public AbstractCASDataRecord getDataRecord(java.lang.String aZoneCode)

Parameters:

aZoneCode - A String representation of an AbstractCASDataRecord.Zone_Code for the AbstractCASDataRecord to be returned.

Returns:

An AbstractCASDataRecord for the given zoneCode if it exists or null otherwise.

getDataRecord

protected AbstractCASDataRecord getDataRecord(char[] Zone_Code)
                                       throws java.io.IOException

Parameters:

Zone_Code - A AbstractCASDataRecord.Zone_Code for the AbstractCASDataRecord to be returned.

Returns:

An AbstractCASDataRecord for the given Zone_Code if it exists or null otherwise.

Throws:

java.io.IOException

getRecordIDZoneCodeHashMap

protected java.util.HashMap getRecordIDZoneCodeHashMap()

Returns:

this.tRecordIDZoneCodeHashMap

getRecordIDZoneCode_HashMap

public java.util.HashMap getRecordIDZoneCode_HashMap()

Returns:

deep copy of this.tRecordIDZoneCodeHashMap

getZoneCodeRecordID_HashMap

public java.util.HashMap getZoneCodeRecordID_HashMap()

Returns:

this.tRecordIDZoneCodeHashMap with keys and values deep copied and swapped around

get_LookUpMSOAfromOAHashMap

public java.util.HashMap<java.lang.String,java.lang.String> get_LookUpMSOAfromOAHashMap()

TODO docs

parseLine

protected static java.lang.Object[] parseLine(java.lang.String line)

TODO docs

printOAMSOACodes

public void printOAMSOACodes(long startRecordID,
                             long endRecordID)
                      throws java.lang.Exception

For checking OA MSOA Codes

Parameters:

startRecordID - The RecordID of the first OA code to check

endRecordID - The RecordID of the last OA code to check

Throws:

java.lang.Exception

getLADCodes_TreeSet

public java.util.TreeSet<java.lang.String> getLADCodes_TreeSet()
                                                        throws java.io.IOException

Throws:

java.io.IOException

getOACodes_TreeSet

public java.util.TreeSet<java.lang.String> getOACodes_TreeSet()

Returns:

A TreeSet of all OA Codes in the UK.

getOACodes_HashSet

public java.util.HashSet<java.lang.String> getOACodes_HashSet()

Returns:

A HashSet of all OA Codes in the UK.

getMSOACodes_HashSet

public java.util.HashSet<java.lang.String> getMSOACodes_HashSet()

Returns:

A HashSet of all MSOA Codes in the UK.

getOACodes_HashSet

public java.util.HashSet getOACodes_HashSet(java.lang.String startOfOACodes_String)

Parameters:

startOfOACodes_String -

Returns:

A HashSet of Output Area Codes that start with startOfOACodes_String

getMSOACodes_HashSet

public java.util.HashSet getMSOACodes_HashSet(java.lang.String startOfMSOACodes_String)

Parameters:

startOfOACodes_String -

Returns:

A HashSet of Output Area Codes that start with startOfOACodes_String

write

public void write(java.io.RandomAccessFile aRandomAccessFile,
                  java.util.TreeMap aggregateOAToMSOA)
           throws java.io.IOException

Writes aggregateOAToMSOA to aRandomAccessFile

Parameters:

aRandomAccessFile -

aggregateOAToMSOA -

Throws:

java.io.IOException