Class CSVReportBuilder

java.lang.Object

ca.phon.query.report.ReportBuilder

ca.phon.query.report.csv.CSVReportBuilder

public class CSVReportBuilder
extends ReportBuilder

CSV report builder implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CSV_LINE_TERM	CSV line term
static final String	CSV_QUOTE_CHAR	CSV quote char
static final String	CSV_SEP_CHAR	CSV separator char
static final String	FILE_ENCODING	File Encoding
static final String	INDENT_CONTENT	Property for indenting content at sections (default:false)
static final String	PRINT_SECTION_NAMES	Property for printing section names (default:true)

Fields inherited from class ca.phon.query.report.ReportBuilder

CANCEL_BUILD, TEMP_PROJECT

Constructor Summary

Constructors

Constructor	Description
CSVReportBuilder()

Method Summary

Modifier and Type	Method	Description
void	buildReport(ReportDesign design, Project project, Query query, ResultSet[] resultSets, OutputStream stream)	TODO Datasources should be given as indirect dependencies since we can re-use them for other report builders.
String	getDisplayName()	Get the display name for the builder.
String	getFileExtension()	Get the default extension for the report
String	getMimetype()	Get the mimetype created by this report builder.
Class<?>	getPropertyClass(String propName)	Returns the value type for the given property name.
Object	getPropertyDefault(String propName)	Get the default value for the given property name.
String	getPropertyMessage(String propName)	Returns the UI message associated with a property name returned by getPropertyNames()
String[]	getPropertyNames()	Returns a list of property names used for configuring the builder.
boolean	isIndentContent()	Should we indent content
boolean	isPrintSectionNames()

Methods inherited from class ca.phon.query.report.ReportBuilder

buildReport, getProperty, isBuildCanceled, putProperty

Methods inherited from class java.lang.Object

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

Field Details

INDENT_CONTENT

public static final String INDENT_CONTENT

Property for indenting content at sections (default:false)

See Also:

• Constant Field Values

PRINT_SECTION_NAMES

public static final String PRINT_SECTION_NAMES

Property for printing section names (default:true)

See Also:

• Constant Field Values

CSV_SEP_CHAR

public static final String CSV_SEP_CHAR

CSV separator char

See Also:

• Constant Field Values

CSV_QUOTE_CHAR

public static final String CSV_QUOTE_CHAR

CSV quote char

See Also:

• Constant Field Values

CSV_LINE_TERM

public static final String CSV_LINE_TERM

CSV line term

See Also:

• Constant Field Values

FILE_ENCODING

public static final String FILE_ENCODING

File Encoding

See Also:

• Constant Field Values

Constructor Details

CSVReportBuilder

public CSVReportBuilder()

Method Details

getPropertyNames

public String[] getPropertyNames()

Description copied from class: ReportBuilder

Returns a list of property names used for configuring the builder. The properties are presented as options in the report wizard.

Overrides:

getPropertyNames in class ReportBuilder

Returns:

propNames

getPropertyClass

public Class<?> getPropertyClass(String propName)

Description copied from class: ReportBuilder

Returns the value type for the given property name. NOTE: Only Boolean and String values are supported by the report wizard.

Overrides:

getPropertyClass in class ReportBuilder

Parameters:

propName -

Returns:

the class of the property value

getPropertyMessage

public String getPropertyMessage(String propName)

Description copied from class: ReportBuilder

Returns the UI message associated with a property name returned by getPropertyNames()

Overrides:

getPropertyMessage in class ReportBuilder

Parameters:

propName -

Returns:

the UI message

getPropertyDefault

public Object getPropertyDefault(String propName)

Description copied from class: ReportBuilder

Get the default value for the given property name.

Overrides:

getPropertyDefault in class ReportBuilder

Parameters:

propName -

Returns:

the default property value. This MUST be of the type returned by getPropertyClass(propName)

buildReport

public void buildReport(ReportDesign design,
 Project project,
 Query query,
 ResultSet[] resultSets,
 OutputStream stream)
                 throws ReportBuilderException

TODO Datasources should be given as indirect dependencies since we can re-use them for other report builders. Perhaps a global object can be created to keep track of created datasources so they can still be lazilly generated.

Specified by:

buildReport in class ReportBuilder

Parameters:

design - the report design

project - the phon project

resultSets - the selected searches to report on

stream - the output file

Throws:

ReportBuilderException

isIndentContent

public boolean isIndentContent()

Should we indent content

isPrintSectionNames

public boolean isPrintSectionNames()

getMimetype

public String getMimetype()

Description copied from class: ReportBuilder

Get the mimetype created by this report builder.

Specified by:

getMimetype in class ReportBuilder

Returns:

report mimetype

getFileExtension

public String getFileExtension()

Description copied from class: ReportBuilder

Get the default extension for the report

Specified by:

getFileExtension in class ReportBuilder

Returns:

default extension

getDisplayName

public String getDisplayName()

Description copied from class: ReportBuilder

Get the display name for the builder.

Specified by:

getDisplayName in class ReportBuilder

Returns:

display name