com.steptools.stdev.p21

Class Part21Writer

java.lang.Object

com.steptools.stdev.p21.Part21Writer

public class Part21Writer
extends Object

Provides the methods to write the contents of a model into a Part 21 file

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Part21Writer.State State of the Part 21 writer.

Field Summary

Fields

Modifier and Type	Field and Description
String	EOLN The line ending sequence.
int	fill_column The fill column for the Part21 file.
boolean	keep_partial If true, does not attempt to clean up when statusUpdate() throws a CanceledException.
int	status_freq Set the frequency at which the statusUpdate method is called.
boolean	update_header If true, modify the instances in the header to reflect the values written into the Part21 file.
boolean	update_timestamp If true (default), update the timestamp in the FILE_NAME record to reflect the current time.

Constructor Summary

Constructors

Constructor and Description
Part21Writer()

Method Summary

Methods

Modifier and Type	Method and Description
ListString	getSchema(Model mod) Get the list of strings to be written as the schemas in a Part21 file.
String	getSchema(SchemaBase schema) Get the name of a schemas as written to a Part21 file.
void	statusUpdate(Part21Writer.State st) The method is called periodically as the data is written.
void	write(File out, Model mod) Write a model as a part 21 file.
void	write(OutputStream stream, Model mod, String fname) Write a model as a part 21 file.
void	write(String filename, Model mod) Write a model as a part 21 file
void	write(Writer wr, Model mod, String fname) Write a model as a part 21 file

Methods inherited from class java.lang.Object

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

Field Detail

EOLN

public String EOLN

The line ending sequence. This can be overridden, if necessary. By default, this is system property line.separator, This will generally be some combination of \n and \r. If the system property cannot be obtained (e.g. we are running under a paranoid security manager), the value will be set to "\n".

fill_column

public int fill_column

The fill column for the Part21 file. A newline will be inserted into the file at this column.

update_header

public boolean update_header

If true, modify the instances in the header to reflect the values written into the Part21 file. If this is false, the header values are copied before being updated and written to the Part 21 file. By default this is true.

update_timestamp

public boolean update_timestamp

If true (default), update the timestamp in the FILE_NAME record to reflect the current time. You may wish to disable this for testing purposes, if you want to compare files.

status_freq

public int status_freq

Set the frequency at which the statusUpdate method is called. If this value is 0 (the default) the statusUpdate() method will never be called. Otherwise, it will be called after status_freq instances are read in.

keep_partial

public boolean keep_partial

If true, does not attempt to clean up when statusUpdate() throws a CanceledException. If a write method that specifies an output file (not a stream) is used, the file will be deleted is keep_partial is true.

Constructor Detail

Part21Writer

public Part21Writer()

Method Detail

statusUpdate

public void statusUpdate(Part21Writer.State st)
                  throws CanceledException

The method is called periodically as the data is written. It can be overridden in subtypes so that status information can be provided to the user about progress of the writer, and to give the use a way to cancel the writing. Frequency that this function is called is determined by the status_freq instance variable. The write will be aborted if this method throws an exception.

Parameters:

st - The parser state information. This can be queried to obtain the number of bytes in the file, the number of bytes ready by the parser, and the number is insteances read.

Throws:

CanceledException - to signal the write to stop writing the data.

write

public void write(String filename,
         Model mod)
           throws IOException,
                  STDevException

Write a model as a part 21 file

Parameters:

filename - The file to write the output to

mod - The model to output

Throws:

IOException

STDevException

write

public void write(File out,
         Model mod)
           throws IOException,
                  STDevException

Write a model as a part 21 file. If a CanceledException is thrown by a subtype's statusUpdate() method, the output file will be deleted unless keep_partial is true.

Parameters:

out - The file to write the output to.

mod - The model to output.

Throws:

IOException

STDevException

write

public void write(OutputStream stream,
         Model mod,
         String fname)
           throws IOException,
                  STDevException

Write a model as a part 21 file.

Parameters:

stream - The output stream to write to.

mod - The model to output

fname - The file name.

Throws:

IOException

STDevException

write

public void write(Writer wr,
         Model mod,
         String fname)
           throws IOException,
                  STDevException

Write a model as a part 21 file

Parameters:

wr - The write to sent the output to

mod - The model to output

fname - The filename (used to set the file name in the header)

Throws:

IOException

STDevException

getSchema

public ListString getSchema(Model mod)

Get the list of strings to be written as the schemas in a Part21 file. This method can be overidden in a subtype to control how schemas are written

Parameters:

mod - The model being processed.

Returns:

The list of schemas to be written into the Part 21 header.

getSchema

public String getSchema(SchemaBase schema)

Get the name of a schemas as written to a Part21 file. This method can be overidden in a subtype to control how schemas are written

Parameters:

schema - The schema whose name is getting retrieved.

Returns:

The name of the schema to be written into the Part 21 header.