com.reportmill.base

Class RMXMLDataSource

java.lang.Object

com.reportmill.base.RMDataSource

com.reportmill.base.RMXMLDataSource

public class RMXMLDataSource
extends RMDataSource

This class is used as a proxy for objects passed to document's generateReport() method. It provides schema information of the object graph (in the form of RMEntity and RMProperty objects) and it provides sample data (probably in the form of Java Collections and core types: List, Map, String, Number, Date).

Constructor Summary

Constructors

Constructor and Description
RMXMLDataSource() Creates a plain datasource.
RMXMLDataSource(java.lang.Object aSource) Creates a datasource from a given source with a given name (can be null).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object anObj) Standard equals implementation.
RMXMLDataSource	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival.
boolean	getCustomSchema() Returns a schema that may differ from the one stored in an XML file.
java.util.Map	getDataset() Returns a sample dataset of objects associated with the datasource.
javi.data.Schema	getSchema() Returns the schema of represented datasource as a hierarchy of RMEntity and RMProperty objects.
java.lang.Object	getSource() Returns the source for the datasource.
void	refresh() Invalidates any cached data.
void	setCustomSchema(boolean customSchema) Sets a schema that may differ from the one stored in an XML file.
void	setSource(java.lang.Object aSource) Sets the source for the datasource.
java.lang.String	toString() Returns a string representation of the datasource (just its name).
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML archival.

Methods inherited from class com.reportmill.base.RMDataSource

getEntity, getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

RMXMLDataSource

public RMXMLDataSource()

Creates a plain datasource.

RMXMLDataSource

public RMXMLDataSource(java.lang.Object aSource)

Creates a datasource from a given source with a given name (can be null).

Method Detail

getSource

public java.lang.Object getSource()

Returns the source for the datasource.

setSource

public void setSource(java.lang.Object aSource)

Sets the source for the datasource.

getSchema

public javi.data.Schema getSchema()

Returns the schema of represented datasource as a hierarchy of RMEntity and RMProperty objects.

Specified by:

getSchema in class RMDataSource

getCustomSchema

public boolean getCustomSchema()

Returns a schema that may differ from the one stored in an XML file.

Overrides:

getCustomSchema in class RMDataSource

setCustomSchema

public void setCustomSchema(boolean customSchema)

Sets a schema that may differ from the one stored in an XML file.

Overrides:

setCustomSchema in class RMDataSource

getDataset

public java.util.Map getDataset()

Returns a sample dataset of objects associated with the datasource.

Specified by:

getDataset in class RMDataSource

refresh

public void refresh()

Invalidates any cached data.

Overrides:

refresh in class RMDataSource

equals

public boolean equals(java.lang.Object anObj)

Standard equals implementation.

Overrides:

equals in class java.lang.Object

toXML

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

XML archival.

fromXML

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

XML unarchival.

toString

public java.lang.String toString()

Returns a string representation of the datasource (just its name).

Overrides:

toString in class java.lang.Object