Java Doc for ReportDefinition.java in  » Issue-Tracking » scarab-0.21 » org » tigris » scarab » reports » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Issue Tracking » scarab 0.21 » org.tigris.scarab.reports 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

ReportDefinition
public class ReportDefinition implements java.io.Serializable(Code)
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).
author:
   John McNally
version:
   $Id: ReportDefinition.java 10132 2006-06-02 09:06:38Z dabbous $
See Also:    report.dtd




Method Summary
public  voidaddModuleIssueType(ModuleIssueType newModuleIssueType)
     Add a ModuleIssueTypes value.
public  voidaddReportAxis(ReportAxis newReportAxis)
     Add a ReportAxis value.
public  booleanallowMoreHeadings(ReportAxis axis)
     Determines whether another heading level is allowed for the given axis.
public  intavailableNumberOfHeadings(ReportAxis axis)
     The number of headings that could still be added to the given axis without exceeding the configured maximum.
public  StringdisplayAttribute(Object obj)
    
public  StringdisplayHeading(ReportHeading heading)
    
public  StringdisplayOption(ReportOptionAttribute roa)
    
public  StringdisplayUser(ReportUserAttribute rua)
    
public  ReportAxisgetAxis(int axisIndex)
    
public  ReportDategetDefaultDate()
     Get the ReportDate value used if no axis is time.
public  StringgetDescription()
     Get the Description value.
public  StringgetFormat()
     Get the format value.
public  ListgetModuleIssueTypes()
     Get the ModuleIssueTypes value.
public  StringgetName()
     Get the Name value.
public  ListgetReportAxisList()
     Get the ReportAxisList value.
public  intmaximumHeadings()
    
public  booleanreportQueryIsExpensive()
     Determines whether the report is going to be expensive.
public  ListretrieveAllReportOptionAttributes()
    
public  ListretrieveAllReportUserAttributes()
    
public  voidsetDefaultDate(ReportDate newDefaultDate)
     Set the ReportDate value used if no axis is time.
public  voidsetDescription(String newDescription)
     Set the Description value.
public  voidsetFormat(String format)
     Set the format value.
public  voidsetModuleIssueTypes(List newModuleIssueTypes)
     Set the ModuleIssueTypes value.
public  voidsetName(String newName)
     Set the Name value.
public  voidsetReportAxisList(List newReportAxisList)
     Set the ReportAxisList value.
public  StringtoXmlString()
    
public  inttotalAvailableNumberOfHeadings()
     The number of headings that could still be added to the report without exceeding the configured maximum.



Method Detail
addModuleIssueType
public void addModuleIssueType(ModuleIssueType newModuleIssueType)(Code)
Add a ModuleIssueTypes value.
Parameters:
  newModuleIssueType - The new ModuleIssueTypes value.



addReportAxis
public void addReportAxis(ReportAxis newReportAxis)(Code)
Add a ReportAxis value.
Parameters:
  newReportAxis - The new ReportAxis value.



allowMoreHeadings
public boolean allowMoreHeadings(ReportAxis axis)(Code)
Determines whether another heading level is allowed for the given axis.
Parameters:
  axis - a non-null ReportAxis value



availableNumberOfHeadings
public int availableNumberOfHeadings(ReportAxis axis)(Code)
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



displayAttribute
public String displayAttribute(Object obj)(Code)



displayHeading
public String displayHeading(ReportHeading heading)(Code)



displayOption
public String displayOption(ReportOptionAttribute roa)(Code)



displayUser
public String displayUser(ReportUserAttribute rua)(Code)



getAxis
public ReportAxis getAxis(int axisIndex)(Code)
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 a ReportHeading value



getDefaultDate
public ReportDate getDefaultDate()(Code)
Get the ReportDate value used if no axis is time. the ReportDate value.



getDescription
public String getDescription()(Code)
Get the Description value. the Description value.



getFormat
public String getFormat()(Code)
Get the format value. The format value.



getModuleIssueTypes
public List getModuleIssueTypes()(Code)
Get the ModuleIssueTypes value. the ModuleIssueTypes value.



getName
public String getName()(Code)
Get the Name value. the Name value.



getReportAxisList
public List getReportAxisList()(Code)
Get the ReportAxisList value. the ReportAxisList value.



maximumHeadings
public int maximumHeadings()(Code)
The configured maximum from Scarab.properties: scarab.report.max.criteria



reportQueryIsExpensive
public boolean reportQueryIsExpensive()(Code)
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.



retrieveAllReportOptionAttributes
public List retrieveAllReportOptionAttributes()(Code)



retrieveAllReportUserAttributes
public List retrieveAllReportUserAttributes()(Code)



setDefaultDate
public void setDefaultDate(ReportDate newDefaultDate)(Code)
Set the ReportDate value used if no axis is time.
Parameters:
  newDefaultDate - The new ReportDate value.



setDescription
public void setDescription(String newDescription)(Code)
Set the Description value.
Parameters:
  newDescription - The new Description value.



setFormat
public void setFormat(String format)(Code)
Set the format value.
Parameters:
  format - The new format value.



setModuleIssueTypes
public void setModuleIssueTypes(List newModuleIssueTypes)(Code)
Set the ModuleIssueTypes value.
Parameters:
  newModuleIssueTypes - The new ModuleIssueTypes value.



setName
public void setName(String newName)(Code)
Set the Name value.
Parameters:
  newName - The new Name value.



setReportAxisList
public void setReportAxisList(List newReportAxisList)(Code)
Set the ReportAxisList value.
Parameters:
  newReportAxisList - The new ReportAxisList value.



toXmlString
public String toXmlString()(Code)



totalAvailableNumberOfHeadings
public int totalAvailableNumberOfHeadings()(Code)
The number of headings that could still be added to the report without exceeding the configured maximum.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.