com.reportmill.datasource

Class RMURLDataSource

java.lang.Object

com.reportmill.base.RMObject

com.reportmill.datasource.RMDataSource

com.reportmill.datasource.RMURLDataSource

All Implemented Interfaces:

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

public class RMURLDataSource
extends RMDataSource

A data source implementation to get structured JSON data from a parameterized URL.

Nested Class Summary

Nested classes/interfaces inherited from class com.reportmill.datasource.RMDataSource

RMDataSource.EntityResolver

Constructor Summary

Constructors

Constructor and Description
RMURLDataSource() Creates a new URL data source.
RMURLDataSource(java.lang.Object aSource) Creates a new JSON data source for source.

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(RMProperty aParameter) Adds a parameter.
void	addParameter(RMProperty aParameter, int anIndex) Adds a parameter.
void	copyValues(RMDataSource aDataSource) Tells this data source to make changes to duplicate settings in given data source.
void	create() Override because this data source doesn't create anything external.
void	delete() Override because this data source doesn't create anything external.
RMURLDataSource	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML unarchival.
java.net.URL	getBaseURL() Returns the base url.
java.lang.String	getBaseURLString() Returns the base URL string.
RMRow	getData(java.lang.Object aSource, RMEntity anEntity) Reads data from a given source.
java.util.Map	getDataset() Returns all data source data as a dataset.
RMCondition	getDefaultCondition(RMEntity anEntity) Returns a default condition (or condition list) associated with data soruce.
java.util.List<RMProperty>	getDefaultParameters(RMEntity anEntity) Returns a list of default parameters associated with data source.
java.util.List<? extends RMFile>	getFilesImpl(java.lang.String aPath) Returns files at path.
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.net.URL	getParameterURL(RMCondition aCondition) Returns the parameter URL.
java.lang.StringBuffer	getParameterURLString(java.lang.StringBuffer aBuffer, RMCondition aCondition) Returns the parameter URL string.
java.util.List<? extends RMProperty>	getQueryParameters(RMEntity anEntity) Returns the query parameters.
java.lang.String	getResultsKey() Returns the key used to dereference the results array.
RMSchema	getSampleSchema(java.lang.Object aSource) Reads the sample schema from given source.
java.net.URL	getSampleURL() Returns the sample URL.
java.lang.String	getSampleURLString() Return the sample URL string.
RMSchema	getSchema() Returns the schema.
java.lang.String	getTypeString() Returns the type string.
void	refresh() Override to suppress file clearing.
RMProperty	removeParameter(int anIndex) Removes a parameter at given index.
int	removeParameter(RMProperty aParameter) Removes a given parameter from parameters list.
void	setBaseURL(java.net.URL aURL) Sets the base URL.
java.lang.Exception	setBaseURLString(java.lang.String aString) Returns the base URL string.
void	setResultsKey(java.lang.String aKey) Sets the key used to dereference the results array.
void	setSampleURL(java.net.URL aURL) Sets the sample URL.
java.lang.Exception	setSampleURLString(java.lang.String aString) Sets the sample URL as string.
void	setSchema(RMSchema aSchema) Sets the schema.
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML archival.
void	toXMLFiles(com.reportmill.archiver.RXElement anElement, RMFile aFile) XML file archival.

Methods inherited from class com.reportmill.datasource.RMDataSource

createEntity, createObject, deleteEntity, deleteFile, deleteRow, equals, getAllRows, getDataset, getEntity, getEntityClass, getEntityResolver, getFile, getFile, getFile, getName, getRootDirectory, getRow, getRow, getRows, getSchemaVisible, getUniqueRow, insertRow, propertyChange, readFile, saveRows, saveRowsImmediately, setEntityResolver, setName, toString, updateRow, writeFile

Methods inherited from class com.reportmill.base.RMObject

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RMURLDataSource

public RMURLDataSource()

Creates a new URL data source.

RMURLDataSource

public RMURLDataSource(java.lang.Object aSource)

Creates a new JSON data source for source.

Method Detail

getBaseURL

public java.net.URL getBaseURL()

Returns the base url.

setBaseURL

public void setBaseURL(java.net.URL aURL)

Sets the base URL.

getBaseURLString

public java.lang.String getBaseURLString()

Returns the base URL string.

setBaseURLString

public java.lang.Exception setBaseURLString(java.lang.String aString)

Returns the base URL string.

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.

addParameter

public void addParameter(RMProperty aParameter,
                int anIndex)

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.

getParameterURL

public java.net.URL getParameterURL(RMCondition aCondition)

Returns the parameter URL.

getParameterURLString

public java.lang.StringBuffer getParameterURLString(java.lang.StringBuffer aBuffer,
                                           RMCondition aCondition)

Returns the parameter URL string.

getResultsKey

public java.lang.String getResultsKey()

Returns the key used to dereference the results array.

setResultsKey

public void setResultsKey(java.lang.String aKey)

Sets the key used to dereference the results array.

getSampleURL

public java.net.URL getSampleURL()

Returns the sample URL.

setSampleURL

public void setSampleURL(java.net.URL aURL)

Sets the sample URL.

getSampleURLString

public java.lang.String getSampleURLString()

Return the sample URL string.

setSampleURLString

public java.lang.Exception setSampleURLString(java.lang.String aString)

Sets the sample URL as string.

getSchema

public RMSchema getSchema()

Returns the schema.

Overrides:

getSchema in class RMDataSource

setSchema

public void setSchema(RMSchema aSchema)

Sets the schema.

getTypeString

public java.lang.String getTypeString()

Returns the type string.

Overrides:

getTypeString in class RMDataSource

getDataset

public java.util.Map getDataset()

Returns all data source data as a dataset.

Overrides:

getDataset in class RMDataSource

getFilesImpl

public java.util.List<? extends RMFile> getFilesImpl(java.lang.String aPath)

Returns files at path.

Overrides:

getFilesImpl in class RMDataSource

create

public void create()

Override because this data source doesn't create anything external.

Overrides:

create in class RMDataSource

delete

public void delete()

Override because this data source doesn't create anything external.

Overrides:

delete in class RMDataSource

getSampleSchema

public RMSchema getSampleSchema(java.lang.Object aSource)

Reads the sample schema from given source.

getData

public RMRow getData(java.lang.Object aSource,
            RMEntity anEntity)

Reads data from a given source.

copyValues

public void copyValues(RMDataSource aDataSource)

Tells this data source to make changes to duplicate settings in given data source.

Overrides:

copyValues in class RMDataSource

getDefaultParameters

public java.util.List<RMProperty> getDefaultParameters(RMEntity anEntity)

Returns a list of default parameters associated with data source.

Overrides:

getDefaultParameters in class RMDataSource

getDefaultCondition

public RMCondition getDefaultCondition(RMEntity anEntity)

Returns a default condition (or condition list) associated with data soruce.

Overrides:

getDefaultCondition in class RMDataSource

getQueryParameters

public java.util.List<? extends RMProperty> getQueryParameters(RMEntity anEntity)

Returns the query parameters.

Overrides:

getQueryParameters in class RMDataSource

refresh

public void refresh()

Override to suppress file clearing.

Overrides:

refresh in class RMDataSource

toXML

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

XML archival.

Overrides:

toXML in class RMDataSource

fromXML

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

XML unarchival.

Overrides:

fromXML in class RMDataSource

toXMLFiles

public void toXMLFiles(com.reportmill.archiver.RXElement anElement,
              RMFile aFile)

XML file archival.