jet.server.api
Interface ResultFiles

All Superinterfaces:

java.io.Serializable

public interface ResultFiles

extends java.io.Serializable

Represent a set of result files, currently our report can be export to result file that has various format: .rst, HTML, pdf, Excel, etc.. User can get a ResultFiles object from VersionResultRecord, all result files that be exported in this version are represented by it.

See Also:

ResultVersionRecord

Method Summary

int	getAnalysisReportAmount() Represent how many reports of an Analysis report set is selected to generate result.
java.lang.String	getAstFileName() Get ast format result file name.
java.lang.String	getExcelFileName() Get excel format result file name.
java.lang.String	getHtmlFileName() Get HTML format result file name.
java.lang.String	getPdfFileName() Get pdf format result file name.
java.lang.String	getPostScriptFileName() Get Post Script format result file name.
java.util.Vector	getResultFileNames() Get all format result file names.
java.lang.String	getRsdFileName() Get rsd format result file name.
java.lang.String	getRstFileName() Get rst format result file name.
java.lang.String	getRtfFileName() Get rtf format result file name.
java.lang.String	getSvgFileName() Get svg format result file name.
java.lang.String	getTextFileName() Get plain text format result file name.
java.lang.String	getTiffFileName() Get tiff format result file name.
java.lang.String	getXmlFileName() Get XML format result file name.
boolean	hasAstFile() Check whether ast format result file is included in this result file set.
boolean	hasExcelFile() Check whether excel format result file is included in this result file set.
boolean	hasHtmlFile() Check whether HTML format result file is included in this result file set.
boolean	hasPdfFile() Check whether pdf format result file is included in this result file set.
boolean	hasPostScriptFile() Check whether Post Script format result file is included in this result file set.
boolean	hasRsdFile() Check whether rsd format result file is included in this result file set.
boolean	hasRstFile() Check whether rst format result file is included in this result file set.
boolean	hasRtfFile() Check whether rtf format result file is included in this result file set.
boolean	hasSvgFile() Check whether svg format result file is included in this result file set.
boolean	hasTextFile() Check whether plain text format result file is included in this result file set.
boolean	hasTiffFile() Check whether tiff format result file is included in this result file set.
boolean	hasXmlFile() Check whether XML format result file is included in this result file set.
boolean	isAnalysisResult() Check whether this result is generated by Analysis report set.

Method Detail

hasRstFile

public boolean hasRstFile()

Check whether rst format result file is included in this result file set.

Returns:

true if is included, otherwise false.

getRstFileName

public java.lang.String getRstFileName()

Get rst format result file name.

Returns:

rst format result file name, or return null if hasRetFile() returned false.

hasHtmlFile

public boolean hasHtmlFile()

Check whether HTML format result file is included in this result file set.

Returns:

true if is included, otherwise false.

getHtmlFileName

public java.lang.String getHtmlFileName()

Get HTML format result file name.

Returns:

HTML format result file name, or return null if hasHtmlFile() returned false.

hasPdfFile

public boolean hasPdfFile()

Check whether pdf format result file is included in this result file set.

Returns:

true if is included, otherwise false.

getPdfFileName

public java.lang.String getPdfFileName()

Get pdf format result file name.

Returns:

pdf format result file name, or return null if hasPdfFile() returned false.

hasExcelFile

public boolean hasExcelFile()

Check whether excel format result file is included in this result file set.

Returns:

true if is included, otherwise false.

getExcelFileName

public java.lang.String getExcelFileName()

Get excel format result file name.

Returns:

excel format result file name, or return null if hasExcelFile() returned false.

hasXmlFile

public boolean hasXmlFile()

Check whether XML format result file is included in this result file set.

Returns:

true if is included, otherwise false.

getXmlFileName

public java.lang.String getXmlFileName()

Get XML format result file name.

Returns:

XML format result file name, or return null if hasXmlFile() returned false.

hasPostScriptFile

public boolean hasPostScriptFile()

Check whether Post Script format result file is included in this result file set.

Returns:

true if is included, otherwise false.

getPostScriptFileName

public java.lang.String getPostScriptFileName()

Get Post Script format result file name.

Returns:

Post Script format result file name, or return null if hasPostScriptFile() returned false.

hasTextFile

public boolean hasTextFile()

Check whether plain text format result file is included in this result file set.

Returns:

true if is included, otherwise false.

getTextFileName

public java.lang.String getTextFileName()

Get plain text format result file name.

Returns:

plain text format result file name, or return null if hasTextFile() returned false.

hasRtfFile

public boolean hasRtfFile()

Check whether rtf format result file is included in this result file set.

Returns:

true if is included, otherwise false.

getRtfFileName

public java.lang.String getRtfFileName()

Get rtf format result file name.

Returns:

rtf format result file name, or return null if hasRtfFile() returned false.

hasAstFile

public boolean hasAstFile()

Check whether ast format result file is included in this result file set.

Returns:

true if is included, otherwise false.

Since:

version 6

getAstFileName

public java.lang.String getAstFileName()

Get ast format result file name.

Returns:

ast format result file name, or return null if hasAstFile() returned false.

Since:

version 6

hasTiffFile

public boolean hasTiffFile()

Check whether tiff format result file is included in this result file set.

Returns:

true if is included, otherwise false.

Since:

version 7

getTiffFileName

public java.lang.String getTiffFileName()

Get tiff format result file name.

Returns:

tiff format result file name, or return null if hasTiffFile() returned false.

Since:

version 7

hasSvgFile

public boolean hasSvgFile()

Check whether svg format result file is included in this result file set.

Returns:

true if is included, otherwise false.

Since:

version 7

getSvgFileName

public java.lang.String getSvgFileName()

Get svg format result file name.

Returns:

tiff format result file name, or return null if hasSvgFile() returned false.

Since:

version 7

hasRsdFile

public boolean hasRsdFile()

Check whether rsd format result file is included in this result file set.

Returns:

true if is included, otherwise false.

Since:

version 7.1

getRsdFileName

public java.lang.String getRsdFileName()

Get rsd format result file name.

Returns:

rsd format result file name, or return null if hasRsdFile() returned false.

Since:

version 7.1

getResultFileNames

public java.util.Vector getResultFileNames()

Get all format result file names.

Returns:

all format result file names, if there is not any format in version, this vector's size is 0;

isAnalysisResult

public boolean isAnalysisResult()

Check whether this result is generated by Analysis report set. An analysis report set may contains mulitple reports, there are multiple files for every format (exception .ast)

Returns:

true if this result generated by Analysis report set. otherwise false.

Since:

version 7

getAnalysisReportAmount

public int getAnalysisReportAmount()

Represent how many reports of an Analysis report set is selected to generate result. How many reports select, how many files will be generated for every result format (except .ast).

Returns:

represent seletec report amount, if isAnalysisResult() return false, return -1.

Since:

version 7