cage.writer
Class CaGeWriter

java.lang.Object
  cage.writer.CaGeWriter

All Implemented Interfaces:

CaGeOutlet

Direct Known Subclasses:

AbstractChemicalWriter, NativePlanarWriter, NativeWritegraphWriter

public abstract class CaGeWriter
extends java.lang.Object
implements CaGeOutlet

Constructor Summary

CaGeWriter()

Method Summary

int	getDimension() Returns the dimension which is needed for this outlet.
abstract java.lang.String	getFileExtension()
abstract java.lang.String	getFormatName()
java.io.IOException	lastIOException()
void	setDimension(int dimension) Sets the dimension for which this outlet will be used.
void	setGeneratorInfo(GeneratorInfo generatorInfo) Sets the generator info provided for this outlet.
void	setOutputStream(java.io.OutputStream out)
void	stop() Called when this outlet is no longer needed.
void	throwLastIOException()
boolean	usesInfo()
boolean	wasIOException()

Methods inherited from class java.lang.Object

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

Methods inherited from interface cage.CaGeOutlet

outputResult

Constructor Detail

CaGeWriter

public CaGeWriter()

Method Detail

getFormatName

public abstract java.lang.String getFormatName()

getFileExtension

public abstract java.lang.String getFileExtension()

usesInfo

public boolean usesInfo()

setDimension

public void setDimension(int dimension)

Description copied from interface: CaGeOutlet

Sets the dimension for which this outlet will be used. This method may throw a RunTimeException when d is an unsupported dimension.

Specified by:

setDimension in interface CaGeOutlet

Parameters:

dimension - The dimension for which this outlet will be used

getDimension

public int getDimension()

Description copied from interface: CaGeOutlet

Returns the dimension which is needed for this outlet.

Specified by:

getDimension in interface CaGeOutlet

Returns:

the dimension which is needed for this outlet.

setGeneratorInfo

public void setGeneratorInfo(GeneratorInfo generatorInfo)

Description copied from interface: CaGeOutlet

Sets the generator info provided for this outlet. This info can contain hints for the output such as GeneratorInfo.isReembed2DEnabled().

Specified by:

setGeneratorInfo in interface CaGeOutlet

Parameters:

generatorInfo - the generator info provided for this outlet

setOutputStream

public void setOutputStream(java.io.OutputStream out)

stop

public void stop()

Description copied from interface: CaGeOutlet

Called when this outlet is no longer needed. The outlet can then perform any necessary clean up tasks such as closing streams.

Specified by:

stop in interface CaGeOutlet

wasIOException

public boolean wasIOException()

lastIOException

public java.io.IOException lastIOException()

throwLastIOException

public void throwLastIOException()
                          throws java.io.IOException

Throws:

java.io.IOException