ucar.visad

Class Plotter

java.lang.Object

ucar.visad.Plotter

public class Plotter
extends java.lang.Object

Plot a Plottable object to file. This is roughly analoguous to java printing which provides a Graphics2D to a Printable object, which the Printable can then render itself to, before being printed

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Plotter.Plottable Interface for classes which create charts capable of being plotted via a third party rendering library to a vector based graphics format

Field Summary

Fields

Modifier and Type	Field and Description
static int	DIFAX Specifies a format of DIFAX
static java.lang.String[]	FORMATS The different file formats supported
static int	JPG Specifies a format of JPG
static int	PDF Specifies a format of PDF
static int	PNG Specifies a format of PNG
static int	PS Specifies a format of Postscript
static int	SVG Specifies a format of SVG
static int	TIFF Specifies a format of PS2

Constructor Summary

Constructors

Constructor and Description
Plotter(int format, java.lang.String filename) Create a plotter
Plotter(int format, java.lang.String filename, boolean monochrome) Create a plotter
Plotter(java.lang.String filename) ctor

Method Summary

Modifier and Type	Method and Description
int	getFormat() Find out which format the plotter is plotting to
javax.swing.JComponent	getPreview(Plotter.Plottable plottable) Get the preview of the given plot
void	handleError(java.lang.Exception exc) handle the error.
void	plot(Plotter.Plottable plottable) Plot a plottable object to the file specified in the constructor
void	setColourDepth(int colourDepth) Set color depth
void	setFilename(java.lang.String filename) Set the filename
void	setMonochrome(boolean monochrome) set monochrome

Methods inherited from class java.lang.Object

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

Field Detail

SVG

public static final int SVG

Specifies a format of SVG

See Also:

Constant Field Values

PNG

public static final int PNG

Specifies a format of PNG

See Also:

Constant Field Values

JPG

public static final int JPG

Specifies a format of JPG

See Also:

Constant Field Values

PS

public static final int PS

Specifies a format of Postscript

See Also:

Constant Field Values

PDF

public static final int PDF

Specifies a format of PDF

See Also:

Constant Field Values

TIFF

public static final int TIFF

Specifies a format of PS2

See Also:

Constant Field Values

DIFAX

public static final int DIFAX

Specifies a format of DIFAX

See Also:

Constant Field Values

FORMATS

public static final java.lang.String[] FORMATS

The different file formats supported

Constructor Detail

Plotter

public Plotter(int format,
               java.lang.String filename)

Create a plotter

Parameters:

format - The format of the distination file SVG, PNG or PS

filename - The filename to plot to

Plotter

public Plotter(java.lang.String filename)

ctor

Parameters:

filename - file to write to

Plotter

public Plotter(int format,
               java.lang.String filename,
               boolean monochrome)

Create a plotter

Parameters:

format - The format of the distination file SVG, PNG or PS

filename - The filename to plot to

monochrome - Set to true if all colours are to be plotted as either pure black or pure white

Method Detail

handleError

public void handleError(java.lang.Exception exc)
                 throws java.lang.Exception

handle the error. THis just throws the error but can be overwritten

Parameters:

exc - The error.

Throws:

java.lang.Exception - On badness

setFilename

public void setFilename(java.lang.String filename)

Set the filename

Parameters:

filename - the filename

setMonochrome

public void setMonochrome(boolean monochrome)

set monochrome

Parameters:

monochrome - is monochrome

setColourDepth

public void setColourDepth(int colourDepth)

Set color depth

Parameters:

colourDepth - the depth

getFormat

public int getFormat()

Find out which format the plotter is plotting to

Returns:

format

plot

public void plot(Plotter.Plottable plottable)
          throws java.io.FileNotFoundException,
                 java.io.IOException,
                 java.lang.Exception

Plot a plottable object to the file specified in the constructor

Parameters:

plottable - The object to be plotted

Throws:

java.lang.Exception - On badness

java.io.FileNotFoundException - On badness

java.io.IOException - On badness

getPreview

public javax.swing.JComponent getPreview(Plotter.Plottable plottable)
                                  throws java.io.FileNotFoundException,
                                         java.io.IOException

Get the preview of the given plot

Parameters:

plottable - plot to preview

Returns:

preview component

Throws:

java.io.FileNotFoundException - On badness

java.io.IOException - On badness