Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

jbreport.core
Class QueryBoundResult  view QueryBoundResult download QueryBoundResult.java

java.lang.Object
  extended byjbreport.core.AbstractReportElement
      extended byjbreport.core.QueryBoundResult
All Implemented Interfaces:
java.lang.Cloneable, jbreport.ReportElement, Traversable, XMLAware

class QueryBoundResult
extends AbstractReportElement

This is used to get a particular cell of data from the results of the query to the datasource. It would normally be used to present information during section breaks.

Version:
$Revision: 1.1 $

Field Summary
private  java.lang.String id
          The identifier of the query result column that we will bind to
private  java.lang.String value
          The current value of the bound element
 
Fields inherited from class jbreport.core.AbstractReportElement
attrType, cdata, className, elementType, factory, name, xmlHandler
 
Fields inherited from interface jbreport.ReportElement
DEEP, SHALLOW
 
Constructor Summary
(package private) QueryBoundResult()
           
 
Method Summary
 void accept(ReportVisitor visitor, ReportVisitorState state)
          This defines the operation that the Traversable instance must perform at each node in the traversal.
 java.lang.String getString(java.lang.String property, java.lang.String defaultValue)
          Returns the string value for the requested property.
 void updateData(jbreport.data.QueryResult queryResult)
          This is called for every successful next() method call on the QueryResult contained by a group.
 void xmlInitialize(java.lang.String localName, org.xml.sax.Attributes attributes)
          This should initialize the instance with data obtained during the traversal of an xml tree.
 
Methods inherited from class jbreport.core.AbstractReportElement
assert, assertNotNull, boundParameters, breakEventNotify, clone, copy, copy, getBoundParamValue, getElement, getFactory, getList, getName, getParent, getRepository, getStylesheet, getType, inOrderIterator, inOrderTraverse, loadData, postOrderIterator, postOrderTraverse, preLoadData, preOrderIterator, preOrderTraverse, setParent, setString, xmlEnd, xmlEndChild
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

private java.lang.String id
The identifier of the query result column that we will bind to


value

private java.lang.String value
The current value of the bound element

Constructor Detail

QueryBoundResult

QueryBoundResult()
Method Detail

accept

public void accept(ReportVisitor visitor,
                   ReportVisitorState state)
            throws jbreport.ReportException
Description copied from interface: Traversable
This defines the operation that the Traversable instance must perform at each node in the traversal. It should be coded such that it calls an appropriate method on the ReportVisitor instance. Should an appropriate method not exist, one should be coded.

The accept method should not recurse into its children, it is the contract of the iterator to perform that function.

eg:- For node type Section the method on this node should be as follows.

   public void accept(ReportVisitor visitor, ReportVisitorState state) 
      throws ReportException {
      visitor.visitSection(this, state);
   }

Specified by:
accept in interface Traversable
Overrides:
accept in class AbstractReportElement

getString

public java.lang.String getString(java.lang.String property,
                                  java.lang.String defaultValue)
                           throws jbreport.ReportException
Description copied from interface: jbreport.ReportElement
Returns the string value for the requested property.

Specified by:
getString in interface jbreport.ReportElement
Overrides:
getString in class AbstractReportElement

updateData

public void updateData(jbreport.data.QueryResult queryResult)
                throws jbreport.ReportException
Description copied from class: AbstractReportElement
This is called for every successful next() method call on the QueryResult contained by a group.

Overrides:
updateData in class AbstractReportElement

xmlInitialize

public void xmlInitialize(java.lang.String localName,
                          org.xml.sax.Attributes attributes)
                   throws jbreport.ReportException
Description copied from interface: jbreport.ReportElement
This should initialize the instance with data obtained during the traversal of an xml tree. The child-parent relationship is catered for with the xmlEndChild() method.

Specified by:
xmlInitialize in interface jbreport.ReportElement
Overrides:
xmlInitialize in class AbstractReportElement