org.pentaho.reporting.engine.classic.core.states

Class ReportStateKey

java.lang.Object

org.pentaho.reporting.engine.classic.core.states.ReportStateKey

public class ReportStateKey
extends Object

The process-state key is a unique functional identifier of report-states. However, it does not get updated with changes to the report-state, so it always represents the process-state at the beginning of the report-state processing. This key can be used to see whether there was some progress and to uniquely identify report-states, but for everything else, this class is not suitable.

Author:

Thomas Morgner

Constructor Summary

Constructors

Constructor and Description
ReportStateKey()
ReportStateKey(ReportStateKey parent, int cursor, int stateCode, int groupLevel, int subreport, int sequenceCounter, boolean restoreState, boolean inlineSubReportState)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getCursor()
int	getGroupLevel()
ReportStateKey	getParent()
int	getSequenceCounter() This is just a debugging help to identify repeated runs of the same report sequence.
int	getStateCode()
int	getSubreport()
int	hashCode()
boolean	isInlineSubReportState()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReportStateKey

public ReportStateKey()

ReportStateKey

public ReportStateKey(ReportStateKey parent,
                      int cursor,
                      int stateCode,
                      int groupLevel,
                      int subreport,
                      int sequenceCounter,
                      boolean restoreState,
                      boolean inlineSubReportState)

Method Detail

getSequenceCounter

public int getSequenceCounter()

This is just a debugging help to identify repeated runs of the same report sequence. It is not used to compare equality of these keys.

Returns:

getParent

public ReportStateKey getParent()

getCursor

public int getCursor()

getStateCode

public int getStateCode()

getGroupLevel

public int getGroupLevel()

getSubreport

public int getSubreport()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isInlineSubReportState

public boolean isInlineSubReportState()

toString

public String toString()

Overrides:

toString in class Object