Package uk.ac.starlink.table.formats
Class DocumentedStreamStarTableWriter
java.lang.Object
uk.ac.starlink.table.formats.DocumentedStreamStarTableWriter
- All Implemented Interfaces:
Documented
,DocumentedIOHandler
,StarTableWriter
- Direct Known Subclasses:
AbstractTextTableWriter
,CsvTableWriter
,HTMLTableWriter
,LatexTableWriter
,TstTableWriter
public abstract class DocumentedStreamStarTableWriter
extends Object
implements StarTableWriter, DocumentedIOHandler
Partial StarTableWriter implementation for use by writers which
just write to output streams, and which also implements DocumentedIOHandler.
- Since:
- 22 Sep 2020
- Author:
- Mark Taylor
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DocumentedStreamStarTableWriter
(String[] extensions) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionString[]
Returns the list of filename extensions recognised by this handler.boolean
looksLikeFile
(String filename) Indicates whether the destination is of a familiar form for this kind of writer.void
writeStarTable
(StarTable table, String location, StarTableOutput sto) Writes aStarTable
object to a given location.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface uk.ac.starlink.table.Documented
getXmlDescription
Methods inherited from interface uk.ac.starlink.table.formats.DocumentedIOHandler
docIncludesExample, readText
Methods inherited from interface uk.ac.starlink.table.StarTableWriter
getFormatName, getMimeType, writeStarTable
-
Constructor Details
-
DocumentedStreamStarTableWriter
Constructor.- Parameters:
extensions
- list of lower-cased filename extensions, excluding the '.' character
-
-
Method Details
-
getExtensions
Description copied from interface:DocumentedIOHandler
Returns the list of filename extensions recognised by this handler.- Specified by:
getExtensions
in interfaceDocumentedIOHandler
- Returns:
- lower-cased filename extension strings, no "." characters
-
looksLikeFile
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 returntrue
for values oflocation
which look like the normal form for their output format, for instance one with the usual file extension.- Specified by:
looksLikeFile
in interfaceStarTableWriter
- Parameters:
filename
- the location name (probably filename)- Returns:
true
iff it looks like a file this writer would normally write
-
writeStarTable
public void writeStarTable(StarTable table, String location, StarTableOutput sto) throws IOException Description copied from interface:StarTableWriter
Writes aStarTable
object to a given location. Implementations are free to interpret thelocation
argument in any way appropriate for them. Typically however the location will simply be used to get an output stream (for instance interpreting it as a filename). In this case thesto
argument should normally be used to turnlocation
into a stream.StreamStarTableWriter
provides a suitable implementation for this case.- Specified by:
writeStarTable
in interfaceStarTableWriter
- Parameters:
table
- table to writelocation
- destination forstartab
sto
- StarTableOutput which dispatched this request- Throws:
IOException
- if there is some I/O error
-