com.aspc.commander.sql

Class ExportCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.commander.sql.ExportCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class ExportCommand
extends SQLCommand

Exports a report to a file in the document storage.

The mime_type defines the format of the output file and defaults to text/comma-seperated-values causing a text file to be produced with fields seperated by commas.
The string_delim defines the character which identifies the beginning and end of text and defaults to a double quote ("). Double instances of this character indicates that the text contains the string_delim character, i.e "Its a ""good"" day don't you think?"

The additional criteria will be added the search criteria in the report.

The attributes are a comma seperated list of key value pairs that will be passed to the plugin.

The file_name defines the name and location of the output file in the document storage area. The file defaults to the name of the report with a file extension consistent with the mime_type.
Syntax

  EXPORT REPORT_KEY report_key 
     [ADDITIONAL_CRITERIA additional_criteria] 
     [PLUGIN plugin] 
     [ATTRIBUTES attributes] 
     [UPDATE_FIELDS update_fields]  
     [MIME_TYPE mime_type] 
     [STRING_DELIM string_delim]  
     [FILE_NAME file_name]
     [MAX_TO_EXPORT max_to_export]
     [FOLDER folder]
  

Usage

  -- Simple export --
  EXPORT REPORT_KEY 123@2~123@1
  
  -- Export with java plugin to handle special formatting etc--
  EXPORT REPORT_KEY 123@2~123@1 PLUGIN_CLASS com.aspc.test.formatReport
  
  -- Export that will update a field on each record when imported --
  EXPORT REPORT_KEY 123@2~123@1 UPDATE_FIELDS exportedFg|true|exportTime|time.now()
  

THREAD MODE: SINGLE THREADED command

Since:

5 May 2005

Author:

Jason McGrath

Field Summary

Fields inherited from class com.aspc.commander.sql.SQLCommand

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
ExportCommand(Connection connection, Pattern pattern) std.

Method Summary

Modifier and Type	Method and Description
protected ExporterWithUpdate	doExport(ReadOnlyDataSource rds, Parser p, DBReport report)
protected void	execute(Parser p) execute the command.
protected java.lang.String	getAttributes(Parser p)
java.lang.String	getColumnName(int col) implements getColumnName of interface CommandBuildResultsPlugin.
java.lang.String	getColumnType(int col) Gets the column type for the given column index, starting at one
protected java.lang.String	getFileName(Parser p, java.lang.String mimeType, DBReport report)
protected java.lang.String	getMimeType(Parser p)
java.lang.String	getRecordID(int row) the record ID
protected DBReport	getReport(VirtualDB layer, Parser p)
protected boolean	getShowHeadings(Parser p)
protected char	getStringDelim(Parser p)
protected java.util.Map<java.lang.String,java.lang.String>	getUpdFields(Parser p)
java.lang.Object	getValue(int row, int col) the value for this row, column

Methods inherited from class com.aspc.commander.sql.SQLCommand

appendResult, appendResult, getCursorName, getRecordKey, isExecuteOnly

Methods inherited from class com.aspc.commander.Command

execute, extMakeThreadName, getConnection, getPattern, getRawTitle, getTitle, makeThreadName, recordCall, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspc.commander.sql.results.CommandBuildResultsPlugin

getRawTitle

Constructor Detail

ExportCommand

public ExportCommand(Connection connection,
                     Pattern pattern)

std. Command.

Parameters:

connection - the connection

pattern - the pattern

Method Detail

execute

protected void execute(Parser p)
                throws java.lang.Exception

execute the command.

Specified by:

execute in class Command

Parameters:

p - The parser

Throws:

java.lang.Exception - A serious problem

doExport

protected ExporterWithUpdate doExport(ReadOnlyDataSource rds,
                                      Parser p,
                                      DBReport report)
                               throws java.lang.Exception

Parameters:

rds - data source

p - the parser

report - the report

Returns:

the exporter

Throws:

java.lang.Exception - a serious problem

getUpdFields

protected final java.util.Map<java.lang.String,java.lang.String> getUpdFields(Parser p)
                                                                       throws java.lang.Exception

Parameters:

p -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getReport

protected DBReport getReport(VirtualDB layer,
                             Parser p)
                      throws java.lang.Exception

Parameters:

layer -

p -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getMimeType

protected java.lang.String getMimeType(Parser p)
                                throws java.lang.Exception

Parameters:

p -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getStringDelim

protected char getStringDelim(Parser p)
                       throws java.lang.Exception

Parameters:

p -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getAttributes

protected java.lang.String getAttributes(Parser p)
                                  throws java.lang.Exception

Parameters:

p -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getShowHeadings

protected boolean getShowHeadings(Parser p)
                           throws java.lang.Exception

Parameters:

p -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getFileName

protected java.lang.String getFileName(Parser p,
                                       java.lang.String mimeType,
                                       DBReport report)
                                throws java.lang.Exception

Parameters:

p -

mimeType -

report -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getColumnName

public java.lang.String getColumnName(int col)

implements getColumnName of interface CommandBuildResultsPlugin. Returns the name for the given column index. Column indexes start at 1

Parameters:

col - the column number to name

Returns:

String the name of the column

getRecordID

public java.lang.String getRecordID(int row)

the record ID

Parameters:

row - the row index

Returns:

the record ID

getColumnType

public java.lang.String getColumnType(int col)

Gets the column type for the given column index, starting at one

Parameters:

col - the column index

Returns:

String the column type

getValue

public java.lang.Object getValue(int row,
                                 int col)

the value for this row, column

Parameters:

row - the row index

col - the column

Returns:

Object the value for the given row and column