Package net.datenwerke.rs.core.service.reportmanager.entities.reports

Class Report

java.lang.Object

net.datenwerke.treedb.service.treedb.AbstractNode<AbstractReportManagerNode>

net.datenwerke.security.service.treedb.entities.SecuredAbstractNode<AbstractReportManagerNode>

net.datenwerke.rs.core.service.reportmanager.entities.AbstractReportManagerNode

net.datenwerke.rs.core.service.reportmanager.entities.reports.Report

All Implemented Interfaces:

Serializable, DatasourceContainerProvider, ParameterContainerNode, HierarchicalSecurityTarget, Owneable, SecurityTarget

Direct Known Subclasses:

BirtReport, CrystalReport, GridEditorReport, JasperReport, JxlsReport, SaikuReport, ScriptReport, TableReport

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@GenerateDto(dtoPackage="net.datenwerke.rs.core.client.reportmanager.dto.reports",createDecorator=true,dtoImplementInterfaces=<error>,poso2DtoPostProcessors=Report2DtoPostProcessor.class,dto2PosoSupervisor=Dto2ReportSupervisor.class,dto2PosoPostProcessors=Dto2ReportPostProcessor.class,typeDescriptionMsg=ReportmanagerMessages.class,typeDescriptionKey="reportLabel",additionalFields={,,,,})
@EntityDiffGuides(guides=@EntityDiffGuide(name="report_identicalForExecution",ignoreId=true,ignoreVersion=true,whitelist={"parameterDefinitions","parameterInstances","datasourceContainer"}))
public abstract class Report
extends AbstractReportManagerNode
implements ParameterContainerNode, DatasourceContainerProvider

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENTITY_DIFF_IDENTITCAL_FOR_EXECUTION

Fields inherited from class net.datenwerke.treedb.service.treedb.AbstractNode

FLAG_CONFIGURATION_PROTECTION, FLAG_WRITE_PROTECTION

Constructor Summary

Constructors

Constructor	Description
Report()

Method Summary

Modifier and Type	Method	Description
void	addParameterDefinition(ParameterDefinition definition)	Do not call directly
void	addParameterInstance(ParameterInstance instance)
void	addReportMetadata(ReportMetadata metadata)
void	addReportProperty(ReportProperty property)
Report	createNewVariant(Report adjustedReport)	Creates a new variant of this report (or variant) with the changes given by adjustedReport.
Report	createTemporaryVariant()
Report	createTemporaryVariant(Report adjustedReport)	Do not try to convert a temporary variant into a persistent one (rather create a new one).
DatasourceContainer	getDatasourceContainer()
String	getDescription()
ReportProperty	getEffectiveReportProperty(String name)	Returns the report property effective for the current report.
Object	getEffectiveReportStringPropertyValue(String name, Object defaultValue, Function<ReportStringProperty,Object> f)
String	getKey()
String	getName()
ParameterDefinition	getParameterDefinitionByKey(String name)
List<ParameterDefinition>	getParameterDefinitions()
<T extends ParameterDefinition<?>> List<T>	getParameterDefinitionsOfType(Class<T> type)
Set<ParameterDefinition>	getParameterDefinitionsSafe()	getParameterDefinitions() may fail when in an unmanaged report
ParameterInstance	getParameterInstanceFor(ParameterDefinition definition)
Set<ParameterInstance>	getParameterInstances()
ParameterInstance<?>	getParamInstanceByDefinitionId(Long id)
PreviewImage	getPreviewImage()
Set<ReportMetadata>	getReportMetadata()
ReportMetadata	getReportMetadataByName(String key)
Set<ReportProperty>	getReportProperties()
ReportProperty	getReportProperty(String name)
String	getReportProperty(String propertyName, String defaultValue)
ReportProperty	getReportPropertyByName(String name)
Class<?>	getTemporaryVariantType()
String	getType()	Returns the Report's type (the classes simple name).
String	getUuid()	Deprecated.
boolean	hasReportMetadata(ReportMetadata metadata)
boolean	hasReportProperty(ReportProperty property)
boolean	isIdenticalForExecution(Report report)
void	removeParameterDefinition(ParameterDefinition paramter)
void	removeParameterInstance(ParameterInstance instance)
void	removeReportMetadata(ReportMetadata metadata)	Do not call this method directly (use ReportService instead)
void	removeReportProperty(ReportProperty property)	Do not call this method directly (use ReportService instead)
void	replaceWith(Report report, Injector injector)
void	setDatasourceContainer(DatasourceContainer datasourceContainer)
void	setDescription(String description)
void	setKey(String key)
void	setName(String name)
void	setParameterDefinitions(List<ParameterDefinition> parameters)
void	setParameterInstances(Set<ParameterInstance> parameterInstances)
void	setPreviewImage(PreviewImage previewImage)
void	setReportMetadata(Set<ReportMetadata> reportMetadata)
void	setReportProperties(Set<ReportProperty> complexProperties)
void	setTemporaryVariantType(Class<?> temporaryVariantType)
void	setUuid(String uuid)	Deprecated.
String	toString()
boolean	usesParameter(String key)

Methods inherited from class net.datenwerke.rs.core.service.reportmanager.entities.AbstractReportManagerNode

getNodeName, getRootNodeName

Methods inherited from class net.datenwerke.security.service.treedb.entities.SecuredAbstractNode

getAcl, getOwner, getParentTarget, setAcl, setOwner

Methods inherited from class net.datenwerke.treedb.service.treedb.AbstractNode

addChild, addChild, addFlag, clearFlags, equals, getBaseType, getChildren, getChildrenOfType, getChildrenSorted, getCreatedOn, getDeniedChildren, getDescendants, getDescendants, getFlags, getId, getIdOrOldTransient, getLastUpdated, getManagerClass, getOldTransientId, getOldTransientKey, getParent, getPosition, getRootLine, getSupportedChildren, getVersion, hasChildren, hasChildrenOfType, hasDescendantsOfType, hasFlag, hashCode, idsMatch, isAncestorOf, isConfigurationProtected, isFolder, isRoot, isUpdateLastUpdated, isWriteProtected, removeChild, removeFlag, setChildren, setConfigurationProtection, setCreatedOn, setFlags, setId, setLastUpdated, setOldTransientId, setOldTransientKey, setParent, setPosition, setUpdateLastUpdated, setVersion, setWriteProtection, wouldContainFlag

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

ENTITY_DIFF_IDENTITCAL_FOR_EXECUTION

public static final String ENTITY_DIFF_IDENTITCAL_FOR_EXECUTION

See Also:

• Constant Field Values

Constructor Details

Report

public Report()

Method Details

getType

public String getType()

Returns the Report's type (the classes simple name).

getName

public String getName()

Specified by:

getName in class AbstractReportManagerNode

setName

public void setName(String name)

getKey

public String getKey()

setKey

public void setKey(String key)

setReportMetadata

public void setReportMetadata(Set<ReportMetadata> reportMetadata)

getReportMetadata

public Set<ReportMetadata> getReportMetadata()

addReportMetadata

public void addReportMetadata(ReportMetadata metadata)

hasReportMetadata

public boolean hasReportMetadata(ReportMetadata metadata)

getReportMetadataByName

public ReportMetadata getReportMetadataByName(String key)

removeReportMetadata

public void removeReportMetadata(ReportMetadata metadata)

Do not call this method directly (use ReportService instead)

Parameters:

metadata -

See Also:

• ReportService.remove(Report, ReportMetadata)

getReportProperties

public Set<ReportProperty> getReportProperties()

setReportProperties

public void setReportProperties(Set<ReportProperty> complexProperties)

addReportProperty

public void addReportProperty(ReportProperty property)

hasReportProperty

public boolean hasReportProperty(ReportProperty property)

getEffectiveReportProperty

public ReportProperty getEffectiveReportProperty(String name)

Returns the report property effective for the current report. I.e., If the report is a variant, if returns the variant's property if found. If not found, it returns the parent's property if found. If the report is not a variant, returns the report's property if found.

Parameters:

name - the name of the property

Returns:

the report property applicable for the report

getEffectiveReportStringPropertyValue

public Object getEffectiveReportStringPropertyValue(String name,
 Object defaultValue,
 Function<ReportStringProperty,Object> f)

removeReportProperty

public void removeReportProperty(ReportProperty property)

Do not call this method directly (use ReportService instead)

Parameters:

property -

See Also:

• ReportService.remove(Report, ReportProperty)

getDatasourceContainer

public DatasourceContainer getDatasourceContainer()

Specified by:

getDatasourceContainer in interface DatasourceContainerProvider

setDatasourceContainer

public void setDatasourceContainer(DatasourceContainer datasourceContainer)

Specified by:

setDatasourceContainer in interface DatasourceContainerProvider

getParameterDefinitions

public List<ParameterDefinition> getParameterDefinitions()

Specified by:

getParameterDefinitions in interface ParameterContainerNode

getParameterDefinitionsSafe

public Set<ParameterDefinition> getParameterDefinitionsSafe()

getParameterDefinitions() may fail when in an unmanaged report

setParameterDefinitions

public void setParameterDefinitions(List<ParameterDefinition> parameters)

Specified by:

setParameterDefinitions in interface ParameterContainerNode

addParameterDefinition

public void addParameterDefinition(ParameterDefinition definition)

Do not call directly

Specified by:

addParameterDefinition in interface ParameterContainerNode

removeParameterDefinition

public void removeParameterDefinition(ParameterDefinition paramter)

Specified by:

removeParameterDefinition in interface ParameterContainerNode

getParameterInstances

public Set<ParameterInstance> getParameterInstances()

Specified by:

getParameterInstances in interface ParameterContainerNode

setParameterInstances

public void setParameterInstances(Set<ParameterInstance> parameterInstances)

addParameterInstance

public void addParameterInstance(ParameterInstance instance)

getPreviewImage

public PreviewImage getPreviewImage()

setPreviewImage

public void setPreviewImage(PreviewImage previewImage)

setDescription

public void setDescription(String description)

getDescription

public String getDescription()

Specified by:

getDescription in class AbstractReportManagerNode

createNewVariant

public Report createNewVariant(Report adjustedReport)

Creates a new variant of this report (or variant) with the changes given by adjustedReport.

This method should only be called if you mean to store the variant as it is added to the parent's list of children

Parameters:

adjustedReport -

See Also:

• createTemporaryVariant(Report)

createTemporaryVariant

public Report createTemporaryVariant()

createTemporaryVariant

public Report createTemporaryVariant(Report adjustedReport)

Do not try to convert a temporary variant into a persistent one (rather create a new one).

Parameters:

adjustedReport - the unmanaged report.

See Also:

• createNewVariant(Report)

replaceWith

public void replaceWith(Report report,
 Injector injector)

getParamInstanceByDefinitionId

public ParameterInstance<?> getParamInstanceByDefinitionId(Long id)

getParameterInstanceFor

public ParameterInstance getParameterInstanceFor(ParameterDefinition definition)

removeParameterInstance

public void removeParameterInstance(ParameterInstance instance)

getParameterDefinitionByKey

public ParameterDefinition getParameterDefinitionByKey(String name)

getParameterDefinitionsOfType

public <T extends ParameterDefinition<?>> List<T> getParameterDefinitionsOfType(Class<T> type)

usesParameter

public boolean usesParameter(String key)

isIdenticalForExecution

public boolean isIdenticalForExecution(Report report)

setUuid

@Deprecated
public void setUuid(String uuid)

Deprecated.

getUuid

@Deprecated
public String getUuid()

Deprecated.

getReportPropertyByName

public ReportProperty getReportPropertyByName(String name)

getReportProperty

public ReportProperty getReportProperty(String name)

getReportProperty

public String getReportProperty(String propertyName,
 String defaultValue)

getTemporaryVariantType

public Class<?> getTemporaryVariantType()

setTemporaryVariantType

public void setTemporaryVariantType(Class<?> temporaryVariantType)

toString

public String toString()

Overrides:

toString in class AbstractNode<AbstractReportManagerNode>