ca.sqlpower.wabit.report
Class ResultSetRenderer

java.lang.Object
  ca.sqlpower.wabit.AbstractWabitObject
      ca.sqlpower.wabit.report.ResultSetRenderer

All Implemented Interfaces:

ReportContentRenderer, WabitObjectReportRenderer, WabitObject

public class ResultSetRenderer
extends AbstractWabitObject
implements WabitObjectReportRenderer

Renders a JDBC result set using configurable absolute column widths.

Nested Class Summary

static class

ResultSetRenderer.BorderStyles These border styles gives a border to the result set.

Nested classes/interfaces inherited from interface ca.sqlpower.wabit.report.ReportContentRenderer

ReportContentRenderer.BackgroundColours

Field Summary

static int	BORDER_INDENT This is the number of pixels each cell will be indented by if there is a border to the left of the cell.
protected static java.lang.String	QUERY Notes a change to the query has occurred that would require a refresh to the renderer

Constructor Summary

ResultSetRenderer(QueryCache query)

ResultSetRenderer(QueryCache query, java.util.List<ColumnInfo> columnInfoList)

ResultSetRenderer(ResultSetRenderer resultSetRenderer)
Copy constructor

Method Summary

protected void	addChildImpl(WabitObject child, int index) This is the object specific implementation of #addChild(WabitObject).
boolean	allowsChildren() Returns true if this object may contain children.
int	childPositionOffset(java.lang.Class<? extends WabitObject> childType) Returns the position in the list that would be returned by getChildren() that the first object of type childClass is, or where it would be if there were any children of that type.
CleanupExceptions	cleanup() Default cleanup method that does nothing.
void	clearResultSetLayout() Call this method if something changes in the result set that causes the need to redefine the layout of the result set.
boolean	defineColumnBeingDragged(double mouseXPos) This method will look for a column edge that is near the given x location.
java.awt.Color	getBackgroundColour()
java.awt.Font	getBodyFont()
ResultSetRenderer.BorderStyles	getBorderType()
java.util.List<? extends WabitObject>	getChildren() Returns an unmodifiable list of the children in this WabitObject.
java.util.List<ColumnInfo>	getColumnInfoList()
QueryCache	getContent() Returns the WabitObject that this is rendering
java.util.List<WabitObject>	getDependencies() Returns a list of all WabitObjects that this Wabit object is dependent on.
java.awt.Font	getHeaderFont()
java.lang.String	getNullString()
ContentBox	getParent() Returns the parent of this WabitObject.
boolean	isPrintingGrandTotals()
boolean	moveColumnBeingDragged(double moveDelta) This will move the edge of the column defined to be dragged by the delta.
void	refresh() Refreshes the data being rendered by this ReportContentRenderer so that it has the most recent data.
protected boolean	removeChildImpl(WabitObject child) This is the object specific implementation of removeChild.
void	removeDependency(WabitObject dependency) Removes the given object as a dependency of this object.
boolean	renderFailure(java.awt.Graphics2D g, ContentBox contentBox, double scaleFactor, int pageIndex)
boolean	renderReportContent(java.awt.Graphics2D g, ContentBox contentBox, double scaleFactor, int pageIndex, boolean printing) Renders as much report content as will fit within the bounds of the given content box.
boolean	renderSuccess(java.awt.Graphics2D g, ContentBox contentBox, double scaleFactor, int pageIndex, boolean printing)
java.lang.String	replaceNull(java.lang.String string) This will replace null values with the designated null string.
void	resetToFirstPage() Tells this content renderer that the next call to #renderReportContent(Graphics2D, ContentBox, double) should produce the first page of output again.
void	setBackgroundColour(java.awt.Color backgroundColour)
void	setBodyFont(java.awt.Font bodyFont)
void	setBorderType(ResultSetRenderer.BorderStyles borderType)
void	setColBeingDragged(ColumnInfo colBeingDragged)
void	setHeaderFont(java.awt.Font headerFont)
void	setNullString(java.lang.String nullString)
void	setParent(WabitObject parent) Sets the parent of this object to the given object.
void	setPrintingGrandTotals(boolean isPrintingGrandTotals)

Methods inherited from class ca.sqlpower.wabit.AbstractWabitObject

addChild, addWabitListener, begin, beginTransaction, commit, commitTransaction, equals, fireChildAdded, fireChildRemoved, firePropertyChange, firePropertyChange, firePropertyChange, fireTransactionEnded, fireTransactionRollback, fireTransactionStarted, generateNewUUID, getChildren, getName, getSession, getUUID, isForegroundThread, removeChild, removeWabitListener, rollback, rollbackTransaction, runInBackground, runInForeground, setName, setUUID, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.sqlpower.wabit.WabitObject

addChild, addWabitListener, begin, commit, generateNewUUID, getChildren, getName, getUUID, removeChild, removeWabitListener, rollback, setName, setUUID

Field Detail

BORDER_INDENT

public static final int BORDER_INDENT

This is the number of pixels each cell will be indented by if there is a border to the left of the cell. If no indent is given then the left part of the text will be overwritten by the border itself.

See Also:

Constant Field Values

QUERY

protected static final java.lang.String QUERY

Notes a change to the query has occurred that would require a refresh to the renderer

See Also:

Constant Field Values

Constructor Detail

ResultSetRenderer

public ResultSetRenderer(@Nonnull
                         QueryCache query)

ResultSetRenderer

public ResultSetRenderer(@Nonnull
                         QueryCache query,
                         @Nonnull
                         java.util.List<ColumnInfo> columnInfoList)

ResultSetRenderer

public ResultSetRenderer(ResultSetRenderer resultSetRenderer)

Copy constructor

Method Detail

getContent

public QueryCache getContent()

Description copied from interface: WabitObjectReportRenderer

Returns the WabitObject that this is rendering

Specified by:

getContent in interface WabitObjectReportRenderer

cleanup

public CleanupExceptions cleanup()

Description copied from class: AbstractWabitObject

Default cleanup method that does nothing. Override and implement this method if cleanup is necessary.

Specified by:

cleanup in interface WabitObject

Overrides:

cleanup in class AbstractWabitObject

Returns:

A collection of exceptions and errors that occurred during cleanup if any occurred.

resetToFirstPage

public void resetToFirstPage()

Description copied from interface: ReportContentRenderer

Tells this content renderer that the next call to #renderReportContent(Graphics2D, ContentBox, double) should produce the first page of output again.

Specified by:

resetToFirstPage in interface ReportContentRenderer

renderReportContent

public boolean renderReportContent(java.awt.Graphics2D g,
                                   ContentBox contentBox,
                                   double scaleFactor,
                                   int pageIndex,
                                   boolean printing)

Description copied from interface: ReportContentRenderer

Renders as much report content as will fit within the bounds of the given content box.

Report content renderers can be implemented in two different ways:

• Label-like renderers attempt to show all their content every time they are called, and never ask for another page. These renderers don't necessarily render exactly the same content on every page--a footer label with a page number variable is a good example.
• Resultset-like renderers that show as much content as possible each time they are called, and keep track of what to start rendering on the next call. These types of renderers ask for more pages until they have nothing left to render. If called again, they simply do not draw anything.

  Specified by:

  renderReportContent in interface ReportContentRenderer

  Parameters:

  g - The graphics to render into. The origin (top left corner or (0,0)) of this graphics is translated to the top-left corner of the content box.

  contentBox - The box that determines the size and shape that the rendered data must fit within. You can ignore the X and Y coordinates of the box because the given graphics object's origin is already set to this box's origin.

  scaleFactor - The amount of scaling currently in effect. The nominal size of a unit when displayed via the given graphics is scaleFactor/72 inches.

  pageIndex - The zero-based page number for which the corresponding report content will be rendered.

  printing - This tells the renderer if the report is being printed. If set to true the full report will be built, otherwise a cached result will be used. Set this to true if the report is being printed.

  Returns:

  True if this renderer has more data to render, and would like to be called upon again. Returning true will typically cause the report to grow by another page. The final page of the report is the first one where all content renderers involved return false.

renderFailure

public boolean renderFailure(java.awt.Graphics2D g,
                             ContentBox contentBox,
                             double scaleFactor,
                             int pageIndex)

renderSuccess

public boolean renderSuccess(java.awt.Graphics2D g,
                             ContentBox contentBox,
                             double scaleFactor,
                             int pageIndex,
                             boolean printing)

clearResultSetLayout

public void clearResultSetLayout()

Call this method if something changes in the result set that causes the need to redefine the layout of the result set.

replaceNull

public java.lang.String replaceNull(java.lang.String string)

This will replace null values with the designated null string.

allowsChildren

public boolean allowsChildren()

Description copied from interface: WabitObject

Returns true if this object may contain children. Not all types of WabitObjects can be a child to any WabitObject.

Specified by:

allowsChildren in interface WabitObject

See Also:

WabitObject.childPositionOffset(Class)

childPositionOffset

public int childPositionOffset(java.lang.Class<? extends WabitObject> childType)

Description copied from interface: WabitObject

Returns the position in the list that would be returned by getChildren() that the first object of type childClass is, or where it would be if there were any children of that type.

Specified by:

childPositionOffset in interface WabitObject

getChildren

public java.util.List<? extends WabitObject> getChildren()

Description copied from interface: WabitObject

Returns an unmodifiable list of the children in this WabitObject. If there are no children in this WabitObject an empty list should be returned.

Specified by:

getChildren in interface WabitObject

getHeaderFont

public java.awt.Font getHeaderFont()

setHeaderFont

public void setHeaderFont(java.awt.Font headerFont)

getBodyFont

public java.awt.Font getBodyFont()

setBodyFont

public void setBodyFont(java.awt.Font bodyFont)

getNullString

public java.lang.String getNullString()

setNullString

public void setNullString(java.lang.String nullString)

getParent

public ContentBox getParent()

Description copied from interface: WabitObject

Returns the parent of this WabitObject. This will be null when the object is first created until it is added as a child to another object. If this object is never added as a child to another object this will remain null and the object may be treated as the root node of a WabitObject tree.

Specified by:

getParent in interface WabitObject

Overrides:

getParent in class AbstractWabitObject

Returns:

The parent of this object.

setBackgroundColour

public void setBackgroundColour(java.awt.Color backgroundColour)

getBackgroundColour

public java.awt.Color getBackgroundColour()

Specified by:

getBackgroundColour in interface ReportContentRenderer

getBorderType

public ResultSetRenderer.BorderStyles getBorderType()

setBorderType

public void setBorderType(ResultSetRenderer.BorderStyles borderType)

getColumnInfoList

public java.util.List<ColumnInfo> getColumnInfoList()

defineColumnBeingDragged

public boolean defineColumnBeingDragged(double mouseXPos)

This method will look for a column edge that is near the given x location. If the edge of a column is close to this value it will be defined as the column edge to be dragged. This is to support the operation of defining column widths by clicking and dragging.

Parameters:

mouseXPos - The distance from the left side of the parent content box to look for an edge of a column. This cannot be null.

Returns:

True if a column is now able to be dragged, false otherwise.

moveColumnBeingDragged

public boolean moveColumnBeingDragged(double moveDelta)

This will move the edge of the column defined to be dragged by the delta. To shrink the column give a negative value as the delta. If no column is being dragged this will do nothing.

Parameters:

moveDelta - The amount to resize the column width. Cannot be null.

Returns:

True if a column was resized. False otherwise.

getDependencies

public java.util.List<WabitObject> getDependencies()

Description copied from interface: WabitObject

Returns a list of all WabitObjects that this Wabit object is dependent on. Children of a WabitObject are not dependencies and will not be returned in this list. If there are no objects this Wabit object is dependent on an empty list should be returned. These are only the immediate dependencies of this object. If you want to find the dependencies of this object's dependencies as well it may be useful to look at WorkspaceGraphModel to make a full graph of all of the dependencies.

Specified by:

getDependencies in interface WabitObject

removeDependency

public void removeDependency(WabitObject dependency)

Description copied from interface: WabitObject

Removes the given object as a dependency of this object. For this object to no longer be dependent on the given dependency all of its children must also not be dependent on the given dependency when this method returns. This may remove this object from its parent if necessary.

Specified by:

removeDependency in interface WabitObject

setParent

public void setParent(WabitObject parent)

Description copied from interface: WabitObject

Sets the parent of this object to the given object. This should only be done when this object is being added as a child to another object.

Specified by:

setParent in interface WabitObject

Overrides:

setParent in class AbstractWabitObject

Parameters:

parent - The new parent of this object.

setColBeingDragged

public void setColBeingDragged(ColumnInfo colBeingDragged)

setPrintingGrandTotals

public void setPrintingGrandTotals(boolean isPrintingGrandTotals)

isPrintingGrandTotals

public boolean isPrintingGrandTotals()

refresh

public void refresh()

Description copied from interface: ReportContentRenderer

Refreshes the data being rendered by this ReportContentRenderer so that it has the most recent data. If the data this renderer renders is static, then it doesn't need to do anything (no-op).

Specified by:

refresh in interface ReportContentRenderer

removeChildImpl

protected boolean removeChildImpl(WabitObject child)

Description copied from class: AbstractWabitObject

This is the object specific implementation of removeChild. There are checks in the removeChild method to ensure the child being removed has no dependencies and is a child of this object.

Specified by:

removeChildImpl in class AbstractWabitObject

See Also:

AbstractWabitObject.removeChild(WabitObject)

addChildImpl

protected void addChildImpl(WabitObject child,
                            int index)

Description copied from class: AbstractWabitObject

This is the object specific implementation of #addChild(WabitObject). There are checks in the #addChild(WabitObject) method to ensure that the object given here is a valid child type of this object.

This method should be overwritten if children are allowed.

Overrides:

addChildImpl in class AbstractWabitObject

Parameters:

child - The child to add to this object.

index - The index to add the child at.