org.tridas.io.formats.catras
Class CatrasReader

java.lang.Object
  org.tridas.io.AbstractDendroFileReader
      org.tridas.io.formats.catras.CatrasReader

public class CatrasReader
extends AbstractDendroFileReader

Author:

peterbrewer

Constructor Summary

CatrasReader()

Method Summary

protected void	checkFile(byte[] argFileBytes) Check this is a valid CATRAS file
int	getCurrentLineNumber() Gets the current line number of the reader.
IMetadataFieldSet	getDefaults() Get the default values for this reader that were given in loading the file.
DendroFileFilter	getDendroFileFilter()
String	getDescription() Get the description of the format
String[]	getFileExtensions() Returns a list of the file extensions for this file
String	getFullName() Get the full name of the format
static int	getIntFromByte(byte argByte) Extract a single integer value from a byte
static int	getIntFromBytePair(byte[] wBytes, Boolean littleEndian) Extract the integer value from a byte pair according to endianess Horror! Java byte is signed! See: http://www.darksleep.com/player/JavaAndUnsignedTypes.html
org.tridas.schema.TridasProject[]	getProjects() Gets the parsed projects after they are loaded.
String	getShortName() Get the short name of the format
org.tridas.schema.TridasTridas	getTridasContainer()
void	loadFile(byte[] argFileBytes)
void	loadFile(byte[] argFileBytes, IMetadataFieldSet argDefaults)
void	loadFile(String[] argFileStrings) Loads a file just from the strings, using the default metadata
void	loadFile(String argFilename, IMetadataFieldSet argDefaultFields) Load a file from the given filename or url, and the given defaults.
void	loadFile(String argPath, String argFilename, IMetadataFieldSet argDefaultFields) Loads a file from the given path, filename, and defaults.
protected void	parseFile(byte[] argFileBytes, IMetadataFieldSet argDefaultFields)
protected void	parseFile(String[] argFileString, IMetadataFieldSet argDefaultFields) Parse the file from the given metadata and strings
protected void	resetReader() Reset the reader

Methods inherited from class org.tridas.io.AbstractDendroFileReader

addWarning, clearWarnings, constructDefaultMetadata, getDefaultFieldsClass, getOriginalFilename, getWarnings, loadFile, loadFile, loadFile, reset, setOriginalFilename

Methods inherited from class java.lang.Object

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

Constructor Detail

CatrasReader

public CatrasReader()

Method Detail

loadFile

public void loadFile(String argFilename,
                     IMetadataFieldSet argDefaultFields)
              throws IOException,
                     IncorrectDefaultFieldsException,
                     InvalidDendroFileException

Description copied from class: AbstractDendroFileReader

Load a file from the given filename or url, and the given defaults. Override this method and AbstractDendroFileReader.loadFile(String, String, IMetadataFieldSet) to load files that aren't strings.

Overrides:

loadFile in class AbstractDendroFileReader

Throws:

IncorrectDefaultFieldsException

InvalidDendroFileException

IOException - if the file could not be loaded

See Also:

org.tridas.io.IDendroCollectionWriter#loadFile(java.lang.String)

loadFile

public void loadFile(String argPath,
                     String argFilename,
                     IMetadataFieldSet argDefaultFields)
              throws IOException,
                     IncorrectDefaultFieldsException,
                     InvalidDendroFileException

Description copied from class: AbstractDendroFileReader

Loads a file from the given path, filename, and defaults. Override this method and AbstractDendroFileReader.loadFile(String, IMetadataFieldSet) to load files that aren't strings.

Overrides:

loadFile in class AbstractDendroFileReader

Throws:

IOException

IncorrectDefaultFieldsException

InvalidDendroFileException

loadFile

public void loadFile(byte[] argFileBytes,
                     IMetadataFieldSet argDefaults)
              throws IncorrectDefaultFieldsException,
                     InvalidDendroFileException

Throws:

IncorrectDefaultFieldsException

InvalidDendroFileException

loadFile

public void loadFile(byte[] argFileBytes)
              throws InvalidDendroFileException

Throws:

InvalidDendroFileException

checkFile

protected void checkFile(byte[] argFileBytes)
                  throws InvalidDendroFileException

Check this is a valid CATRAS file

Parameters:

argFileBytes -

Throws:

InvalidDendroFileException

parseFile

protected void parseFile(byte[] argFileBytes,
                         IMetadataFieldSet argDefaultFields)
                  throws InvalidDendroFileException

Parameters:

argFileBytes -

argDefaultFields -

Throws:

InvalidDendroFileException

getIntFromBytePair

public static int getIntFromBytePair(byte[] wBytes,
                                     Boolean littleEndian)

Extract the integer value from a byte pair according to endianess Horror! Java byte is signed! See: http://www.darksleep.com/player/JavaAndUnsignedTypes.html

Parameters:

wBytes -

littleEndian - use little-endian?

Returns:

getIntFromByte

public static int getIntFromByte(byte argByte)

Extract a single integer value from a byte

Parameters:

argBytes -

littleEndian - use little-endian?

Returns:

getFileExtensions

public String[] getFileExtensions()

Description copied from class: AbstractDendroFileReader

Returns a list of the file extensions for this file

Specified by:

getFileExtensions in class AbstractDendroFileReader

Returns:

parseFile

protected void parseFile(String[] argFileString,
                         IMetadataFieldSet argDefaultFields)

Description copied from class: AbstractDendroFileReader

Parse the file from the given metadata and strings

Specified by:

parseFile in class AbstractDendroFileReader

loadFile

public void loadFile(String[] argFileStrings)
              throws InvalidDendroFileException

Description copied from class: AbstractDendroFileReader

Loads a file just from the strings, using the default metadata

Overrides:

loadFile in class AbstractDendroFileReader

Throws:

InvalidDendroFileException

getDefaults

public IMetadataFieldSet getDefaults()

Description copied from class: AbstractDendroFileReader

Get the default values for this reader that were given in loading the file. If the loadFile method was never called, then this returns null.

Specified by:

getDefaults in class AbstractDendroFileReader

Returns:

See Also:

org.tridas.io.IDendroFileReader#getDefaults()

getCurrentLineNumber

public int getCurrentLineNumber()

Description copied from class: AbstractDendroFileReader

Gets the current line number of the reader. If errors occurred, this could help point towards the cause.

Specified by:

getCurrentLineNumber in class AbstractDendroFileReader

Returns:

the current line number

See Also:

AbstractDendroFileReader.getCurrentLineNumber()

getDescription

public String getDescription()

Description copied from class: AbstractDendroFileReader

Get the description of the format

Specified by:

getDescription in class AbstractDendroFileReader

Returns:

See Also:

org.tridas.io.IDendroFileReader#getDescription()

getFullName

public String getFullName()

Description copied from class: AbstractDendroFileReader

Get the full name of the format

Specified by:

getFullName in class AbstractDendroFileReader

Returns:

See Also:

org.tridas.io.IDendroFileReader#getFullName()

getShortName

public String getShortName()

Description copied from class: AbstractDendroFileReader

Get the short name of the format

Specified by:

getShortName in class AbstractDendroFileReader

Returns:

See Also:

org.tridas.io.IDendroFileReader#getShortName()

resetReader

protected void resetReader()

Description copied from class: AbstractDendroFileReader

Reset the reader

Specified by:

resetReader in class AbstractDendroFileReader

See Also:

AbstractDendroFileReader.resetReader()

getDendroFileFilter

public DendroFileFilter getDendroFileFilter()

Specified by:

getDendroFileFilter in class AbstractDendroFileReader

See Also:

AbstractDendroFileReader.getDendroFileFilter()

getProjects

public org.tridas.schema.TridasProject[] getProjects()

Description copied from class: AbstractDendroFileReader

Gets the parsed projects after they are loaded.

Specified by:

getProjects in class AbstractDendroFileReader

See Also:

AbstractDendroFileReader.getProjects()

getTridasContainer

public org.tridas.schema.TridasTridas getTridasContainer()

Specified by:

getTridasContainer in class AbstractDendroFileReader

See Also:

AbstractDendroFileReader.getTridasContainer()