org.outerj.xreporter.report
Class ReportState

java.lang.Object
  extended byorg.outerj.xreporter.report.ReportState

public class ReportState
extends java.lang.Object

An object holding all user-modified state of a report instance.


Constructor Summary
ReportState()
           
 
Method Summary
 boolean containsAnyState()
          Returns true if any of the parameters maps contains something.
 void dump()
           
 java.util.Map getColumnsMap()
           
 java.lang.String getDataSourceId()
           
 java.util.Map getInteractionMap()
           
 java.util.Map getOrderByMap()
           
 java.util.Map getQbeMap()
           
 java.lang.String getQueryString()
          Builds a query string suitable for appending to a "/reports" resource call, containing all parameters specified in this object.
 java.lang.String getReportDefinitionId()
           
 void setColumnsKey(java.lang.String key, java.lang.String value)
           
 void setDataSourceId(java.lang.String dataSourceId)
           
 void setInteractionKey(java.lang.String key, java.lang.String value)
           
 void setOrderByKey(java.lang.String key, java.lang.String value)
           
 void setPrefixedKey(java.lang.String key, java.lang.String value)
          Will set the appropriate key for keys starting with "interact.", "orderby.", "column.", "qbe.".
 void setQbeKey(java.lang.String key, java.lang.String value)
           
 void setReportDefinitionId(java.lang.String reportDefinitionId)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportState

public ReportState()
Method Detail

setInteractionKey

public void setInteractionKey(java.lang.String key,
                              java.lang.String value)

setOrderByKey

public void setOrderByKey(java.lang.String key,
                          java.lang.String value)

setColumnsKey

public void setColumnsKey(java.lang.String key,
                          java.lang.String value)

setQbeKey

public void setQbeKey(java.lang.String key,
                      java.lang.String value)

getInteractionMap

public java.util.Map getInteractionMap()

getOrderByMap

public java.util.Map getOrderByMap()

getColumnsMap

public java.util.Map getColumnsMap()

getQbeMap

public java.util.Map getQbeMap()

getDataSourceId

public java.lang.String getDataSourceId()

setDataSourceId

public void setDataSourceId(java.lang.String dataSourceId)

getReportDefinitionId

public java.lang.String getReportDefinitionId()

setReportDefinitionId

public void setReportDefinitionId(java.lang.String reportDefinitionId)

containsAnyState

public boolean containsAnyState()
Returns true if any of the parameters maps contains something.


getQueryString

public java.lang.String getQueryString()
Builds a query string suitable for appending to a "/reports" resource call, containing all parameters specified in this object. This does not contain user and lang parameters, so you'll need to add those yourself.

The generated query string does not start with a "?" or "&" character.


setPrefixedKey

public void setPrefixedKey(java.lang.String key,
                           java.lang.String value)
Will set the appropriate key for keys starting with "interact.", "orderby.", "column.", "qbe.". If the key does not start with any of these prefixes, it will be ignored.


dump

public void dump()