Java Doc for Group.java in  » Report » datavision-1.1.0 » jimm » datavision » 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 » datavision 1.1.0 » jimm.datavision 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   jimm.datavision.Group

Group
public class Group implements Writeable(Code)
A group uses a Selectable object to define record grouping. A group may contain multiple header and footer sections.
author:
   Jim Menard, jimm@io.com


Field Summary
final public static  intSORT_ASCENDING
     Sort records by the group's selectable in ascending order (the default).
final public static  intSORT_DESCENDING
     Sort records by the group's selectable in descending order.
protected  booleanfirstValue
    
protected  SectionAreafooters
    
protected  SectionAreaheaders
    
protected  booleannewValue
    
protected  intrecordCount
    
protected  Reportreport
    
protected  Selectableselectable
    
protected  intsortOrder
    
protected  Objectvalue
    

Constructor Summary
public  Group(Report report, Selectable selectable)
     Constructor.

Method Summary
public  booleancontains(Section s)
     Returns true if the specified section is inside this group, either as a header or a footer.
public static  Groupcreate(Report report, Selectable selectable)
     Creates a new group and gives it a header section containing a selectable field and an empty footer section.
public  SectionAreafooters()
     Returns the footers.
public  voidforceFooterOutput()
     Layout engines need to call this method when a group's footer is being output not because this group has a new value but because some previous group's value changed and we want to output this group's footer.
public  intgetRecordCount()
     Returns the number of records in the group so far.
public  SelectablegetSelectable()
     Returns the selectable used by this group.
public  StringgetSelectableName()
    
public  intgetSortOrder()
     Returns the sort order (either SORT_ASCENDING or SORT_DESCENDING).
public  ObjectgetValue()
     Returns the value of this group's selectable.
public  SectionAreaheaders()
     Returns the headers.
public  booleanisFirstValue()
     Returns true when this is the first value ever seen by the group during a report run.
public  booleanisNewValue()
     Returns true when the value of the selectable has changed.
public  voidreloadSelectable(DataSource dataSource)
     Reloads reference to selectable.
public  voidreset()
     Called by a report when it starts running, this method prepares the group for use.
public  voidsetSelectable(Selectable newSelectable)
     Sets the selectable used by this group.
public  voidsetSortOrder(int newSortOrder)
     Sets the sort order.
public  voidsetValue(Report report)
     Sets the group value that is returned by getValue.
public static  StringsortOrderIntToString(int order)
    
public static  intsortOrderStringToInt(String order)
    
public  voidupdateCounter()
    
public  voidwriteXML(XMLWriter out)
     Writes this group as an XML tag.

Field Detail
SORT_ASCENDING
final public static int SORT_ASCENDING(Code)
Sort records by the group's selectable in ascending order (the default).



SORT_DESCENDING
final public static int SORT_DESCENDING(Code)
Sort records by the group's selectable in descending order.



firstValue
protected boolean firstValue(Code)



footers
protected SectionArea footers(Code)



headers
protected SectionArea headers(Code)



newValue
protected boolean newValue(Code)



recordCount
protected int recordCount(Code)



report
protected Report report(Code)



selectable
protected Selectable selectable(Code)



sortOrder
protected int sortOrder(Code)



value
protected Object value(Code)




Constructor Detail
Group
public Group(Report report, Selectable selectable)(Code)
Constructor.
Parameters:
  report - a report
Parameters:
  selectable - a selectable thingie




Method Detail
contains
public boolean contains(Section s)(Code)
Returns true if the specified section is inside this group, either as a header or a footer.
Parameters:
  s - a section true if the section is within this group



create
public static Group create(Report report, Selectable selectable)(Code)
Creates a new group and gives it a header section containing a selectable field and an empty footer section.
Parameters:
  report - a report
Parameters:
  selectable - a selectable object a new group with a header section containing a column field andan empty footer section



footers
public SectionArea footers()(Code)
Returns the footers. the footers section area



forceFooterOutput
public void forceFooterOutput()(Code)
Layout engines need to call this method when a group's footer is being output not because this group has a new value but because some previous group's value changed and we want to output this group's footer.
See Also:   jimm.datavision.layout.LayoutEngine.groupFooters



getRecordCount
public int getRecordCount()(Code)
Returns the number of records in the group so far. the number of records in the group so far



getSelectable
public Selectable getSelectable()(Code)
Returns the selectable used by this group. a selectable



getSelectableName
public String getSelectableName()(Code)



getSortOrder
public int getSortOrder()(Code)
Returns the sort order (either SORT_ASCENDING or SORT_DESCENDING). either SORT_ASCENDING or SORT_DESCENDING



getValue
public Object getValue()(Code)
Returns the value of this group's selectable. Only valid while the report is running. the value of the selectable; undefined when the reportis not running



headers
public SectionArea headers()(Code)
Returns the headers. the headers section area



isFirstValue
public boolean isFirstValue()(Code)
Returns true when this is the first value ever seen by the group during a report run. true if this is the first value ever seen



isNewValue
public boolean isNewValue()(Code)
Returns true when the value of the selectable has changed. true when the value of the selectable haschanged



reloadSelectable
public void reloadSelectable(DataSource dataSource)(Code)
Reloads reference to selectable.



reset
public void reset()(Code)
Called by a report when it starts running, this method prepares the group for use.



setSelectable
public void setSelectable(Selectable newSelectable)(Code)
Sets the selectable used by this group.
Parameters:
  newSelectable - the new selectable



setSortOrder
public void setSortOrder(int newSortOrder)(Code)
Sets the sort order.
Parameters:
  newSortOrder - either SORT_ASCENDING orSORT_DESCENDING



setValue
public void setValue(Report report)(Code)
Sets the group value that is returned by getValue. This method should only be called by the report while it is running.
Parameters:
  report - the report from which we retrieve our selectable's value



sortOrderIntToString
public static String sortOrderIntToString(int order)(Code)



sortOrderStringToInt
public static int sortOrderStringToInt(String order)(Code)



updateCounter
public void updateCounter()(Code)



writeXML
public void writeXML(XMLWriter out)(Code)
Writes this group as an XML tag. Asks each section to write itself as well.
Parameters:
  out - a writer that knows how to write XML



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.