com.reportmill.datasource
Class RMQuery

java.lang.Object
  com.reportmill.base.RMObject
      com.reportmill.datasource.RMQuery

All Implemented Interfaces:

com.reportmill.base.RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

public class RMQuery
extends com.reportmill.base.RMObject
implements java.beans.PropertyChangeListener

An object to fetch a dataset from a data source entity with a set condition and parameters.

Constructor Summary

RMQuery()
Creates a new query.

Method Summary

void	addParameter(RMProperty aParameter) Adds a parameter.
RMQuery	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML Unarchival.
RMCondition	getCondition() Returns the condition.
RMDataSource	getDataSource() Returns the data source.
RMEntity	getEntity() Returns the data source entity.
java.lang.String	getFilter() Returns the filter string.
java.util.List<RMRow>	getFilteredRows() Returns the list of filtered rows.
java.lang.String	getName() Returns the query name.
RMProperty	getParameter(int anIndex) Return the individual parameter.
RMProperty	getParameter(java.lang.String aName) Returns the named parameter.
int	getParameterCount() Return the number of parameters.
java.util.List<RMProperty>	getParameters() Returns the list of parameters.
java.util.Map	getParameterValues() Returns the map of parameter values.
java.util.List<RMRow>	getRows() Returns a sample dataset of objects associated with the data source.
void	propertyChange(java.beans.PropertyChangeEvent anEvent) Catches changes to condition and properties.
void	refresh() Reloads rows.
RMProperty	removeParameter(int anIndex) Removes a parameter at given index.
int	removeParameter(RMProperty aParameter) Removes a given parameter from parameters list.
void	setCondition(RMCondition aCondition) Sets the condition.
void	setDataSource(RMDataSource aDataSource) Sets the data source.
void	setEntity(RMEntity anEntity) Sets the data source entity.
void	setFilter(java.lang.String aString) Sets the filter string.
void	setName(java.lang.String aName) Sets the query name.
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML Archival.

Methods inherited from class com.reportmill.base.RMObject

addListener, addPropertyChangeListener, animUpdate, clone, firePropertyChange, firePropertyChange, getListener, getListenerCount, getListeners, isFirePropertyChangeEnabled, isUndoing, removeListener, removePropertyChangeListener, setFirePropertyChangeEnabled, setUndoing, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RMQuery

public RMQuery()

Creates a new query.

Method Detail

getName

public java.lang.String getName()

Returns the query name.

setName

public void setName(java.lang.String aName)

Sets the query name.

getDataSource

public RMDataSource getDataSource()

Returns the data source.

setDataSource

public void setDataSource(RMDataSource aDataSource)

Sets the data source.

getEntity

public RMEntity getEntity()

Returns the data source entity.

setEntity

public void setEntity(RMEntity anEntity)

Sets the data source entity.

getCondition

public RMCondition getCondition()

Returns the condition.

setCondition

public void setCondition(RMCondition aCondition)

Sets the condition.

getParameterCount

public int getParameterCount()

Return the number of parameters.

getParameter

public RMProperty getParameter(int anIndex)

Return the individual parameter.

getParameters

public java.util.List<RMProperty> getParameters()

Returns the list of parameters.

addParameter

public void addParameter(RMProperty aParameter)

Adds a parameter.

removeParameter

public RMProperty removeParameter(int anIndex)

Removes a parameter at given index.

removeParameter

public int removeParameter(RMProperty aParameter)

Removes a given parameter from parameters list.

getParameter

public RMProperty getParameter(java.lang.String aName)

Returns the named parameter.

getParameterValues

public java.util.Map getParameterValues()

Returns the map of parameter values.

getFilter

public java.lang.String getFilter()

Returns the filter string.

setFilter

public void setFilter(java.lang.String aString)

Sets the filter string.

getRows

public java.util.List<RMRow> getRows()

Returns a sample dataset of objects associated with the data source.

getFilteredRows

public java.util.List<RMRow> getFilteredRows()

Returns the list of filtered rows.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent anEvent)

Catches changes to condition and properties.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

refresh

public void refresh()

Reloads rows.

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver,
                                               java.lang.Object anOwner)

XML Archival.

fromXML

public RMQuery fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                       com.reportmill.archiver.RXElement anElement,
                       java.lang.Object anOwner)

XML Unarchival.