Package io.revealbi.core.data

Class RVMongoDBDataSourceItem

java.lang.Object

io.revealbi.core.data.RVDataSourceItem

io.revealbi.core.data.RVMongoDBDataSourceItem

All Implemented Interfaces:

ICustomQuerySupport, IProcessDataOnServerDataSourceItem

public class RVMongoDBDataSourceItem
extends RVDataSourceItem
implements IProcessDataOnServerDataSourceItem, ICustomQuerySupport

Data source item for MongoDB. Represents a specific collection within a MongoDB database.

Constructor Summary

Constructors

Constructor	Description
RVMongoDBDataSourceItem(RVMongoDBDataSource dataSource)

Method Summary

Modifier and Type	Method	Description
Boolean	getAllowDiskUse()	Returns whether MongoDB may use disk for aggregation operations.
String	getCollection()	Gets or sets the name of the collection.
String	getCustomQuery()	(Optional) Custom MongoDB query to use when getting data
boolean	getProcessDataOnServer()	Returns whether data processing is performed on the Reveal server.
void	setAllowDiskUse(Boolean allowDiskUse)	Sets whether MongoDB may use disk for aggregation operations.
void	setCollection(String collection)	Gets or sets the name of the collection.
void	setCustomQuery(String customQuery)	(Optional) Custom MongoDB query to use when getting data
void	setProcessDataOnServer(boolean processDataOnServer)	Sets whether data processing is performed on the Reveal server.

Methods inherited from class io.revealbi.core.data.RVDataSourceItem

getDataSource, getDefaultRefreshRate, getDescription, getId, getSubtitle, getTitle, setDataSource, setDefaultRefreshRate, setDescription, setId, setSubtitle, setTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RVMongoDBDataSourceItem

public RVMongoDBDataSourceItem(RVMongoDBDataSource dataSource)

Method Details

getCollection

public String getCollection()

Gets or sets the name of the collection.

Returns:

setCollection

public void setCollection(String collection)

Gets or sets the name of the collection.

Parameters:

collection -

getCustomQuery

public String getCustomQuery()

(Optional) Custom MongoDB query to use when getting data

Specified by:

getCustomQuery in interface ICustomQuerySupport

Returns:

setCustomQuery

public void setCustomQuery(String customQuery)

(Optional) Custom MongoDB query to use when getting data

Specified by:

setCustomQuery in interface ICustomQuerySupport

Parameters:

customQuery -

getProcessDataOnServer

public boolean getProcessDataOnServer()

Returns whether data processing is performed on the Reveal server.

Specified by:

getProcessDataOnServer in interface IProcessDataOnServerDataSourceItem

Returns:

true if data is processed on the server; false to process in the client.

setProcessDataOnServer

public void setProcessDataOnServer(boolean processDataOnServer)

Sets whether data processing is performed on the Reveal server.

Specified by:

setProcessDataOnServer in interface IProcessDataOnServerDataSourceItem

Parameters:

processDataOnServer - true to process data on the server; false to process in the client.

getAllowDiskUse

public Boolean getAllowDiskUse()

Returns whether MongoDB may use disk for aggregation operations.

Returns:

whether MongoDB may use disk for aggregation operations.

setAllowDiskUse

public void setAllowDiskUse(Boolean allowDiskUse)

Sets whether MongoDB may use disk for aggregation operations.

Parameters:

allowDiskUse - whether MongoDB may use disk for aggregation operations.