uk.ac.starlink.table.formats
Class LatexTableWriter

java.lang.Object
  extended byuk.ac.starlink.table.StreamStarTableWriter
      extended byuk.ac.starlink.table.formats.LatexTableWriter
All Implemented Interfaces:
StarTableWriter

public class LatexTableWriter
extends StreamStarTableWriter

A StarTableWriter that outputs text to a LaTeX document. Depending on the value of the standalone attribute, the output may either be a complete LaTeX document or just a tabular environment suitable for inserting into an existing document.


Constructor Summary
LatexTableWriter()
          Constructs a new writer with default characteristics.
LatexTableWriter(boolean standalone)
          Constructs a new writer indicating whether it will produce complete or partial LaTeX documents.
 
Method Summary
 String getFormatName()
          Returns the string "LaTeX-document" or "LaTeX";
 String getMimeType()
          Returns a string suitable for use as the value of a MIME Content-Type header.
static StarTableWriter[] getStarTableWriters()
          Returns a useful list of LatexTableWriters.
 boolean isStandalone()
          Indicates whether output tables will be complete LaTeX documents.
 boolean looksLikeFile(String location)
          Indicates whether the destination is of a familiar form for this kind of writer.
protected  void printFooter(OutputStream ostrm, StarTable startab)
          For standalone output, this method is invoked to output any text following the tabular environment.
protected  void printHeader(OutputStream ostrm, StarTable startab)
          For standalone output, this method is invoked to output any text preceding the tabular environment.
 void setStandalone(boolean standalone)
          Sets whether output tables should be complete LaTeX documents.
 void writeStarTable(StarTable startab, OutputStream ostrm)
          Writes a StarTable object to a given output stream.
 
Methods inherited from class uk.ac.starlink.table.StreamStarTableWriter
writeStarTable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LatexTableWriter

public LatexTableWriter()
Constructs a new writer with default characteristics.


LatexTableWriter

public LatexTableWriter(boolean standalone)
Constructs a new writer indicating whether it will produce complete or partial LaTeX documents.

Method Detail

setStandalone

public void setStandalone(boolean standalone)
Sets whether output tables should be complete LaTeX documents.

Parameters:
standalone - true if the output document should be a complete LaTeX document

isStandalone

public boolean isStandalone()
Indicates whether output tables will be complete LaTeX documents.

Returns:
true if the output documents will be complete LaTeX docs

getFormatName

public String getFormatName()
Returns the string "LaTeX-document" or "LaTeX";

Returns:
a short string identifying the output format of this writer

getMimeType

public String getMimeType()
Description copied from interface: StarTableWriter
Returns a string suitable for use as the value of a MIME Content-Type header. If no suitable MIME type is available or known, one of "application/octet-stream" (for binary formats) or "text/plain" for ASCII ones) is recommended.

Returns:
MIME content type

looksLikeFile

public boolean looksLikeFile(String location)
Description copied from interface: StarTableWriter
Indicates whether the destination is of a familiar form for this kind of writer. This may be used to guess what kind of format a table should be written in. Implementations should return true for values of location which look like the normal form for their output format, for instance one with the usual file extension.

Parameters:
location - the location name (probably filename)
Returns:
true iff it looks like a file this writer would normally write

writeStarTable

public void writeStarTable(StarTable startab,
                           OutputStream ostrm)
                    throws IOException
Description copied from interface: StarTableWriter
Writes a StarTable object to a given output stream. The implementation can assume that out is suitable for direct writing (for instance it should not normally wrap it in a BufferedOutputStream), and should not close it at the end of the call.

Not all table writers are capable of writing to a stream; an implementation may throw a TableFormatException to indicate that it cannot do so.

Parameters:
startab - the table to write
ostrm - the output stream to which startab should be written
Throws:
IOException - if there is some I/O error

getStarTableWriters

public static StarTableWriter[] getStarTableWriters()
Returns a useful list of LatexTableWriters.

Returns:
array containing one standalone and one tabular-only writer

printHeader

protected void printHeader(OutputStream ostrm,
                           StarTable startab)
                    throws IOException
For standalone output, this method is invoked to output any text preceding the tabular environment. May be overridden to modify the form of output documents.

Parameters:
ostrm - output stream
startab - table for which header is required
Throws:
IOException

printFooter

protected void printFooter(OutputStream ostrm,
                           StarTable startab)
                    throws IOException
For standalone output, this method is invoked to output any text following the tabular environment. May be overridden to modify the form of output documents.

Parameters:
ostrm - the stream to write to
startab - the StarTable which the tabular will contain
Throws:
IOException

Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved.