Package uk.ac.starlink.fits
Class VariableFitsTableWriter
- java.lang.Object
-
- uk.ac.starlink.table.StreamStarTableWriter
-
- uk.ac.starlink.fits.AbstractFitsTableWriter
-
- uk.ac.starlink.fits.VariableFitsTableWriter
-
- All Implemented Interfaces:
uk.ac.starlink.table.MultiStarTableWriter
,uk.ac.starlink.table.StarTableWriter
public class VariableFitsTableWriter extends AbstractFitsTableWriter
TableWriter which writes FITS BINTABLEs with variable-length arrays where appropriate. Array-valued columns in the input StarTable which are declared with variable shapes (the last element ofColumnInfo.getShape()
is negative) will be written in the output FITS file using the 'P' or 'Q' data type specifier with the actual data written in the BINTABLE extension heap - see the FITS document for details. Any other columns will get written in just the same way as by theFitsTableWriter
.Strings and String arrays ('A' descriptor) are not currently written in variable-length form.
- Since:
- 11 Jul 2008
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description VariableFitsTableWriter()
Constructs a writer with default characteristics.VariableFitsTableWriter(java.lang.Boolean longIndexing, boolean allowSignedByte, WideFits wide)
Constructs a writer with custom characteristics.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected FitsTableSerializer
createSerializer(uk.ac.starlink.table.StarTable table)
Provides a suitable serializer for a given table.boolean
looksLikeFile(java.lang.String location)
Always returns false.void
setStoragePolicy(uk.ac.starlink.table.StoragePolicy storagePolicy)
Sets the storage policy which will be used for temporary storage during writing.-
Methods inherited from class uk.ac.starlink.fits.AbstractFitsTableWriter
addMetadata, getCurrentDate, getFormatName, getMimeType, setFormatName, writePrimaryHDU, writeStarTable, writeStarTables, writeStarTables, writeTableHDU
-
-
-
-
Constructor Detail
-
VariableFitsTableWriter
public VariableFitsTableWriter()
Constructs a writer with default characteristics. It chooses sensibly between using 'P' and 'Q' format.
-
VariableFitsTableWriter
public VariableFitsTableWriter(java.lang.Boolean longIndexing, boolean allowSignedByte, WideFits wide)
Constructs a writer with custom characteristics.- Parameters:
longIndexing
- TRUE for 'Q' (64-bit) indexing into the heap, FALSE for 'P' (32-bit) indexing into the heap, null to make a sensible choiceallowSignedByte
- if true, bytes written as FITS signed bytes (TZERO=-128), if false bytes written as signed shortswide
- convention for representing over-wide tables; null to avoid this convention
-
-
Method Detail
-
setStoragePolicy
public void setStoragePolicy(uk.ac.starlink.table.StoragePolicy storagePolicy)
Sets the storage policy which will be used for temporary storage during writing. Temporary storage is required for the heap contents while the table body itself is being written. By default the system default storage policy is used.- Parameters:
storagePolicy
- policy to use
-
looksLikeFile
public boolean looksLikeFile(java.lang.String location)
Always returns false.
-
createSerializer
protected FitsTableSerializer createSerializer(uk.ac.starlink.table.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 classAbstractFitsTableWriter
- Parameters:
table
- table to serialize- Returns:
- FITS serializer
- Throws:
java.io.IOException
- if the table can't be written
-
-