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
public class DataExtractionOption extends TaskOption implements IDataExtractionOption
-
-
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 Constructor Description DataExtractionOption()
DataExtractionOption(java.util.Map options)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IHTMLActionHandler
getActionHandler()
java.lang.String
getExtension()
Get extension.java.util.Map
getFormatter()
Get the format option.IHTMLImageHandler
getImageHandler()
InstanceID
getInstanceID()
java.lang.String
getOutputFile()
Get output file name.java.lang.String
getOutputFormat()
Get output format.java.io.OutputStream
getOutputStream()
Get output stream.void
setActionHandler(IHTMLActionHandler actionHandler)
void
setExtension(java.lang.String extension)
Set extension id.void
setFormatter(java.util.Map formatters)
Set the formatters used to output the value.void
setImageHandler(IHTMLImageHandler imageHandler)
void
setInstanceID(InstanceID iid)
void
setOutputFile(java.lang.String filename)
Set output file.void
setOutputFormat(java.lang.String format)
Set output format.void
setOutputStream(java.io.OutputStream out)
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
-
-
-
-
Method Detail
-
setExtension
public void setExtension(java.lang.String extension)
Set extension id.- Specified by:
setExtension
in interfaceIDataExtractionOption
- Parameters:
extension
- extension id.
-
setOutputFile
public void setOutputFile(java.lang.String filename)
Set output file.- Specified by:
setOutputFile
in interfaceIExtractionOption
- Parameters:
filename
- name of the output file.
-
setOutputFormat
public void setOutputFormat(java.lang.String format)
Set output format.- Specified by:
setOutputFormat
in interfaceIExtractionOption
- Parameters:
format
- output format.
-
setOutputStream
public void setOutputStream(java.io.OutputStream out)
Set output stream.- Specified by:
setOutputStream
in interfaceIExtractionOption
- Parameters:
out
- output stream.
-
getExtension
public java.lang.String getExtension()
Get extension.- Specified by:
getExtension
in interfaceIDataExtractionOption
-
getOutputFile
public java.lang.String getOutputFile()
Get output file name.- Specified by:
getOutputFile
in interfaceIExtractionOption
-
getOutputFormat
public java.lang.String getOutputFormat()
Get output format.- Specified by:
getOutputFormat
in interfaceIExtractionOption
-
getOutputStream
public java.io.OutputStream getOutputStream()
Get output stream.- Specified by:
getOutputStream
in interfaceIExtractionOption
-
getActionHandler
public IHTMLActionHandler getActionHandler()
- Specified by:
getActionHandler
in interfaceIDataExtractionOption
-
getImageHandler
public IHTMLImageHandler getImageHandler()
- Specified by:
getImageHandler
in interfaceIDataExtractionOption
-
getInstanceID
public InstanceID getInstanceID()
- Specified by:
getInstanceID
in interfaceIDataExtractionOption
-
setActionHandler
public void setActionHandler(IHTMLActionHandler actionHandler)
- Specified by:
setActionHandler
in interfaceIDataExtractionOption
-
setImageHandler
public void setImageHandler(IHTMLImageHandler imageHandler)
- Specified by:
setImageHandler
in interfaceIDataExtractionOption
-
setInstanceID
public void setInstanceID(InstanceID iid)
- Specified by:
setInstanceID
in interfaceIDataExtractionOption
-
setFormatter
public void setFormatter(java.util.Map formatters)
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
public java.util.Map getFormatter()
Description copied from interface:IExtractionOption
Get the format option.- Specified by:
getFormatter
in interfaceIExtractionOption
- Returns:
-
-