|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.table.StreamStarTableWriter
uk.ac.starlink.table.formats.LatexTableWriter
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 |
public LatexTableWriter()
public LatexTableWriter(boolean standalone)
Method Detail |
public void setStandalone(boolean standalone)
standalone
- true if the output document should be a
complete LaTeX documentpublic boolean isStandalone()
public String getFormatName()
public String getMimeType()
StarTableWriter
application/octet-stream
"
(for binary formats) or "text/plain
" for ASCII ones)
is recommended.
public boolean looksLikeFile(String location)
StarTableWriter
location
- the location name (probably filename)
public void writeStarTable(StarTable startab, OutputStream ostrm) throws IOException
StarTableWriter
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.
startab
- the table to writeostrm
- the output stream to which startab should be
written
IOException
- if there is some I/O errorpublic static StarTableWriter[] getStarTableWriters()
protected void printHeader(OutputStream ostrm, StarTable startab) throws IOException
tabular
environment. May be overridden to
modify the form of output documents.
ostrm
- output streamstartab
- table for which header is required
IOException
protected void printFooter(OutputStream ostrm, StarTable startab) throws IOException
tabular
environment. May be overridden to
modify the form of output documents.
ostrm
- the stream to write tostartab
- the StarTable which the tabular will contain
IOException
|
Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved. | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |