Class DataExtractionOption
java.lang.Object
org.eclipse.birt.report.engine.api.TaskOption
org.eclipse.birt.report.engine.api.DataExtractionOption
- All Implemented Interfaces:
IDataExtractionOption
,IExtractionOption
,ITaskOption
-
Field Summary
Fields inherited from class org.eclipse.birt.report.engine.api.TaskOption
options
Fields inherited from interface org.eclipse.birt.report.engine.api.IDataExtractionOption
ACTION_HANDLER, EXTENSION, IMAGE_HANDLER, INSTANCE_ID, LOCALE
Fields inherited from interface org.eclipse.birt.report.engine.api.IExtractionOption
OPTION_FORMATTER, OUTPUT_FILE_NAME, OUTPUT_FORMAT, OUTPUT_STREAM
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet extension.Get the format option.Get output file name.Get output format.Get output stream.void
setActionHandler
(IHTMLActionHandler actionHandler) void
setExtension
(String extension) Set extension id.void
setFormatter
(Map formatters) Set the formatters used to output the value.void
setImageHandler
(IHTMLImageHandler imageHandler) void
setInstanceID
(InstanceID iid) void
setOutputFile
(String filename) Set output file.void
setOutputFormat
(String format) Set output format.void
Set output stream.Methods inherited from class org.eclipse.birt.report.engine.api.TaskOption
getBooleanOption, getIntOption, getOption, getOptions, getStringOption, hasOption, setOption
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.birt.report.engine.api.ITaskOption
getOption, getOptions, hasOption, setOption
-
Constructor Details
-
DataExtractionOption
public DataExtractionOption() -
DataExtractionOption
-
-
Method Details
-
setExtension
Set extension id.- Specified by:
setExtension
in interfaceIDataExtractionOption
- Parameters:
extension
- extension id.
-
setOutputFile
Set output file.- Specified by:
setOutputFile
in interfaceIExtractionOption
- Parameters:
filename
- name of the output file.
-
setOutputFormat
Set output format.- Specified by:
setOutputFormat
in interfaceIExtractionOption
- Parameters:
format
- output format.
-
setOutputStream
Set output stream.- Specified by:
setOutputStream
in interfaceIExtractionOption
- Parameters:
out
- output stream.
-
getExtension
Get extension.- Specified by:
getExtension
in interfaceIDataExtractionOption
-
getOutputFile
Get output file name.- Specified by:
getOutputFile
in interfaceIExtractionOption
-
getOutputFormat
Get output format.- Specified by:
getOutputFormat
in interfaceIExtractionOption
-
getOutputStream
Get output stream.- Specified by:
getOutputStream
in interfaceIExtractionOption
-
getActionHandler
- Specified by:
getActionHandler
in interfaceIDataExtractionOption
-
getImageHandler
- Specified by:
getImageHandler
in interfaceIDataExtractionOption
-
getInstanceID
- Specified by:
getInstanceID
in interfaceIDataExtractionOption
-
setActionHandler
- Specified by:
setActionHandler
in interfaceIDataExtractionOption
-
setImageHandler
- Specified by:
setImageHandler
in interfaceIDataExtractionOption
-
setInstanceID
- Specified by:
setInstanceID
in interfaceIDataExtractionOption
-
setFormatter
Description copied from interface:IExtractionOption
Set the formatters used to output the value. The format option is a hash map, the key can be the column name or column index (start from 1), the value should be a format pattern. If no format is defined, the value should be outputted as current implementation.- Specified by:
setFormatter
in interfaceIExtractionOption
-
getFormatter
Description copied from interface:IExtractionOption
Get the format option.- Specified by:
getFormatter
in interfaceIExtractionOption
- Returns:
-