adams.data.io.output
Class LatexSpreadSheetWriter

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.data.io.output.AbstractSpreadSheetWriter
              adams.data.io.output.AbstractMultiSheetSpreadSheetWriter
                  adams.data.io.output.AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport
                      adams.data.io.output.AbstractMultiSheetFormattedSpreadSheetWriter
                          adams.data.io.output.LatexSpreadSheetWriter

All Implemented Interfaces:

Debuggable, Destroyable, OptionHandler, SizeOfHandler, MultiSheetSpreadSheetWriter, SpreadSheetWriter, Serializable

public class LatexSpreadSheetWriter
extends AbstractMultiSheetFormattedSpreadSheetWriter

Generates LaTeX tables from spreadsheets.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-missing <java.lang.String> (property: missingValue)
    The placeholder for missing values.
    default:
 

-number-format <java.lang.String> (property: numberFormat)
    The format for the numbers (see java.text.DecimalFormat), use empty string
    for default 'double' output.
    default:
 

Version:

$Revision: 7082 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.data.io.output.AbstractMultiSheetFormattedSpreadSheetWriter

m_Formatter, m_Locale, m_NumberFormat

Fields inherited from class adams.data.io.output.AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport

m_MissingValue

Fields inherited from class adams.data.io.output.AbstractMultiSheetSpreadSheetWriter

m_SheetPrefix

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

LatexSpreadSheetWriter()

Method Summary

protected boolean	doWrite(SpreadSheet[] content, Writer writer) Performs the actual writing.
protected String	escape(String s) Turns the string into LaTeX-compliant text.
String	getFormatDescription() Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions() Returns the extension(s) of the format.
protected boolean	getUseOutputStream() Returns whether to write to an OutputStream rather than a Writer.
String	globalInfo() Returns a string describing the object.

Methods inherited from class adams.data.io.output.AbstractMultiSheetFormattedSpreadSheetWriter

defineOptions, format, getDefaultNumberFormat, getLocale, getNumberFormat, localeTipText, numberFormatTipText, setLocale, setNumberFormat

Methods inherited from class adams.data.io.output.AbstractMultiSheetSpreadSheetWriterWithMissingValueSupport

getDefaultMissingValue, getMissingValue, missingValueTipText, setMissingValue

Methods inherited from class adams.data.io.output.AbstractMultiSheetSpreadSheetWriter

doWrite, doWrite, doWrite, getDefaultSheetPrefix, getSheetPrefix, setSheetPrefix, sheetPrefixTipText, write, write, write, write

Methods inherited from class adams.data.io.output.AbstractSpreadSheetWriter

getWriters, write, write, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.data.io.output.SpreadSheetWriter

write, write, write, write

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.Destroyable

destroy

Constructor Detail

LatexSpreadSheetWriter

public LatexSpreadSheetWriter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface SpreadSheetWriter

Specified by:

getFormatDescription in class AbstractSpreadSheetWriter

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface SpreadSheetWriter

Specified by:

getFormatExtensions in class AbstractSpreadSheetWriter

Returns:

the extension (without the dot!)

getUseOutputStream

protected boolean getUseOutputStream()

Returns whether to write to an OutputStream rather than a Writer.

Specified by:

getUseOutputStream in class AbstractSpreadSheetWriter

Returns:

true if to write to an OutputStream

escape

protected String escape(String s)

Turns the string into LaTeX-compliant text.

Parameters:

s - the string to process

Returns:

the processed string

doWrite

protected boolean doWrite(SpreadSheet[] content,
                          Writer writer)

Performs the actual writing. The caller must ensure that the writer gets closed.

Overrides:

doWrite in class AbstractMultiSheetSpreadSheetWriter

Parameters:

content - the spreadsheets to write

writer - the writer to write the spreadsheet to

Returns:

true if successfully written