uk.ac.starlink.table
Interface StarTableWriter

All Known Implementing Classes:
FitsTableWriter, HTMLTableWriter, LatexTableWriter, MirageTableWriter, TextTableWriter, VOTableWriter

public interface StarTableWriter

Defines an object which can output a StarTable in a particular format.


Method Summary
 String getFormatName()
          Gives the name of the format which is written by this writer.
 boolean looksLikeFile(String location)
          Indicates whether the destination is of a familiar form for this kind of writer.
 void writeStarTable(StarTable startab, String location)
          Writes a StarTable object to a given location.
 

Method Detail

writeStarTable

public void writeStarTable(StarTable startab,
                           String location)
                    throws IOException
Writes a StarTable object to a given location. If possible, a location of "-" should be taken as a request to write to standard output.

Parameters:
startab - the table to write
location - the destination of the written object (probably, but not necessarily, a filename)
IOException

looksLikeFile

public boolean looksLikeFile(String location)
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

getFormatName

public String getFormatName()
Gives the name of the format which is written by this writer. Matching against this string may be used by callers to identify or select this writer from a list.


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