org.tigris.scarab.reports
Class ReportDefinition

java.lang.Object
  org.tigris.scarab.reports.ReportDefinition

All Implemented Interfaces:

java.io.Serializable

public class ReportDefinition

extends java.lang.Object

implements java.io.Serializable

This class is the container for the information used to generate a report. It is the outermost tag of the XML representation defined by report.dtd (please see this file for an example).

Version:

$Id: ReportDefinition.java 10132 2006-06-02 09:06:38Z dabbous $

Author:

John McNally

See Also:

report.dtd, Serialized Form

Constructor Summary

ReportDefinition()

Method Summary

void	addModuleIssueType(ModuleIssueType newModuleIssueType) Add a ModuleIssueTypes value.
void	addReportAxis(ReportAxis newReportAxis) Add a ReportAxis value.
boolean	allowMoreHeadings(ReportAxis axis) Determines whether another heading level is allowed for the given axis.
int	availableNumberOfHeadings(ReportAxis axis) The number of headings that could still be added to the given axis without exceeding the configured maximum.
java.lang.String	displayAttribute(java.lang.Object obj)
java.lang.String	displayHeading(ReportHeading heading)
java.lang.String	displayOption(ReportOptionAttribute roa)
java.lang.String	displayUser(ReportUserAttribute rua)
ReportAxis	getAxis(int axisIndex) Gets the specified axis, if it was null prior to this method request a new ReportAxis is returned for the given index
ReportDate	getDefaultDate() Get the ReportDate value used if no axis is time.
java.lang.String	getDescription() Get the Description value.
java.lang.String	getFormat() Get the format value.
java.util.List	getModuleIssueTypes() Get the ModuleIssueTypes value.
java.lang.String	getName() Get the Name value.
java.util.List	getReportAxisList() Get the ReportAxisList value.
int	maximumHeadings() The configured maximum from Scarab.properties: scarab.report.max.criteria
boolean	reportQueryIsExpensive() Determines whether the report is going to be expensive.
java.util.List	retrieveAllReportOptionAttributes()
java.util.List	retrieveAllReportUserAttributes()
void	setDefaultDate(ReportDate newDefaultDate) Set the ReportDate value used if no axis is time.
void	setDescription(java.lang.String newDescription) Set the Description value.
void	setFormat(java.lang.String format) Set the format value.
void	setModuleIssueTypes(java.util.List newModuleIssueTypes) Set the ModuleIssueTypes value.
void	setName(java.lang.String newName) Set the Name value.
void	setReportAxisList(java.util.List newReportAxisList) Set the ReportAxisList value.
int	totalAvailableNumberOfHeadings() The number of headings that could still be added to the report without exceeding the configured maximum.
java.lang.String	toXmlString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportDefinition

public ReportDefinition()

Method Detail

getName

public java.lang.String getName()

Get the Name value.

Returns:

the Name value.

setName

public void setName(java.lang.String newName)

Set the Name value.

Parameters:

newName - The new Name value.

getDescription

public java.lang.String getDescription()

Get the Description value.

Returns:

the Description value.

setDescription

public void setDescription(java.lang.String newDescription)

Set the Description value.

Parameters:

newDescription - The new Description value.

getFormat

public java.lang.String getFormat()

Get the format value.

Returns:

The format value.

setFormat

public void setFormat(java.lang.String format)

Set the format value.

Parameters:

format - The new format value.

getModuleIssueTypes

public java.util.List getModuleIssueTypes()

Get the ModuleIssueTypes value.

Returns:

the ModuleIssueTypes value.

setModuleIssueTypes

public void setModuleIssueTypes(java.util.List newModuleIssueTypes)

Set the ModuleIssueTypes value.

Parameters:

newModuleIssueTypes - The new ModuleIssueTypes value.

addModuleIssueType

public void addModuleIssueType(ModuleIssueType newModuleIssueType)

Add a ModuleIssueTypes value.

Parameters:

newModuleIssueType - The new ModuleIssueTypes value.

getReportAxisList

public java.util.List getReportAxisList()

Get the ReportAxisList value.

Returns:

the ReportAxisList value.

setReportAxisList

public void setReportAxisList(java.util.List newReportAxisList)

Set the ReportAxisList value.

Parameters:

newReportAxisList - The new ReportAxisList value.

addReportAxis

public void addReportAxis(ReportAxis newReportAxis)

Add a ReportAxis value.

Parameters:

newReportAxis - The new ReportAxis value.

getDefaultDate

public ReportDate getDefaultDate()

Get the ReportDate value used if no axis is time.

Returns:

the ReportDate value.

setDefaultDate

public void setDefaultDate(ReportDate newDefaultDate)

Set the ReportDate value used if no axis is time.

Parameters:

newDefaultDate - The new ReportDate value.

getAxis

public ReportAxis getAxis(int axisIndex)

Gets the specified axis, if it was null prior to this method request a new ReportAxis is returned for the given index

Parameters:

axisIndex - an int value

Returns:

a ReportHeading value

retrieveAllReportOptionAttributes

public java.util.List retrieveAllReportOptionAttributes()

retrieveAllReportUserAttributes

public java.util.List retrieveAllReportUserAttributes()

toXmlString

public java.lang.String toXmlString()

displayAttribute

public java.lang.String displayAttribute(java.lang.Object obj)

displayOption

public java.lang.String displayOption(ReportOptionAttribute roa)

displayUser

public java.lang.String displayUser(ReportUserAttribute rua)

displayHeading

public java.lang.String displayHeading(ReportHeading heading)

maximumHeadings

public int maximumHeadings()

The configured maximum from Scarab.properties: scarab.report.max.criteria

allowMoreHeadings

public boolean allowMoreHeadings(ReportAxis axis)

Determines whether another heading level is allowed for the given axis.

Parameters:

axis - a non-null ReportAxis value

reportQueryIsExpensive

public boolean reportQueryIsExpensive()

Determines whether the report is going to be expensive. This is based on a comparison of the number of heading levels on both axes with the configured maximum in Scarab.properties.

totalAvailableNumberOfHeadings

public int totalAvailableNumberOfHeadings()

The number of headings that could still be added to the report without exceeding the configured maximum.

availableNumberOfHeadings

public int availableNumberOfHeadings(ReportAxis axis)

The number of headings that could still be added to the given axis without exceeding the configured maximum.

Parameters:

axis - a non-null ReportAxis value