tap.formatter

Class SVFormat

java.lang.Object

tap.formatter.SVFormat

All Implemented Interfaces:

OutputFormat

public class SVFormat
extends java.lang.Object
implements OutputFormat

Format any given query (table) result into CSV or TSV (or with custom separator).

Version:

2.0 (04/2015)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
static char	COMMA_SEPARATOR Column separator for CSV format.
protected boolean	delimitStr Indicate whether String values must be delimited by double quotes (default) or not.
protected java.lang.String	mimeType MIME type associated with this format.
static char	SEMI_COLON_SEPARATOR Column separator for sCSV format.
protected java.lang.String	separator Column separator to use.
protected ServiceConnection	service The ServiceConnection to use (for the log and to have some information about the service (particularly: name, description).
protected java.lang.String	shortMimeType Alias of the MIME type associated with this format.
static char	TAB_SEPARATOR Column separator for TSV format.

Constructor Summary

Constructors

Constructor and Description
SVFormat(ServiceConnection service, char colSeparator) Build a SVFormat (in which String values are delimited by double quotes).
SVFormat(ServiceConnection service, char colSeparator, boolean delimitStrings) Build a SVFormat.
SVFormat(ServiceConnection service, char colSeparator, boolean delimitStrings, java.lang.String mime, java.lang.String shortMime) Build a SVFormat.
SVFormat(ServiceConnection service, java.lang.String colSeparator) Build a SVFormat (in which String values are delimited by double quotes).
SVFormat(ServiceConnection service, java.lang.String colSeparator, boolean delimitStrings) Build a SVFormat.
SVFormat(ServiceConnection service, java.lang.String colSeparator, boolean delimitStrings, java.lang.String mime, java.lang.String shortMime) Build a SVFormat.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Gets a description of this format.
java.lang.String	getFileExtension() Gets a file extension for this format.
java.lang.String	getMimeType() Gets the MIME type corresponding to this format.
java.lang.String	getShortMimeType() Gets a short expression of its MIME type.
protected java.lang.String	guessMimeType(java.lang.String separator) Try to guess the MIME type to associate with this SV format, in function of the column separator.
protected java.lang.String	guessShortMimeType(java.lang.String separator) Try to guess the short MIME type to associate with this SV format, in function of the column separator.
protected void	writeData(TableIterator result, DBColumn[] selectedColumns, java.io.BufferedWriter writer, TAPExecutionReport execReport, java.lang.Thread thread) Write all the data rows.
protected void	writeFieldValue(java.lang.Object value, DBColumn column, java.io.BufferedWriter writer) Writes the given field value in the given Writer.
protected DBColumn[]	writeHeader(TableIterator result, java.io.BufferedWriter writer, TAPExecutionReport execReport, java.lang.Thread thread) Write the whole header (one row whose columns are just the columns' name).
void	writeResult(TableIterator result, java.io.OutputStream output, TAPExecutionReport execReport, java.lang.Thread thread) Formats the given query result and writes it in the given output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMA_SEPARATOR

public static final char COMMA_SEPARATOR

Column separator for CSV format.

See Also:

Constant Field Values

SEMI_COLON_SEPARATOR

public static final char SEMI_COLON_SEPARATOR

Column separator for sCSV format.

See Also:

Constant Field Values

TAB_SEPARATOR

public static final char TAB_SEPARATOR

Column separator for TSV format.

See Also:

Constant Field Values

service

protected final ServiceConnection service

The ServiceConnection to use (for the log and to have some information about the service (particularly: name, description).

separator

protected final java.lang.String separator

Column separator to use.

delimitStr

protected final boolean delimitStr

Indicate whether String values must be delimited by double quotes (default) or not.

mimeType

protected final java.lang.String mimeType

MIME type associated with this format.

Since:

1.1

shortMimeType

protected final java.lang.String shortMimeType

Alias of the MIME type associated with this format.

Since:

1.1

Constructor Detail

SVFormat

public SVFormat(ServiceConnection service,
                char colSeparator)
         throws java.lang.NullPointerException

Build a SVFormat (in which String values are delimited by double quotes).

Parameters:

service - Description of the TAP service.

colSeparator - Column separator to use.

Throws:

java.lang.NullPointerException - If the given service connection is null.

SVFormat

public SVFormat(ServiceConnection service,
                char colSeparator,
                boolean delimitStrings)
         throws java.lang.NullPointerException

Build a SVFormat.

Parameters:

service - Description of the TAP service.

colSeparator - Column separator to use.

delimitStrings - true if String values must be delimited by double quotes, false otherwise.

Throws:

java.lang.NullPointerException - If the given service connection is null.

SVFormat

public SVFormat(ServiceConnection service,
                char colSeparator,
                boolean delimitStrings,
                java.lang.String mime,
                java.lang.String shortMime)
         throws java.lang.NullPointerException

Build a SVFormat.

Parameters:

service - Description of the TAP service.

colSeparator - Column separator to use.

delimitStrings - true if String values must be delimited by double quotes, false otherwise.

mime - The MIME type to associate with this format. note: this MIME type is then used by a user to specify the result format he wants.

shortMime - The alias of the MIME type to associate with this format. note: this short MIME type is then used by a user to specify the result format he wants.

Throws:

java.lang.NullPointerException - If the given service connection is null.

Since:

2.0

SVFormat

public SVFormat(ServiceConnection service,
                java.lang.String colSeparator)
         throws java.lang.NullPointerException

Build a SVFormat (in which String values are delimited by double quotes).

Parameters:

service - Description of the TAP service.

colSeparator - Column separator to use.

Throws:

java.lang.NullPointerException - If the given service connection is null.

SVFormat

public SVFormat(ServiceConnection service,
                java.lang.String colSeparator,
                boolean delimitStrings)
         throws java.lang.NullPointerException

Build a SVFormat.

Parameters:

service - Description of the TAP service.

colSeparator - Column separator to use.

delimitStrings - true if String values must be delimited by double quotes, false otherwise.

Throws:

java.lang.NullPointerException - If the given service connection is null.

SVFormat

public SVFormat(ServiceConnection service,
                java.lang.String colSeparator,
                boolean delimitStrings,
                java.lang.String mime,
                java.lang.String shortMime)
         throws java.lang.NullPointerException

Build a SVFormat.

Parameters:

service - Description of the TAP service.

colSeparator - Column separator to use.

delimitStrings - true if String values must be delimited by double quotes, false otherwise.

mime - The MIME type to associate with this format. note: this MIME type is then used by a user to specify the result format he wants.

shortMime - The alias of the MIME type to associate with this format. note: this short MIME type is then used by a user to specify the result format he wants.

Throws:

java.lang.NullPointerException - If the given service connection is null.

Since:

2.0

Method Detail

guessMimeType

protected java.lang.String guessMimeType(java.lang.String separator)

Try to guess the MIME type to associate with this SV format, in function of the column separator.

By default, only "," or ";" (text/csv) and [TAB] (text/tab-separated-values) are supported. If the separator is unknown, "text/plain" will be returned.

Note: In order to automatically guess more MIME types, you should overwrite this function.

Parameters:

separator - Column separator of this SV format.

Returns:

The guessed MIME type.

Since:

2.0

guessShortMimeType

protected java.lang.String guessShortMimeType(java.lang.String separator)

Try to guess the short MIME type to associate with this SV format, in function of the column separator.

By default, only "," or ";" (csv) and [TAB] (tsv) are supported. If the separator is unknown, "text" will be returned.

Note: In order to automatically guess more short MIME types, you should overwrite this function.

Parameters:

separator - Column separator of this SV format.

Returns:

The guessed short MIME type.

Since:

2.0

getMimeType

public final java.lang.String getMimeType()

Description copied from interface: OutputFormat

Gets the MIME type corresponding to this format.

Specified by:

getMimeType in interface OutputFormat

Returns:

Its MIME type (MUST BE DIFFERENT FROM NULL).

getShortMimeType

public final java.lang.String getShortMimeType()

Description copied from interface: OutputFormat

Gets a short expression of its MIME type.

Specified by:

getShortMimeType in interface OutputFormat

Returns:

Its short MIME type.

getDescription

public java.lang.String getDescription()

Description copied from interface: OutputFormat

Gets a description of this format.

Specified by:

getDescription in interface OutputFormat

Returns:

Its description.

getFileExtension

public java.lang.String getFileExtension()

Description copied from interface: OutputFormat

Gets a file extension for this format.

Specified by:

getFileExtension in interface OutputFormat

Returns:

Its file extension.

writeResult

public void writeResult(TableIterator result,
                        java.io.OutputStream output,
                        TAPExecutionReport execReport,
                        java.lang.Thread thread)
                 throws TAPException,
                        java.io.IOException,
                        java.lang.InterruptedException

Description copied from interface: OutputFormat

Formats the given query result and writes it in the given output stream.

Note: the given output stream should not be closed at the end of this function. It is up to the called to do it.

Specified by:

writeResult in interface OutputFormat

Parameters:

result - The raw (table) result to format.

output - The output stream (a ServletOutputStream or a stream on a file) in which the formatted result must be written.

execReport - The report of the execution of the TAP query whose the result must be now written.

thread - The thread which has asked the result writing.

Throws:

TAPException - If there is an error while formatting the query result.

java.io.IOException - If any error occurs while writing into the given stream.

java.lang.InterruptedException - If the query has been interrupted/aborted.

writeHeader

protected DBColumn[] writeHeader(TableIterator result,
                                 java.io.BufferedWriter writer,
                                 TAPExecutionReport execReport,
                                 java.lang.Thread thread)
                          throws java.io.IOException,
                                 TAPException,
                                 java.lang.InterruptedException

Write the whole header (one row whose columns are just the columns' name).

Parameters:

result - Result to write later (but it contains also metadata that was extracted from the result itself).

writer - Output in which the metadata must be written.

execReport - Execution report (which contains the metadata extracted/guessed from the ADQL query).

thread - Thread which has asked for this formatting (it must be used in order to test the Thread.isInterrupted() flag and so interrupt everything if need).

Returns:

All the written metadata.

Throws:

java.io.IOException - If there is an error while writing something in the output.

java.lang.InterruptedException - If the thread has been interrupted.

TAPException - If any other error occurs.

writeData

protected void writeData(TableIterator result,
                         DBColumn[] selectedColumns,
                         java.io.BufferedWriter writer,
                         TAPExecutionReport execReport,
                         java.lang.Thread thread)
                  throws java.io.IOException,
                         TAPException,
                         java.lang.InterruptedException

Write all the data rows.

Parameters:

result - Result to write.

selectedColumns - All columns' metadata.

writer - Writer in which the data must be written.

execReport - Execution report (which contains the maximum allowed number of records to output).

thread - Thread which has asked for this formatting (it must be used in order to test the Thread.isInterrupted() flag and so interrupt everything if need).

Throws:

java.io.IOException - If there is an error while writing something in the given writer.

java.lang.InterruptedException - If the thread has been interrupted.

TAPException - If any other error occurs.

writeFieldValue

protected void writeFieldValue(java.lang.Object value,
                               DBColumn column,
                               java.io.BufferedWriter writer)
                        throws java.io.IOException,
                               TAPException

Writes the given field value in the given Writer.

A String value will be delimited if delimitStr is true, otherwise this type of value will be processed like the other type of values: no delimiter and just transformed into a string.

Parameters:

value - The value to write.

column - The corresponding column metadata.

writer - The stream in which the field value must be written.

Throws:

java.io.IOException - If there is an error while writing the given field value in the given stream.

TAPException - If there is any other error (by default: never happen).