com.stimulsoft.report.export.service

Class StiExportService

java.lang.Object

com.stimulsoft.report.export.service.StiExportService

Direct Known Subclasses:

StiCsvExportService, StiExcel2007ExportService, StiExcelExportService, StiExcelXmlExportService, StiHtml5ExportService, StiHtmlExportService, StiImageExportService, StiOdsExportService, StiOdtExportService, StiPdfExportService, StiRtfExportService, StiSylkExportService, StiTxtExportService, StiWord2007ExportService, StiXmlExportService, StiXpsExportService

public abstract class StiExportService
extends java.lang.Object

Asbtract Export service Copyright Stimulsoft

Field Summary

Fields

Modifier and Type	Field and Description
int	currentPassNumber
static long	DATE_1900
protected java.io.File	exFile
protected java.util.List<java.io.File>	exportedFiles
protected StiReport	exportReport
protected StiExportSettings	exportSettings
int	maximumPassNumber
static long	MILLISECONDS_IN_DAY
protected boolean	multipleFiles
static long	ONE_HOUR
protected java.io.OutputStream	outputStream
protected int	RenderedPagesCount
protected java.lang.String	statusString

Constructor Summary

Constructors

Constructor and Description
StiExportService()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	closeProgress()
void	export() Run export thread
void	export(StiReport report)
abstract void	export(StiReport report, java.io.OutputStream outputStream, StiExportSettings settings) Export StiReport
void	export(StiReport report, java.lang.String filePath) Exports a document to the file.
void	export(StiReport report, java.lang.String filePath, boolean sendEMail) Exports a document to the stream.
java.io.File	getExFile()
java.util.List<java.io.File>	getExportedFiles()
abstract StiExportFormat	getExportFormat() Returs service export format
StiExportSettings	getExportSettings()
abstract boolean	getMultipleFiles() Gets a value indicating a number of files in exported document as a result of export
java.lang.String	getStatusString()
void	invokeExporting(int value, int maximum) Change progress bar status
void	invokeExporting(StiExportingEventArgs e) Change progress bar status
void	invokeExporting(StiPage page, StiPagesCollection pages) Change progress bar status
boolean	isStoped()
protected void	processFile(boolean sendEMail, boolean openAfterExport, java.lang.String fileName, StiReport report)
protected void	sendEMail(java.lang.String subject, java.lang.String body, java.lang.String filePath)
protected void	sendEMail(java.lang.String recipient, java.lang.String subject, java.lang.String body, java.lang.String filePath)
void	setExFile(java.io.File exFile)
void	setExportReport(StiReport exportReport)
void	setExportSettings(StiExportSettings exportSettings)
void	setOutputStream(java.io.OutputStream outputStream)
void	setProgress(IStiProgressInformation progress) Set pregress information
void	setStatusString(java.lang.String statusString)

Methods inherited from class java.lang.Object

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

Field Detail

ONE_HOUR

public static final long ONE_HOUR

See Also:

Constant Field Values

MILLISECONDS_IN_DAY

public static final long MILLISECONDS_IN_DAY

See Also:

Constant Field Values

DATE_1900

public static final long DATE_1900

See Also:

Constant Field Values

RenderedPagesCount

protected int RenderedPagesCount

exFile

protected java.io.File exFile

statusString

protected java.lang.String statusString

multipleFiles

protected boolean multipleFiles

outputStream

protected java.io.OutputStream outputStream

exportSettings

protected StiExportSettings exportSettings

exportReport

protected StiReport exportReport

exportedFiles

protected java.util.List<java.io.File> exportedFiles

currentPassNumber

public int currentPassNumber

maximumPassNumber

public int maximumPassNumber

Constructor Detail

StiExportService

public StiExportService()

Method Detail

export

public void export()
            throws java.lang.Throwable

Run export thread

Throws:

java.lang.Throwable

export

public abstract void export(StiReport report,
          java.io.OutputStream outputStream,
          StiExportSettings settings)
                     throws StiException

Export StiReport

Parameters:

report - StiReport to export

outputStream - OutputStream for export

settings - StiExportSettings

Throws:

java.lang.Exception

StiException

invokeExporting

public void invokeExporting(StiPage page,
                   StiPagesCollection pages)

Change progress bar status

Parameters:

page - StiPage currend page

pages - StiPagesCollection total exporting pages

invokeExporting

public void invokeExporting(int value,
                   int maximum)

Change progress bar status

Parameters:

value -

maximum -

invokeExporting

public void invokeExporting(StiExportingEventArgs e)

Change progress bar status

Parameters:

e - StiExportingEventArgs

closeProgress

protected void closeProgress()

export

public void export(StiReport report,
          java.lang.String filePath)

Exports a document to the file.

Parameters:

report - A StiReport which is to be exported.

filename - A file path for the export of a document.

export

public void export(StiReport report,
          java.lang.String filePath,
          boolean sendEMail)

Exports a document to the stream.

Parameters:

report - A StiReport which is to be exported.

fileName - A file path for the export of a document.

sendEMail - A parameter indicating whether is exported report will be sended

export

public void export(StiReport report)

processFile

protected void processFile(boolean sendEMail,
               boolean openAfterExport,
               java.lang.String fileName,
               StiReport report)

sendEMail

protected void sendEMail(java.lang.String subject,
             java.lang.String body,
             java.lang.String filePath)

sendEMail

protected void sendEMail(java.lang.String recipient,
             java.lang.String subject,
             java.lang.String body,
             java.lang.String filePath)

getMultipleFiles

public abstract boolean getMultipleFiles()

Gets a value indicating a number of files in exported document as a result of export

Returns:

Support multiple files

getExportFormat

public abstract StiExportFormat getExportFormat()

Returs service export format

Returns:

StiExportFormat

getStatusString

public java.lang.String getStatusString()

Returns:

the statusString

setStatusString

public void setStatusString(java.lang.String statusString)

Parameters:

statusString - the statusString to set

isStoped

public boolean isStoped()

Returns:

It the thread process was canceled

setProgress

public void setProgress(IStiProgressInformation progress)

Set pregress information

Parameters:

progress - IStiProgressInformation the progress to set

setOutputStream

public void setOutputStream(java.io.OutputStream outputStream)

Parameters:

outputStream - the outputStream to set

setExportSettings

public void setExportSettings(StiExportSettings exportSettings)

Parameters:

exportSettings - the exportSettings to set

setExportReport

public void setExportReport(StiReport exportReport)

Parameters:

exportReport - the exportReport to set

setExFile

public void setExFile(java.io.File exFile)

Parameters:

exFile - the exFile to set

getExFile

public java.io.File getExFile()

Returns:

the exFile

getExportSettings

public StiExportSettings getExportSettings()

Returns:

the exportSettings

getExportedFiles

public java.util.List<java.io.File> getExportedFiles()

Returns:

the exportedFiles