info.informatica.report.block
Interface Block

All Known Implementing Classes:

AbstractBlock, AbstractTableBlock, BarChartBlock, ChartBlock, DefaultTemplateBlock, DynamicBlock, ImageBlock, PdfImageBlock, PieChartBlock, RowTemplateBlock, StaticImageBlock, TableBlock, TableDataBlock, TextBlock

public interface Block

A Report Block.

Author:

Carlos Amengual (amengual at informatica.info)

Method Summary

ReportElement	filterChildReportElement(ReportElement element) When any ReportElement is added as a child of the peer ReportElement, it is filtered through this method.
info.informatica.doc.dom4j.CSSStylableElement	filterChildXHTMLElement(info.informatica.doc.dom4j.CSSStylableElement element) When any CSSStylableElement is added as a child of the peer ReportElement, it is filtered through this method.
info.informatica.util.ConditionalExpression	getCondition()
ReportElement	getPeerElement()
ReportDataSpec	getReportDataSpec() Gets the dataspec which references this block, in case of a DynamicBlock.
Properties	getTransformParameters()
void	init() Arranges the block for printing.
boolean	isHidden(Dataset dataset) Should this dataset be printed ?
void	printSample(ReportWriter rw) Print a sample of this block.
void	setCondition(info.informatica.util.ConditionalExpression conditional)
void	setReportDataSpec(ReportDataSpec spec)

Method Detail

getPeerElement

ReportElement getPeerElement()

getTransformParameters

Properties getTransformParameters()

getReportDataSpec

ReportDataSpec getReportDataSpec()

Gets the dataspec which references this block, in case of a DynamicBlock.

Returns:

the dataspec to which this block is referenced, or null if none.

setReportDataSpec

void setReportDataSpec(ReportDataSpec spec)

isHidden

boolean isHidden(Dataset dataset)

Should this dataset be printed ?

Parameters:

dataset - the Dataset to be rendered.

Returns:

true if the dataset should not be printed, false otherwise.

setCondition

void setCondition(info.informatica.util.ConditionalExpression conditional)

getCondition

info.informatica.util.ConditionalExpression getCondition()

filterChildXHTMLElement

info.informatica.doc.dom4j.CSSStylableElement filterChildXHTMLElement(info.informatica.doc.dom4j.CSSStylableElement element)

When any CSSStylableElement is added as a child of the peer ReportElement, it is filtered through this method.

If the method returns null, the element will not be added.

Parameters:

element - the child element.

Returns:

the child element, maybe modified, or null if it must not be added as child.

filterChildReportElement

ReportElement filterChildReportElement(ReportElement element)

When any ReportElement is added as a child of the peer ReportElement, it is filtered through this method.

If the method returns null, the element will not be added.

Parameters:

element - the child element.

Returns:

the child element, maybe modified, or null if it must not be added as child.

init

void init()
          throws info.informatica.doc.DocumentFormatException

Arranges the block for printing. This method must be called before printing.

Note that blocks implementing NativeBlock must also call initRender(), after init().

This method needs to be called only once, typically before generating the data to be able to check for configuration errors.

Throws:

info.informatica.doc.DocumentFormatException - if is unable to initialize due to a syntax or formatting problem.

printSample

void printSample(ReportWriter rw)
                 throws info.informatica.doc.RenderingException

Print a sample of this block. This operation is optional.

Parameters:

rw - the ReportWriter to write to.

Throws:

info.informatica.doc.RenderingException - if cannot render the sample.

UnsupportedOperationException - if this block cannot print a sample.