ca.sqlpower.wabit.report
Class CellSetRenderer

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

All Implemented Interfaces:

ReportContentRenderer, WabitObjectReportRenderer, WabitObject

public class CellSetRenderer
extends AbstractWabitObject
implements WabitObjectReportRenderer

Renders a CellSet from a MDX query on a report layout.

Nested Class Summary

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

ReportContentRenderer.BackgroundColours

Constructor Summary

CellSetRenderer(CellSetRenderer cellSetRenderer)

CellSetRenderer(OlapQuery olapQuery)

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.
java.awt.Color	getBackgroundColour()
HorizontalAlignment	getBodyAlignment()
java.awt.Font	getBodyFont()
java.text.DecimalFormat	getBodyFormat()
org.olap4j.CellSet	getCellSet()
java.util.List<? extends WabitObject>	getChildren() Returns an unmodifiable list of the children in this WabitObject.
OlapQuery	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.lang.String	getErrorMessage()
java.awt.Font	getHeaderFont()
OlapQuery	getModifiedOlapQuery()
ContentBox	getParent() Returns the parent of this WabitObject.
org.olap4j.metadata.Member	getSelectedMember()
void	init()
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	renderReportContent(java.awt.Graphics2D g, ContentBox contentBox, double scaleFactor, int pageIndex, boolean printing) This method renders the report content in the CellSetRenderer
void	resetToFirstPage() Tells this content renderer that the next call to #renderReportContent(Graphics2D, ContentBox, double) should produce the first page of output again.
void	setBodyAlignment(HorizontalAlignment bodyAlignment)
void	setBodyFont(java.awt.Font bodyFont)
void	setBodyFormat(java.text.DecimalFormat bodyFormat)
void	setHeaderFont(java.awt.Font headerFont)
void	setMemberSelectedAtPoint(java.awt.geom.Point2D p) This method will look for a member located at the given point.
void	setModifiedOlapQuery(OlapQuery modifiedOlapQuery)
void	setSelectedMember(org.olap4j.metadata.Member selectedMember)
void	toggleSelectedMember() If the selected member is not null it will be expanded or collapsed depending on the current state of the member.

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, setParent, 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, setParent, setUUID

Constructor Detail

CellSetRenderer

public CellSetRenderer(CellSetRenderer cellSetRenderer)

CellSetRenderer

public CellSetRenderer(OlapQuery olapQuery)

Method Detail

init

public void init()

getContent

public OlapQuery 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.

getBackgroundColour

public java.awt.Color getBackgroundColour()

Specified by:

getBackgroundColour in interface ReportContentRenderer

renderReportContent

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

This method renders the report content in the CellSetRenderer

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.

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

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

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.

setHeaderFont

public void setHeaderFont(java.awt.Font headerFont)

getHeaderFont

public java.awt.Font getHeaderFont()

setBodyFont

public void setBodyFont(java.awt.Font bodyFont)

getBodyFont

public java.awt.Font getBodyFont()

setBodyAlignment

public void setBodyAlignment(HorizontalAlignment bodyAlignment)

setBodyFormat

public void setBodyFormat(java.text.DecimalFormat bodyFormat)

setSelectedMember

public void setSelectedMember(org.olap4j.metadata.Member selectedMember)

getSelectedMember

public org.olap4j.metadata.Member getSelectedMember()

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.

getCellSet

public org.olap4j.CellSet getCellSet()

getBodyAlignment

public HorizontalAlignment getBodyAlignment()

getBodyFormat

public java.text.DecimalFormat getBodyFormat()

getModifiedOlapQuery

public OlapQuery getModifiedOlapQuery()

setModifiedOlapQuery

public void setModifiedOlapQuery(OlapQuery modifiedOlapQuery)

getErrorMessage

public java.lang.String getErrorMessage()

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

setMemberSelectedAtPoint

public void setMemberSelectedAtPoint(java.awt.geom.Point2D p)

This method will look for a member located at the given point. If a member is found it will be defined to be the selected member. If no member exists at the given point the selected member will be null.

Parameters:

p - Used to locate the member to be defined as selected. Cannot be null. The origin of this point is the top left point of the parent content box.

toggleSelectedMember

public void toggleSelectedMember()

If the selected member is not null it will be expanded or collapsed depending on the current state of the member. If the selected member is null this is a no-op.

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)