com.reportmill.base

Class RMDataSource

java.lang.Object

com.reportmill.base.RMDataSource

public class RMDataSource
extends java.lang.Object

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 Schema, Entity and Property objects) and it provides sample data (mostly in the form of Java Collections and core types: List, Map, String, Number, Date).

Constructor Summary

Constructors

Constructor and Description
RMDataSource() Creates a plain datasource.
RMDataSource(WebURL aURL) Creates a datasource from a given source with a given name (can be null).

Method Summary

Modifier and Type	Method and Description
RMDataSource	fromXML(XMLArchiver anArchiver, XMLElement anElement) 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.
java.lang.String	getName() Returns the name for this data source.
Schema	getSchema() Returns the schema of represented datasource as a hierarchy of Entity and Property objects.
java.lang.Object	getSource() Returns the source for this data source.
WebURL	getSourceURL() Returns the source for this data source.
void	setCustomSchema(boolean customSchema) Sets a schema that may differ from the one stored in an XML file.
java.lang.String	toString() Returns a string representation of the datasource (just its name).
XMLElement	toXML(XMLArchiver anArchiver) XML archival.

Methods inherited from class java.lang.Object

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

Constructor Detail

RMDataSource

public RMDataSource()

Creates a plain datasource.

RMDataSource

public RMDataSource(WebURL aURL)

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 this data source.

getSourceURL

public WebURL getSourceURL()

Returns the source for this data source.

getName

public java.lang.String getName()

Returns the name for this data source.

getSchema

public Schema getSchema()

Returns the schema of represented datasource as a hierarchy of Entity and Property objects.

getDataset

public java.util.Map getDataset()

Returns a sample dataset of objects associated with the datasource.

getCustomSchema

public boolean getCustomSchema()

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

setCustomSchema

public void setCustomSchema(boolean customSchema)

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

toXML

public XMLElement toXML(XMLArchiver anArchiver)

XML archival.

fromXML

public RMDataSource fromXML(XMLArchiver anArchiver,
                            XMLElement anElement)

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