public abstract class AbstractReportDefinition extends Section implements ReportDefinition
ANONYMOUS_ELEMENT_PREFIX
Modifier | Constructor and Description |
---|---|
protected |
AbstractReportDefinition()
Creates a new instance.
|
protected |
AbstractReportDefinition(InstanceID id) |
Modifier and Type | Method and Description |
---|---|
void |
addExpression(Expression function)
Adds a function to the report's collection of expressions.
|
void |
addGroup(CrosstabGroup group)
Adds a crosstab group.
|
void |
addGroup(RelationalGroup group)
Adds a group to the report.
|
void |
addPreProcessor(ReportPreProcessor preProcessor) |
void |
addReportModelListener(ReportModelListener listener) |
void |
addStructureFunction(StructureFunction function)
Adds a structural function to the report.
|
AbstractReportDefinition |
clone()
Clones the report.
|
AbstractReportDefinition |
derive(boolean preserveElementInstanceIds)
Creates a deep copy of this element and regenerates all instance-ids.
|
void |
fireModelLayoutChanged(ReportElement node,
int type,
Object parameter) |
Boolean |
getAutoSort() |
ResourceKey |
getContentBase()
Returns the content base of this report.
|
CrosstabCellBody |
getCrosstabCellBody() |
abstract DataFactory |
getDataFactory()
Returns the data factory that has been assigned to this report.
|
DataSchemaDefinition |
getDataSchemaDefinition() |
long |
getDatasourceChangeTracker() |
ElementStyleSheet |
getDefaultStyleSheet()
Creates the global stylesheet for this element type.
|
ResourceKey |
getDefinitionSource()
Returns the resource-key of the file that defined this element.
|
DetailsFooter |
getDetailsFooter()
Returns the details header band.
|
DetailsHeader |
getDetailsHeader()
Returns the details header band.
|
Element |
getElement(int index)
Returns the element stored add the given index.
|
int |
getElementCount()
Returns the number of elements in this section.
|
ExpressionCollection |
getExpressions()
Returns the expressions for the report.
|
Group |
getGroup(int groupIndex)
Returns the group at the specified index or null, if there is no such group.
|
RelationalGroup |
getGroupByName(String name)
Searches a group by its defined name.
|
int |
getGroupCount()
Returns the number of groups in this report.
|
ItemBand |
getItemBand()
Returns the report's item band.
|
NoDataBand |
getNoDataBand()
Returns the report's no-data band.
|
long |
getNonVisualsChangeTracker() |
PageFooter |
getPageFooter()
Returns the page footer.
|
PageHeader |
getPageHeader()
Returns the page header.
|
ReportPreProcessor |
getPreProcessor(int index) |
int |
getPreProcessorCount() |
ReportPreProcessor[] |
getPreProcessors() |
String |
getQuery()
Returns a new query or query-name that is used when retrieving the data from the data-factory.
|
int |
getQueryLimit() |
int |
getQueryTimeout() |
RelationalGroup |
getRelationalGroup(int groupIndex) |
ReportDefinition |
getReportDefinition()
Returns the currently assigned report definition.
|
ReportFooter |
getReportFooter()
Returns the page footer.
|
ReportHeader |
getReportHeader()
Returns the report header.
|
ResourceBundleFactory |
getResourceBundleFactory()
Deprecated.
|
abstract ResourceManager |
getResourceManager()
Deprecated.
|
Group |
getRootGroup()
Returns the list of groups for the report.
|
StructureFunction |
getStructureFunction(int index)
Returns the structure function at the given position.
|
int |
getStructureFunctionCount()
Returns the number of structural functions added to the report.
|
StructureFunction[] |
getStructureFunctions()
Returns a copy of all structure functions contained in the report.
|
int |
getUserQueryLimit() |
Watermark |
getWatermark()
Returns the report's watermark band.
|
protected void |
removeElement(Element element)
Removes an element from the section.
|
void |
removeExpression(Expression expression) |
void |
removeGroup(CrosstabGroup group) |
void |
removeGroup(RelationalGroup deleteGroup) |
void |
removePreProcessor(ReportPreProcessor preProcessor) |
void |
removeReportModelListener(ReportModelListener listener) |
void |
removeStructureFunction(StructureFunction f)
Removes the given function from the collection of structure functions.
|
void |
setAutoSort(Boolean sort) |
void |
setContentBase(ResourceKey key)
Defines the content base for the report.
|
abstract void |
setDataFactory(DataFactory dataFactory)
Sets the data factory for the report.
|
void |
setDataSchemaDefinition(DataSchemaDefinition dataSchemaDefinition) |
void |
setDefinitionSource(ResourceKey key) |
void |
setElementAt(int position,
Element element) |
void |
setExpressions(ExpressionCollection expressions)
Sets the expressions for the report.
|
void |
setPageFooter(PageFooter footer)
Sets the page footer.
|
void |
setPageHeader(PageHeader header)
Sets the page header.
|
void |
setQuery(String query)
Defines a new query or query-name that is used when retrieving the data from the data-factory.
|
void |
setQueryLimit(int queryLimit) |
void |
setQueryTimeout(int queryTimeout) |
void |
setReportFooter(ReportFooter footer)
Sets the report footer.
|
void |
setReportHeader(ReportHeader header)
Sets the report header.
|
void |
setResourceBundleFactory(ResourceBundleFactory resourceBundleFactory)
Deprecated.
|
void |
setRootGroup(Group rootGroup) |
void |
setUserQueryLimit(int queryLimit) |
void |
setWatermark(Watermark band)
Sets the watermark band for the report.
|
iterator, registerAsChild, unregisterAsChild, unregisterParent, validateLooping
copyAttributes, copyInto, derive, getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeExpressions, getAttributeNames, getAttributeNamespaces, getAttributes, getAttributeTyped, getChangeTracker, getChildElementByType, getChildElementsByName, getChildElementsByType, getComputedStyle, getDataSource, getElementContext, getElementType, getElementTypeName, getFirstAttribute, getHRefTarget, getId, getMasterReport, getMetaData, getName, getObjectID, getParent, getParentSection, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, isDynamicContent, isVisible, notifyElement, notifyNodeChildAdded, notifyNodeChildRemoved, notifyNodePropertiesChanged, notifyNodePropertiesChanged, notifyNodeStructureChanged, setAttribute, setAttribute, setAttributeExpression, setChangeTracker, setComputedStyle, setDataSource, setDynamicContent, setElementType, setHRefTarget, setId, setName, setParent, setStyleExpression, setVisible, toString, updateChangedFlagInternal, updateInternalChangeFlag
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getPageDefinition
getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeNames, getAttributeNamespaces, getAttributes, getAttributeTyped, getChangeTracker, getChildElementByType, getChildElementsByName, getChildElementsByType, getComputedStyle, getElementContext, getElementType, getFirstAttribute, getId, getMetaData, getName, getObjectID, getParentSection, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, setAttribute, setAttribute, setAttributeExpression, setComputedStyle, setStyleExpression
forEach, spliterator
protected AbstractReportDefinition(InstanceID id)
protected AbstractReportDefinition()
@Deprecated public ResourceBundleFactory getResourceBundleFactory()
ResourceBundleFactory
is used in
internationalized reports to create the resourcebundles holding the localized resources.@Deprecated public void setResourceBundleFactory(ResourceBundleFactory resourceBundleFactory)
resourceBundleFactory
- the new resource bundle factory, never null.NullPointerException
- if the given ResourceBundleFactory is null.public int getPreProcessorCount()
public ReportPreProcessor[] getPreProcessors()
public ReportPreProcessor getPreProcessor(int index)
public void addPreProcessor(ReportPreProcessor preProcessor)
public void removePreProcessor(ReportPreProcessor preProcessor)
public Group getRootGroup()
ReportDefinition
getRootGroup
in interface ReportDefinition
public void setRootGroup(Group rootGroup)
public void setReportHeader(ReportHeader header)
header
- the report header (null
not permitted).public ReportHeader getReportHeader()
getReportHeader
in interface ReportDefinition
null
).public void setReportFooter(ReportFooter footer)
footer
- the report footer (null
not permitted).public ReportFooter getReportFooter()
getReportFooter
in interface ReportDefinition
null
).public void setPageHeader(PageHeader header)
header
- the page header (null
not permitted).public PageHeader getPageHeader()
getPageHeader
in interface ReportDefinition
null
).public void setPageFooter(PageFooter footer)
footer
- the page footer (null
not permitted).public PageFooter getPageFooter()
getPageFooter
in interface ReportDefinition
null
).public void setWatermark(Watermark band)
band
- the new watermark band (null
not permitted).public Watermark getWatermark()
getWatermark
in interface ReportDefinition
null
).public NoDataBand getNoDataBand()
getNoDataBand
in interface ReportDefinition
null
).public ItemBand getItemBand()
getItemBand
in interface ReportDefinition
null
).public DetailsHeader getDetailsHeader()
getDetailsHeader
in interface ReportDefinition
public DetailsFooter getDetailsFooter()
getDetailsFooter
in interface ReportDefinition
public void addGroup(RelationalGroup group)
group
- the group.public void addGroup(CrosstabGroup group)
group
- public void removeGroup(CrosstabGroup group)
public void removeGroup(RelationalGroup deleteGroup)
public int getGroupCount()
Every report has at least one group defined.
getGroupCount
in interface ReportDefinition
public RelationalGroup getRelationalGroup(int groupIndex)
public Group getGroup(int groupIndex)
getGroup
in interface ReportDefinition
groupIndex
- the group index.IllegalArgumentException
- if the count is negative.IndexOutOfBoundsException
- if the count is greater than the number of defined groups.public RelationalGroup getGroupByName(String name)
name
- the name of the group.public void addExpression(Expression function)
function
- the function.public int getQueryTimeout()
getQueryTimeout
in interface ReportDefinition
public void setQueryTimeout(int queryTimeout)
public int getQueryLimit()
getQueryLimit
in interface ReportDefinition
public void setQueryLimit(int queryLimit)
public int getUserQueryLimit()
public void setUserQueryLimit(int queryLimit)
public String getQuery()
getQuery
in interface ReportDefinition
public void setQuery(String query)
query
- the query-string.DataFactory.queryData(String, DataRow)
public ExpressionCollection getExpressions()
public void setExpressions(ExpressionCollection expressions)
expressions
- the expressions (null
not permitted).public AbstractReportDefinition clone()
clone
in interface DataTarget
clone
in class Section
public AbstractReportDefinition derive(boolean preserveElementInstanceIds)
Element
derive
in class Section
preserveElementInstanceIds
- defines whether this call generates new instance-ids for the derived elements. Instance-IDs are used by
the report processor to recognize reoccurring elements and must not changed within the report run. Outside
of the report processors new instance ids should be generated at all times to separate instances and to
make them uniquely identifiable.public void setElementAt(int position, Element element)
setElementAt
in class Section
protected void removeElement(Element element)
Section
removeElement
in class Section
element
- the element to be section.public int getElementCount()
Section
getElementCount
in class Section
public Element getElement(int index)
Section
getElement
in class Section
index
- the element position within this sectionpublic void setContentBase(ResourceKey key)
key
- the content base or null.public ResourceKey getContentBase()
getContentBase
in class Element
public void setDefinitionSource(ResourceKey key)
public ResourceKey getDefinitionSource()
Element
getDefinitionSource
in class Element
public ReportDefinition getReportDefinition()
getReportDefinition
in interface ReportElement
getReportDefinition
in class Element
public abstract DataFactory getDataFactory()
public abstract void setDataFactory(DataFactory dataFactory)
dataFactory
- the data factory for the report, never null.public void addReportModelListener(ReportModelListener listener)
public void removeReportModelListener(ReportModelListener listener)
public void fireModelLayoutChanged(ReportElement node, int type, Object parameter)
public long getDatasourceChangeTracker()
public long getNonVisualsChangeTracker()
public void removeExpression(Expression expression)
public DataSchemaDefinition getDataSchemaDefinition()
public void setDataSchemaDefinition(DataSchemaDefinition dataSchemaDefinition)
@Deprecated public abstract ResourceManager getResourceManager()
public void addStructureFunction(StructureFunction function)
function
- the structure function.public int getStructureFunctionCount()
public StructureFunction getStructureFunction(int index)
index
- the position of the function in the list.IndexOutOfBoundsException
- if the index is invalid.public void removeStructureFunction(StructureFunction f)
f
- the function to be removed.public StructureFunction[] getStructureFunctions()
public ElementStyleSheet getDefaultStyleSheet()
Section
getDefaultStyleSheet
in interface ReportElement
getDefaultStyleSheet
in class Section
public CrosstabCellBody getCrosstabCellBody()
getCrosstabCellBody
in interface ReportDefinition
public void setAutoSort(Boolean sort)
public Boolean getAutoSort()
Copyright © 2002–2017 Pentaho Corporation. All rights reserved.