Java Doc for JRDataset.java in  » Report » jasperreports-2.0.1 » net » sf » jasperreports » engine » 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 » Report » jasperreports 2.0.1 » net.sf.jasperreports.engine 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


net.sf.jasperreports.engine.JRDataset

All known Subclasses:   net.sf.jasperreports.engine.base.JRBaseDataset,  net.sf.jasperreports.engine.fill.JRFillDataset,
JRDataset
public interface JRDataset extends JRPropertiesHolder(Code)
Interface representing a data set that can be used in a report.

A data set consists of parameters, fields, variables, groups and an optional query. When a data set gets instantiated, parameter values and a data source is passed to it.

A report has one main data set and multiple sub data sets that can be instantiated by charts and crosstabs.
author:
   Lucian Chirita (lucianc@users.sourceforge.net)
version:
   $Id: JRDataset.java 1669 2007-03-26 14:50:07Z lucianc $
See Also:   net.sf.jasperreports.engine.JRDatasetRun
See Also:   net.sf.jasperreports.engine.JRReport.getMainDataset
See Also:   net.sf.jasperreports.engine.JRReport.getDatasets



Field Summary
final public static  byteWHEN_RESOURCE_MISSING_TYPE_EMPTY
     Return empty string when a resource is missing.
final public static  byteWHEN_RESOURCE_MISSING_TYPE_ERROR
     Throw an exception when a resource is missing.
final public static  byteWHEN_RESOURCE_MISSING_TYPE_KEY
     Return the key when a resource is missing.
final public static  byteWHEN_RESOURCE_MISSING_TYPE_NULL
     Return NULL when a resource is missing.


Method Summary
public  JRField[]getFields()
     Returns the dataset's fields.
public  JRExpressiongetFilterExpression()
     Returns the dataset filter expression.

This expression is used to filter the rows of the JRDataSource data source that this dataset will iterate on.

This expression (if not null) is evaluated immediately after a new row is JRDataSource.next produced by the data source. The evaluation is performed using field and variable values corresponding to the new row.

public  JRGroup[]getGroups()
     Returns the dataset's groups.
public  StringgetName()
     Returns the dataset name.
public  JRParameter[]getParameters()
     Returns the dataset's parameters.
public  JRQuerygetQuery()
     Returns the query of the dataset.
public  StringgetResourceBundle()
     Returns the resource bundle base name.
public  StringgetScriptletClass()
     The name of the scriptlet class to be used when iterating this dataset.
public  JRSortField[]getSortFields()
     Returns the dataset's sort fields.
public  JRVariable[]getVariables()
     Returns the dataset's variables.
public  bytegetWhenResourceMissingType()
     Returns the resource missing handling type.
public  booleanisMainDataset()
     Decides whether this dataset is the main report dataset or a sub dataset.
public  voidsetWhenResourceMissingType(byte whenResourceMissingType)
     Sets the resource missing handling type.

Field Detail
WHEN_RESOURCE_MISSING_TYPE_EMPTY
final public static byte WHEN_RESOURCE_MISSING_TYPE_EMPTY(Code)
Return empty string when a resource is missing.



WHEN_RESOURCE_MISSING_TYPE_ERROR
final public static byte WHEN_RESOURCE_MISSING_TYPE_ERROR(Code)
Throw an exception when a resource is missing.



WHEN_RESOURCE_MISSING_TYPE_KEY
final public static byte WHEN_RESOURCE_MISSING_TYPE_KEY(Code)
Return the key when a resource is missing.



WHEN_RESOURCE_MISSING_TYPE_NULL
final public static byte WHEN_RESOURCE_MISSING_TYPE_NULL(Code)
Return NULL when a resource is missing.





Method Detail
getFields
public JRField[] getFields()(Code)
Returns the dataset's fields. the dataset's fields



getFilterExpression
public JRExpression getFilterExpression()(Code)
Returns the dataset filter expression.

This expression is used to filter the rows of the JRDataSource data source that this dataset will iterate on.

This expression (if not null) is evaluated immediately after a new row is JRDataSource.next produced by the data source. The evaluation is performed using field and variable values corresponding to the new row. When the result of the evaluation is Boolean.TRUE the row gets processed by the report filling engine. When the result is null or Boolean.FALSE, the current row will be skipped and the datasource will be asked for the next row.

the dataset filter expression



getGroups
public JRGroup[] getGroups()(Code)
Returns the dataset's groups. the dataset's groups



getName
public String getName()(Code)
Returns the dataset name. the name of the dataset



getParameters
public JRParameter[] getParameters()(Code)
Returns the dataset's parameters. the dataset's parameters



getQuery
public JRQuery getQuery()(Code)
Returns the query of the dataset.

The query is used by passing a connection is passed to the dataset when instantiating. the query of the dataset




getResourceBundle
public String getResourceBundle()(Code)
Returns the resource bundle base name.

The resource bundle is used when evaluating expressions. the resource bundle base name




getScriptletClass
public String getScriptletClass()(Code)
The name of the scriptlet class to be used when iterating this dataset. the scriplet class name



getSortFields
public JRSortField[] getSortFields()(Code)
Returns the dataset's sort fields. the dataset's sort fields



getVariables
public JRVariable[] getVariables()(Code)
Returns the dataset's variables. the dataset's variables



getWhenResourceMissingType
public byte getWhenResourceMissingType()(Code)
Returns the resource missing handling type. the resource missing handling type



isMainDataset
public boolean isMainDataset()(Code)
Decides whether this dataset is the main report dataset or a sub dataset. true iff this dataset is the main report dataset



setWhenResourceMissingType
public void setWhenResourceMissingType(byte whenResourceMissingType)(Code)
Sets the resource missing handling type.
Parameters:
  whenResourceMissingType - the resource missing handling type



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