|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.engine.classic.core.util.ReportProperties
public class ReportProperties
The report properties is a hashtable with string keys. ReportProperties are bound to a report as a general purpose storage. ReportProperties bound to a JFreeReport object are visible to all generated report-state chains. A ReportState will inherit all ReportProperties bound to the JFreeReport-object when the ReportState.StartState object is created. Properties bound to the report definition after the report state is created are not visible to the ReportState and its children.
ReportProperties bound to a ReportState are not visible to the report definition (the JFreeReport object), but are visible to all ReportStates of that ReportState-chain. So when you add a property at the end of a report run to a ReportState, the value of this property will be visible to all ReportStates when the report is restarted at a certain point. ReportProperties can be seen as a stateless shared report internal storage area. All functions have access to the properties by using the ReportState.getProperty() and ReportState.setProperty() functions. For a list of defined default properties, have a look at theMasterReport
class.
Constructor Summary | |
---|---|
ReportProperties()
Deprecated. Default constructor. |
|
ReportProperties(ReportProperties props)
Deprecated. Copy constructor. |
Method Summary | |
---|---|
void |
clear()
Deprecated. Removes all properties stored in this collection. |
Object |
clone()
Deprecated. Clones the properties. |
boolean |
containsKey(String key)
Deprecated. Checks whether the given key is stored in this collection of ReportProperties. |
boolean |
containsMarkedProperties()
Deprecated. Returns true, if there is at least one marked property. |
Object |
get(String key)
Deprecated. Retrieves the value stored for a key in this properties collection. |
Object |
get(String key,
Object defaultValue)
Deprecated. Retrieves the value stored for a key in this properties collection, and returning the default value if the key was not stored in this properties collection. |
ReportProperties |
getMasterProperties()
Deprecated. Returns the fall-back property-collection. |
String[] |
keyArray()
Deprecated. Returns all defined keys as string-array. |
Iterator |
keys()
Deprecated. Returns all property keys as enumeration. |
void |
put(String key,
Object value)
Deprecated. Adds a property to this properties collection. |
void |
setMasterProperties(ReportProperties masterProperties)
Deprecated. Defines the fall-back property-collection. |
int |
size()
Deprecated. Returns the number of entries in this collection. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReportProperties(ReportProperties props)
props
- an existing ReportProperties instance.public ReportProperties()
Method Detail |
---|
public void put(String key, Object value)
key
- the property key.value
- the property value.public Object get(String key)
key
- the property key.
null
if the key does not exist in this collection.public Object get(String key, Object defaultValue)
key
- the property key.defaultValue
- the default value to be returned when the key is not stored in this properties collection.
public Iterator keys()
public void clear()
public boolean containsKey(String key)
key
- the property key.
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
- this should never happen.public boolean containsMarkedProperties()
public ReportProperties getMasterProperties()
public void setMasterProperties(ReportProperties masterProperties)
masterProperties
- the fall-back collection.public String[] keyArray()
public int size()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |