org.dashbuilder.dataset.client

Class DataSetClientServices

java.lang.Object

org.dashbuilder.dataset.client.DataSetClientServices

@ApplicationScoped
public class DataSetClientServices
extends Object

Data set services for clients.

It hides to client widgets where the data sets are stored and how they are fetched and processed.

Constructor Summary

Constructors

Constructor and Description
DataSetClientServices()
DataSetClientServices(ClientDataSetManager clientDataSetManager, PathUrlFactory pathUrlFactory, org.dashbuilder.dataset.group.AggregateFunctionManager aggregateFunctionManager, org.dashbuilder.dataset.engine.group.IntervalBuilderLocator intervalBuilderLocator, javax.enterprise.event.Event<org.dashbuilder.dataset.events.DataSetPushingEvent> dataSetPushingEvent, javax.enterprise.event.Event<org.dashbuilder.dataset.events.DataSetPushOkEvent> dataSetPushOkEvent, javax.enterprise.event.Event<org.dashbuilder.dataset.events.DataSetModifiedEvent> dataSetModifiedEvent, org.jboss.errai.common.client.api.Caller<DataSetLookupServices> dataSetLookupServices, org.jboss.errai.common.client.api.Caller<DataSetDefServices> dataSetDefServices, org.jboss.errai.common.client.api.Caller<DataSetExportServices> dataSetExportServices)

Method Summary

Modifier and Type	Method and Description
void	exportDataSetCSV(org.dashbuilder.dataset.DataSetLookup request, DataSetExportReadyCallback listener) Export a data set, specified by a data set lookup request, to CSV format.
void	exportDataSetExcel(org.dashbuilder.dataset.DataSetLookup request, DataSetExportReadyCallback listener) Export a data set, specified by a data set lookup request, to Excel format.
void	fetchMetadata(String uuid, DataSetMetadataCallback listener) Fetch the metadata instance for the specified data set.
org.dashbuilder.dataset.group.AggregateFunctionManager	getAggregateFunctionManager()
String	getDownloadFileUrl(Path path) Returns the download URL for a given file provided by a servlet method.
org.dashbuilder.dataset.engine.group.IntervalBuilderLocator	getIntervalBuilderLocator()
org.dashbuilder.dataset.DataSetMetadata	getMetadata(String uuid) Get the cached metadata instance for the specified data set.
void	getPublicDataSetDefs(org.jboss.errai.common.client.api.RemoteCallback<List<org.dashbuilder.dataset.def.DataSetDef>> callback)
void	getRemoteSharedDataSetDefs(org.jboss.errai.common.client.api.RemoteCallback<List<org.dashbuilder.dataset.def.DataSetDef>> callback) Deprecated. Use getPublicDataSetDefs instead
String	getUploadFileUrl(String path) Returns the upload URL for a given file provided by a servlet method.
boolean	isPushRemoteDataSetEnabled()
void	lookupDataSet(org.dashbuilder.dataset.def.DataSetDef def, org.dashbuilder.dataset.DataSetLookup request, DataSetReadyCallback listener) Process the specified data set lookup request for a given definition.
void	lookupDataSet(org.dashbuilder.dataset.DataSetLookup request, DataSetReadyCallback listener) Process the specified data set lookup request.
void	newDataSet(org.dashbuilder.dataprovider.DataSetProviderType type, org.jboss.errai.common.client.api.RemoteCallback<org.dashbuilder.dataset.def.DataSetDef> callback) Creates a brand new data set definition for the provider type specified
void	setPushRemoteDataSetEnabled(boolean pushRemoteDataSetEnabled) Enable/disable the ability to push remote data sets from server.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSetClientServices

public DataSetClientServices()

DataSetClientServices

@Inject
public DataSetClientServices(ClientDataSetManager clientDataSetManager,
                                     PathUrlFactory pathUrlFactory,
                                     org.dashbuilder.dataset.group.AggregateFunctionManager aggregateFunctionManager,
                                     org.dashbuilder.dataset.engine.group.IntervalBuilderLocator intervalBuilderLocator,
                                     javax.enterprise.event.Event<org.dashbuilder.dataset.events.DataSetPushingEvent> dataSetPushingEvent,
                                     javax.enterprise.event.Event<org.dashbuilder.dataset.events.DataSetPushOkEvent> dataSetPushOkEvent,
                                     javax.enterprise.event.Event<org.dashbuilder.dataset.events.DataSetModifiedEvent> dataSetModifiedEvent,
                                     org.jboss.errai.common.client.api.Caller<DataSetLookupServices> dataSetLookupServices,
                                     org.jboss.errai.common.client.api.Caller<DataSetDefServices> dataSetDefServices,
                                     org.jboss.errai.common.client.api.Caller<DataSetExportServices> dataSetExportServices)

Method Detail

isPushRemoteDataSetEnabled

public boolean isPushRemoteDataSetEnabled()

setPushRemoteDataSetEnabled

public void setPushRemoteDataSetEnabled(boolean pushRemoteDataSetEnabled)

Enable/disable the ability to push remote data sets from server.

fetchMetadata

public void fetchMetadata(String uuid,
                          DataSetMetadataCallback listener)
                   throws Exception

Fetch the metadata instance for the specified data set.

Parameters:

uuid - The UUID of the data set

Throws:

Exception - It there is an unexpected error trying to execute the lookup request.

getMetadata

public org.dashbuilder.dataset.DataSetMetadata getMetadata(String uuid)

Get the cached metadata instance for the specified data set.

Parameters:

uuid - The UUID of the data set. Null if the metadata is not stored on client yet.

exportDataSetCSV

public void exportDataSetCSV(org.dashbuilder.dataset.DataSetLookup request,
                             DataSetExportReadyCallback listener)
                      throws Exception

Export a data set, specified by a data set lookup request, to CSV format.

Parameters:

request - The data set lookup request

Throws:

Exception - It there is an unexpected error during the export.

exportDataSetExcel

public void exportDataSetExcel(org.dashbuilder.dataset.DataSetLookup request,
                               DataSetExportReadyCallback listener)
                        throws Exception

Export a data set, specified by a data set lookup request, to Excel format.

Parameters:

request - The data set lookup request

Throws:

Exception - It there is an unexpected error during the export.

newDataSet

public void newDataSet(org.dashbuilder.dataprovider.DataSetProviderType type,
                       org.jboss.errai.common.client.api.RemoteCallback<org.dashbuilder.dataset.def.DataSetDef> callback)
                throws Exception

Creates a brand new data set definition for the provider type specified

Parameters:

type - The provider type

Throws:

Exception

lookupDataSet

public void lookupDataSet(org.dashbuilder.dataset.def.DataSetDef def,
                          org.dashbuilder.dataset.DataSetLookup request,
                          DataSetReadyCallback listener)
                   throws Exception

Process the specified data set lookup request for a given definition.

Parameters:

def - The data set definition

request - The data set lookup request

Throws:

Exception - It there is an unexpected error trying to execute the lookup request.

lookupDataSet

public void lookupDataSet(org.dashbuilder.dataset.DataSetLookup request,
                          DataSetReadyCallback listener)
                   throws Exception

Process the specified data set lookup request.

Parameters:

request - The data set lookup request

Throws:

Exception - It there is an unexpected error trying to execute the lookup request.

getRemoteSharedDataSetDefs

public void getRemoteSharedDataSetDefs(org.jboss.errai.common.client.api.RemoteCallback<List<org.dashbuilder.dataset.def.DataSetDef>> callback)

Deprecated. Use getPublicDataSetDefs instead

Since:

0.3.0.Final

getPublicDataSetDefs

public void getPublicDataSetDefs(org.jboss.errai.common.client.api.RemoteCallback<List<org.dashbuilder.dataset.def.DataSetDef>> callback)

getAggregateFunctionManager

public org.dashbuilder.dataset.group.AggregateFunctionManager getAggregateFunctionManager()

getIntervalBuilderLocator

public org.dashbuilder.dataset.engine.group.IntervalBuilderLocator getIntervalBuilderLocator()

getDownloadFileUrl

public String getDownloadFileUrl(Path path)

Returns the download URL for a given file provided by a servlet method.

Parameters:

path - The path of the file.

getUploadFileUrl

public String getUploadFileUrl(String path)

Returns the upload URL for a given file provided by a servlet method.

Parameters:

path - The path of the file.