org.eclipse.tptp.platform.report.birt.core.internal.impl
Class ReportElementImpl

java.lang.Object
  org.eclipse.tptp.platform.report.birt.core.internal.impl.ReportElementImpl

All Implemented Interfaces:

org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Direct Known Subclasses:

StatisticalReportElement

public class ReportElementImpl
extends java.lang.Object
implements org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Field Summary

protected java.util.List	childElements
protected java.util.List	content
protected org.eclipse.tptp.platform.common.provisional.IOperationContext	context
protected java.io.InputStream	dataSource
protected java.io.OutputStream	outputStream
protected java.lang.String	rootFile

Constructor Summary

ReportElementImpl()

Method Summary

void	generate()
java.util.List	getChildElements() A list of child report elements.
java.util.List	getContent()
org.eclipse.tptp.platform.common.provisional.IOperationContext	getContext() Returns the context object used to pass in report configuration information
java.io.InputStream	getDataSource() Returns the input stream that contains the raw data to generate the report.
protected java.lang.String	getImageDir()
java.io.OutputStream	getOutputStream() Returns the output stream containing the resulting HTML content.
java.lang.String	getRootFile()
java.io.InputStream	getTemplateFile() Returns the input stream that contains the BIRT template file.
void	initialize() Initializes the state of the report element object before generating the report.
boolean	isEmbedded() Determines if the generated HTML output should generate head or body tags.
boolean	isSortable() Determins if the generated HTML output should embed javascript to sort table columns.
void	setContent(java.util.List content)
void	setContext(org.eclipse.tptp.platform.common.provisional.IOperationContext context) Sets the context object used to pass in report configuration information
void	setDataSource(java.io.InputStream dataSource) Sets the input stream that represents the raw data.
void	setEmbedded(boolean embedded) Sets if the generated HTML output should generate head or body tags.
void	setOutputStream(java.io.OutputStream outputStream) Sets the output stream containing the resulting HTML content.
void	setRootFile(java.lang.String rootFile)
void	setSortable(boolean sortable) Sets whether the generated HTML output should contain javascript to sort table columns.
void	setTemplateFile(java.io.InputStream templateFile) Sets the input stream that contains the BIRT template file.

Methods inherited from class java.lang.Object

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

Field Detail

dataSource

protected java.io.InputStream dataSource

outputStream

protected java.io.OutputStream outputStream

content

protected java.util.List content

childElements

protected java.util.List childElements

context

protected org.eclipse.tptp.platform.common.provisional.IOperationContext context

rootFile

protected java.lang.String rootFile

Constructor Detail

ReportElementImpl

public ReportElementImpl()

Method Detail

getRootFile

public java.lang.String getRootFile()

setRootFile

public void setRootFile(java.lang.String rootFile)

getTemplateFile

public java.io.InputStream getTemplateFile()

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns the input stream that contains the BIRT template file.

Specified by:

getTemplateFile in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns:

the input stream that contains the BIRT template file.

setTemplateFile

public void setTemplateFile(java.io.InputStream templateFile)

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Sets the input stream that contains the BIRT template file.

Specified by:

setTemplateFile in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Parameters:

templateFile - the input stream that contains the BIRT template file.

getOutputStream

public java.io.OutputStream getOutputStream()

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns the output stream containing the resulting HTML content.

Specified by:

getOutputStream in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns:

the output stream containing the resulting HTML content.

setOutputStream

public void setOutputStream(java.io.OutputStream outputStream)

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Sets the output stream containing the resulting HTML content.

Specified by:

setOutputStream in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Parameters:

outputStream - the output stream containing the resulting HTML content.

getDataSource

public java.io.InputStream getDataSource()

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns the input stream that contains the raw data to generate the report. Note the type of datasource (ie. xml, csv, etc) should be the expected data source needed by the report template file.

Specified by:

getDataSource in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns:

an input stream representing the raw data

setDataSource

public void setDataSource(java.io.InputStream dataSource)

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Sets the input stream that represents the raw data.

Specified by:

setDataSource in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Parameters:

dataSource - the input stream that represents the raw data.

getChildElements

public java.util.List getChildElements()

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

A list of child report elements. The list should contain a list of object of type IReportElement.

Specified by:

getChildElements in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns:

a list of child report elements.

getContent

public java.util.List getContent()

setContent

public void setContent(java.util.List content)

isEmbedded

public boolean isEmbedded()

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Determines if the generated HTML output should generate head or body tags. If true the resulting html output will not contain head or body tags.

Specified by:

isEmbedded in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns:

true if the resulting html output will contain head or body tags otherwise false is returned.

setEmbedded

public void setEmbedded(boolean embedded)

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Sets if the generated HTML output should generate head or body tags. If true the resulting html output will not contain head or body tags.

Specified by:

setEmbedded in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Parameters:

embedded - true if the resulting html output should contain head or body tags.

isSortable

public boolean isSortable()

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Determins if the generated HTML output should embed javascript to sort table columns. If true javascript will be embedded in the resulting html report to sort columns in tables. Note the table id in the report template must be set to 'sortable'.

Specified by:

isSortable in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns:

true if the generated HTML output will sort table columns

setSortable

public void setSortable(boolean sortable)

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Sets whether the generated HTML output should contain javascript to sort table columns. Note the table id in the report template file must be set to 'sortable'.

Specified by:

setSortable in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Parameters:

sortable - set whether the generated HTML output should contain javascript to sort table columns.

initialize

public void initialize()

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Initializes the state of the report element object before generating the report.

Specified by:

initialize in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

getContext

public org.eclipse.tptp.platform.common.provisional.IOperationContext getContext()

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns the context object used to pass in report configuration information

Specified by:

getContext in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Returns:

the context object used to pass in report configuration information

setContext

public void setContext(org.eclipse.tptp.platform.common.provisional.IOperationContext context)

Description copied from interface: org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Sets the context object used to pass in report configuration information

Specified by:

setContext in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement

Parameters:

context - the context object used to pass in report configuration information

getImageDir

protected java.lang.String getImageDir()

generate

public void generate()

Specified by:

generate in interface org.eclipse.tptp.platform.report.birt.core.provisional.IReportElement