public class SubReport extends AbstractReportDefinition
ANONYMOUS_ELEMENT_PREFIX
Constructor and Description |
---|
SubReport()
Creates a new subreport instance.
|
SubReport(InstanceID id) |
Modifier and Type | Method and Description |
---|---|
void |
addExportParameter(String outerName,
String sourceColumn)
Adds an export-parameter mapping to the subreport.
|
void |
addInputParameter(String outerName,
String sourceColumn)
Adds an input-parameter mapping to the subreport.
|
void |
clearExportParameters() |
void |
clearInputParameters() |
SubReport |
clone()
Clones the report.
|
SubReport |
derive(boolean preserveElementInstanceIds)
Clones the report.
|
Expression |
getActivationExpression() |
DataFactory |
getDataFactory()
Returns the data factory that has been assigned to this report.
|
ParameterMapping[] |
getExportMappings()
Returns the parameter mappings for the subreport.
|
ParameterMapping[] |
getInputMappings()
Returns the input mappings defined for this subreport.
|
PageDefinition |
getPageDefinition()
Returns the page definition assigned to the report definition.
|
ResourceBundleFactory |
getResourceBundleFactory()
Deprecated.
|
org.pentaho.reporting.libraries.resourceloader.ResourceManager |
getResourceManager()
Deprecated.
|
boolean |
isGlobalExport()
Checks whether a global export is defined.
|
boolean |
isGlobalImport()
Checks whether a global import is defined.
|
void |
reconnectParent(Section parentSection) |
void |
removeExportParameter(String outerName)
Removes the export parameter from the mapping.
|
void |
removeInputParameter(String sourceColumn)
Removes the input parameter from the parameter mapping.
|
void |
setActivationExpression(Expression activationExpression) |
void |
setDataFactory(DataFactory dataFactory)
The (optional) data-factory for the subreport.
|
void |
setExportMappings(ParameterMapping[] mappings) |
void |
setInputMappings(ParameterMapping[] mappings) |
addExpression, addGroup, addGroup, addPreProcessor, addReportModelListener, addStructureFunction, fireModelLayoutChanged, getAutoSort, getContentBase, getCrosstabCellBody, getDataSchemaDefinition, getDatasourceChangeTracker, getDefaultStyleSheet, getDefinitionSource, getDetailsFooter, getDetailsHeader, getElement, getElementCount, getExpressions, getGroup, getGroupByName, getGroupCount, getItemBand, getNoDataBand, getNonVisualsChangeTracker, getPageFooter, getPageHeader, getPreProcessor, getPreProcessorCount, getPreProcessors, getQuery, getQueryLimit, getQueryTimeout, getRelationalGroup, getReportDefinition, getReportFooter, getReportHeader, getRootGroup, getStructureFunction, getStructureFunctionCount, getStructureFunctions, getUserQueryLimit, getWatermark, removeExpression, removeGroup, removeGroup, removePreProcessor, removeReportModelListener, removeStructureFunction, setAutoSort, setContentBase, setDataSchemaDefinition, setDefinitionSource, setElementAt, setExpressions, setPageFooter, setPageHeader, setQuery, setQueryLimit, setQueryTimeout, setReportFooter, setReportHeader, setResourceBundleFactory, setRootGroup, setUserQueryLimit, setWatermark
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, notifyNodeChildAdded, notifyNodeChildRemoved, notifyNodePropertiesChanged, notifyNodePropertiesChanged, notifyNodeStructureChanged, setAttribute, setAttribute, setAttributeExpression, setComputedStyle, setDataSource, setDynamicContent, setElementType, setHRefTarget, setId, setName, setStyleExpression, setVisible, toString
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
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
public SubReport()
public SubReport(InstanceID id)
public PageDefinition getPageDefinition()
public SubReport derive(boolean preserveElementInstanceIds)
derive
in class AbstractReportDefinition
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 reconnectParent(Section parentSection)
public SubReport clone()
clone
in interface DataTarget
clone
in class AbstractReportDefinition
public void addExportParameter(String outerName, String sourceColumn)
outerName
- the name the parameter will get in the master report.sourceColumn
- the source-column in the sub-report.public void removeExportParameter(String outerName)
outerName
- the name of the parameter as it is known in the master report.public ParameterMapping[] getExportMappings()
public void setExportMappings(ParameterMapping[] mappings)
public void addInputParameter(String outerName, String sourceColumn)
outerName
- the name of the parent report's column that provides the data.sourceColumn
- the name under which the parameter will be available in the subreport.public void removeInputParameter(String sourceColumn)
sourceColumn
- the name of the column of the subreport report that acts as source for the input parameter.public void clearInputParameters()
public void clearExportParameters()
public ParameterMapping[] getInputMappings()
public void setInputMappings(ParameterMapping[] mappings)
public boolean isGlobalImport()
public boolean isGlobalExport()
public DataFactory getDataFactory()
AbstractReportDefinition
getDataFactory
in class AbstractReportDefinition
public void setDataFactory(DataFactory dataFactory)
setDataFactory
in class AbstractReportDefinition
dataFactory
- public Expression getActivationExpression()
public void setActivationExpression(Expression activationExpression)
@Deprecated public org.pentaho.reporting.libraries.resourceloader.ResourceManager getResourceManager()
AbstractReportDefinition
getResourceManager
in class AbstractReportDefinition
@Deprecated public ResourceBundleFactory getResourceBundleFactory()
AbstractReportDefinition
ResourceBundleFactory
is used in
internationalized reports to create the resourcebundles holding the localized resources.getResourceBundleFactory
in class AbstractReportDefinition