rlaramee
Class FromASCIItoBinaryCube

java.lang.Object
  |
  +--rlaramee.FromASCIItoBinaryCube

public class FromASCIItoBinaryCube

extends java.lang.Object

Description This program converts Cube objects from ASCII to binary format using serialization.

start date Thur 4 May 00

Version:

1.0

Author:

Robert S Laramee

See Also:

Field Summary

private ASCIIcubeParser	asciiCubeParser
private boolean	breakOut
private boolean	debug
private java.io.FileInputStream	fileInputStream
private java.io.FileOutputStream	fileOutputStream
private java.io.ObjectInputStream	objectInputStream
private java.io.ObjectOutputStream	objectOutputStream
private java.io.StreamTokenizer	streamTokenizer
private byte	writeLevel

Constructor Summary

FromASCIItoBinaryCube(byte level)

Method Summary

private boolean	closeOutputStreams() Deprecated. no longer used
private Cube	createArtificialCube(int x, int y, int z) Used for testing purposes
private ASCIIcubeParser	getASCIIcubeParser()
private boolean	getBreakOut()
private java.io.FileInputStream	getFileInputStream()
private java.io.FileOutputStream	getFileOutputStream()
private java.io.ObjectInputStream	getObjectInputStream()
private java.io.ObjectOutputStream	getObjectOutputStream()
java.io.StreamTokenizer	getStreamTokenizer()
private byte	getWriteLevel()
static void	main(java.lang.String[] args) The main() method runs the program
private boolean	openOutputStreams(java.lang.String outputFileName) Deprecated. We only open 1 outputstream at a time
private int	readAndWriteCubes(java.lang.String outputFileName, int dimensionLength)
private Cube	readCube()
private int	reReadCubes(java.lang.String outputFileName, int dimensionLength, boolean byOctant) This method is used for debugging.
boolean	run(java.lang.String inputFileName, java.lang.String outputFileName, int dimensionLength) The run() function starts the ASCII Cubes Reader.
private boolean	setASCIIcubeParser(ASCIIcubeParser acp)
private void	setBreakOut(boolean trueOrFalse)
private boolean	setFileInputStream(java.io.FileInputStream fis)
private boolean	setFileOutputStream(java.io.FileOutputStream fos)
private boolean	setObjectInputStream(java.io.ObjectInputStream ois)
private boolean	setObjectOutputStream(java.io.ObjectOutputStream oos)
boolean	setStreamTokenizer() Initializes this object's streamTokenizer
private boolean	setWriteLevel(byte newLevel)
private boolean	writeCube(Cube cube)

Methods inherited from class java.lang.Object

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

Field Detail

fileInputStream

private java.io.FileInputStream fileInputStream

fileOutputStream

private java.io.FileOutputStream fileOutputStream

streamTokenizer

private java.io.StreamTokenizer streamTokenizer

objectInputStream

private java.io.ObjectInputStream objectInputStream

objectOutputStream

private java.io.ObjectOutputStream objectOutputStream

asciiCubeParser

private ASCIIcubeParser asciiCubeParser

breakOut

private boolean breakOut

debug

private boolean debug

writeLevel

private byte writeLevel

Constructor Detail

FromASCIItoBinaryCube

public FromASCIItoBinaryCube(byte level)

Parameters:

level - -the level of the cubes we are saving

Method Detail

getWriteLevel

private byte getWriteLevel()

Returns:

the level of resolution we are reading and writing cubes

setWriteLevel

private boolean setWriteLevel(byte newLevel)

Parameters:

newLevel - the level of resolution we are reading and writing cubes

getASCIIcubeParser

private ASCIIcubeParser getASCIIcubeParser()

Returns:

this object's ASCIIcubeParser

setASCIIcubeParser

private boolean setASCIIcubeParser(ASCIIcubeParser acp)

Parameters:

acp - -an ASCIIcubeParser object

Returns:

TRUE if set successfully

getFileInputStream

private java.io.FileInputStream getFileInputStream()

Returns:

this object's fileInputStream object

setFileInputStream

private boolean setFileInputStream(java.io.FileInputStream fis)

Parameters:

fis - -a FileInputStream object

Returns:

TRUE if set() was successful.

getFileOutputStream

private java.io.FileOutputStream getFileOutputStream()

Returns:

the fileOutputStream object

setFileOutputStream

private boolean setFileOutputStream(java.io.FileOutputStream fos)

Parameters:

fos - -a FileOutputStream object

Returns:

TRUE if set() was successful.

getObjectInputStream

private java.io.ObjectInputStream getObjectInputStream()

Returns:

the ObjectInputStream object

setObjectInputStream

private boolean setObjectInputStream(java.io.ObjectInputStream ois)

Parameters:

ois - -an ObjectInputStream object

Returns:

TRUE if set() was successful.

getObjectOutputStream

private java.io.ObjectOutputStream getObjectOutputStream()

Returns:

the fileOutputStream object

setObjectOutputStream

private boolean setObjectOutputStream(java.io.ObjectOutputStream oos)

Parameters:

oos - -an ObjectOutputStream object

Returns:

TRUE if set() was successful.

getStreamTokenizer

public java.io.StreamTokenizer getStreamTokenizer()

Returns:

this object's streamTokenizer

setStreamTokenizer

public boolean setStreamTokenizer()

Initializes this object's streamTokenizer

Returns:

TRUE if successful

getBreakOut

private boolean getBreakOut()

Returns:

TRUE if we are to break out of a loop

setBreakOut

private void setBreakOut(boolean trueOrFalse)

Parameters:

trueOrFalse - is TRUE if we are to break out of a loop

openOutputStreams

private boolean openOutputStreams(java.lang.String outputFileName)

Deprecated. We only open 1 outputstream at a time

Parameters:

outputFileName - the name of the output file to write

Returns:

TRUE on success

closeOutputStreams

private boolean closeOutputStreams()

Deprecated. no longer used

Returns:

TRUE on success

run

public boolean run(java.lang.String inputFileName,
                   java.lang.String outputFileName,
                   int dimensionLength)

The run() function starts the ASCII Cubes Reader.

Parameters:

inputFileName - the name of the input file to read

outputFileName - the name of the output file to write

dimensionLength - the length of each x,y,z dimension

readAndWriteCubes

private int readAndWriteCubes(java.lang.String outputFileName,
                              int dimensionLength)

Parameters:

outputFileName - the name of the output file to write

dimensionLength - the length of each x,y,z dimension

Returns:

numCubesWritten return the number of cubes written

reReadCubes

private int reReadCubes(java.lang.String outputFileName,
                        int dimensionLength,
                        boolean byOctant)

This method is used for debugging.

Parameters:

outputFileName - the file name the cubes were written too

dimensionLength - the length of each x,y,z dimension

byOctant - is TRUE if the levels are broken up into octants 0-7

Returns:

readCount the number of cubes read

readCube

private Cube readCube()

Returns:

cube the cube read from the file

writeCube

private boolean writeCube(Cube cube)

Parameters:

cube - the cube being saved

Returns:

TRUE if the cube was written

main

public static void main(java.lang.String[] args)

The main() method runs the program

Parameters:

inputFileName - an input file name

outputFileName - an output file name

level - the level of resolution the current being read is

createArtificialCube

private Cube createArtificialCube(int x,
                                  int y,
                                  int z)

Used for testing purposes

Returns:

TRUE if artificial cube was successfully added to octree