uk.ac.starlink.votable

Class ColFitsPlusTableWriter

java.lang.Object

uk.ac.starlink.table.StreamStarTableWriter

uk.ac.starlink.fits.AbstractFitsTableWriter

uk.ac.starlink.votable.VOTableFitsTableWriter

uk.ac.starlink.votable.ColFitsPlusTableWriter

All Implemented Interfaces:

Documented, DocumentedIOHandler, MultiStarTableWriter, StarTableWriter

public class ColFitsPlusTableWriter
extends VOTableFitsTableWriter
implements DocumentedIOHandler

Handles writing of a StarTable in a column-oriented FITS binary table format. The table data is stored in a BINTABLE extension which has a single row; each cell in this row contains the data for an entire column of the represented table. The primary HDU is a byte array containing a VOTable representation of the table metadata, as for FitsPlusTableWriter.

This rather specialised format may provide good performance for certain operations on very large, especially very wide, tables. Although it is FITS and can therefore be used in principle for data interchange, in practice most non-STIL processors are unlikely to be able to do much useful with it.

Since:

21 Jun 2006

Constructor Summary

Constructors

Constructor and Description
ColFitsPlusTableWriter() Default constructor.
ColFitsPlusTableWriter(java.lang.String name, WideFits wide) Deprecated. allows some configuration options but not others; use no-arg constructor and configuration methods instead

Method Summary

Modifier and Type	Method and Description
protected FitsTableSerializer	createSerializer(StarTable table) Provides a suitable serializer for a given table.
boolean	docIncludesExample() Indicates whether the serialization of some (short) example table should be added to the user documentation for this handler.
protected CardImage[]	getCustomPrimaryHeaderCards() Returns implementation-specific header cards to be added to the Primary HDU of FITS files written by this writer.
java.lang.String[]	getExtensions() Returns the list of filename extensions recognised by this handler.
java.lang.String	getXmlDescription() Returns user-directed documentation in XML format.
protected boolean	isMagic(int icard, java.lang.String key, java.lang.Object value) Tests a header card to see if it looks like part of the magic number for the format written by this handler.
boolean	looksLikeFile(java.lang.String location) Indicates whether the destination is of a familiar form for this kind of writer.

Methods inherited from class uk.ac.starlink.votable.VOTableFitsTableWriter

isMagic, setAllowSignedByte, setVotableVersion, writeStarTables

Methods inherited from class uk.ac.starlink.fits.AbstractFitsTableWriter

getAllowSignedByte, getAllowZeroLengthString, getConfig, getCurrentDate, getFormatName, getMetadataCards, getMimeType, getPadCharacter, getWide, getWriteDate, setAllowZeroLengthString, setFormatName, setPadCharacter, setWide, setWriteDate, writePrimaryHDU, writeStarTable, writeStarTables, writeTableHDU

Methods inherited from class uk.ac.starlink.table.StreamStarTableWriter

writeStarTable, writeStarTable

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.formats.DocumentedIOHandler

matchesExtension, readText, toLink

Methods inherited from interface uk.ac.starlink.table.StarTableWriter

writeStarTable

Constructor Detail

ColFitsPlusTableWriter

public ColFitsPlusTableWriter()

Default constructor.

ColFitsPlusTableWriter

@Deprecated
public ColFitsPlusTableWriter(java.lang.String name,
                                          WideFits wide)

Deprecated. allows some configuration options but not others; use no-arg constructor and configuration methods instead

Deprecated custom constructor.

Method Detail

getExtensions

public java.lang.String[] getExtensions()

Description copied from interface: DocumentedIOHandler

Returns the list of filename extensions recognised by this handler.

Specified by:

getExtensions in interface DocumentedIOHandler

Returns:

lower-cased filename extension strings, no "." characters

looksLikeFile

public boolean looksLikeFile(java.lang.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.

Specified by:

looksLikeFile in interface StarTableWriter

Parameters:

location - the location name (probably filename)

Returns:

true iff it looks like a file this writer would normally write

docIncludesExample

public boolean docIncludesExample()

Description copied from interface: DocumentedIOHandler

Indicates whether the serialization of some (short) example table should be added to the user documentation for this handler. Binary formats, or instances for which the Documented.getXmlDescription() method already includes some example output, should return false.

Specified by:

docIncludesExample in interface DocumentedIOHandler

Returns:

true if the user documentation would benefit from the addition of an example serialization

getXmlDescription

public java.lang.String getXmlDescription()

Description copied from interface: Documented

Returns user-directed documentation in XML format.

The output should be a sequence of one or more <P> elements, using XHTML-like XML. Since rendering may be done in a number of contexts however, use of the full range of XHTML elements is discouraged. Where possible, the content should stick to simple markup such as the elements P, A, UL, OL, LI, DL, DT, DD EM, STRONG, I, B, CODE, TT, PRE.

Specified by:

getXmlDescription in interface Documented

Returns:

XML description of this object

getCustomPrimaryHeaderCards

protected CardImage[] getCustomPrimaryHeaderCards()

Description copied from class: VOTableFitsTableWriter

Returns implementation-specific header cards to be added to the Primary HDU of FITS files written by this writer.

Specified by:

getCustomPrimaryHeaderCards in class VOTableFitsTableWriter

Returns:

header cards

isMagic

protected boolean isMagic(int icard,
                          java.lang.String key,
                          java.lang.Object value)

Description copied from class: VOTableFitsTableWriter

Tests a header card to see if it looks like part of the magic number for the format written by this handler. The VOTableFitsTableWriter implementation tests that the first four cards read:

    SIMPLE = T
    BITPIX = 8
    NAXIS  = 1
    NAXIS1 = ???
 

Subclasses may override this to add tests for later cards (as provided by VOTableFitsTableWriter.getCustomPrimaryHeaderCards()).

Overrides:

isMagic in class VOTableFitsTableWriter

Parameters:

icard - 0-based card index

key - card name

value - card value

Returns:

true iff the presented card is one that could have been written by this writer

createSerializer

protected FitsTableSerializer createSerializer(StarTable table)
                                        throws java.io.IOException

Description copied from class: AbstractFitsTableWriter

Provides a suitable serializer for a given table. Note this should throw an IOException if it can be determined that the submitted table cannot be written by this writer, for instance if it has too many columns.

Specified by:

createSerializer in class AbstractFitsTableWriter

Parameters:

table - table to serialize

Returns:

FITS serializer

Throws:

java.io.IOException - if the table can't be written