@ApplicationScoped public class DataSetClientServices extends Object
It hides to client widgets where the data sets are stored and how they are fetched and processed.
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) |
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.
|
public 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)
public boolean isPushRemoteDataSetEnabled()
public void setPushRemoteDataSetEnabled(boolean pushRemoteDataSetEnabled)
public void fetchMetadata(String uuid, DataSetMetadataCallback listener) throws Exception
uuid
- The UUID of the data setException
- It there is an unexpected error trying to execute the lookup request.public org.dashbuilder.dataset.DataSetMetadata getMetadata(String uuid)
uuid
- The UUID of the data set. Null if the metadata is not stored on client yet.public void exportDataSetCSV(org.dashbuilder.dataset.DataSetLookup request, DataSetExportReadyCallback listener) throws Exception
request
- The data set lookup requestException
- It there is an unexpected error during the export.public void exportDataSetExcel(org.dashbuilder.dataset.DataSetLookup request, DataSetExportReadyCallback listener) throws Exception
request
- The data set lookup requestException
- It there is an unexpected error during the export.public void newDataSet(org.dashbuilder.dataprovider.DataSetProviderType type, org.jboss.errai.common.client.api.RemoteCallback<org.dashbuilder.dataset.def.DataSetDef> callback) throws Exception
type
- The provider typeException
public void lookupDataSet(org.dashbuilder.dataset.def.DataSetDef def, org.dashbuilder.dataset.DataSetLookup request, DataSetReadyCallback listener) throws Exception
def
- The data set definitionrequest
- The data set lookup requestException
- It there is an unexpected error trying to execute the lookup request.public void lookupDataSet(org.dashbuilder.dataset.DataSetLookup request, DataSetReadyCallback listener) throws Exception
request
- The data set lookup requestException
- It there is an unexpected error trying to execute the lookup request.public void getRemoteSharedDataSetDefs(org.jboss.errai.common.client.api.RemoteCallback<List<org.dashbuilder.dataset.def.DataSetDef>> callback)
public void getPublicDataSetDefs(org.jboss.errai.common.client.api.RemoteCallback<List<org.dashbuilder.dataset.def.DataSetDef>> callback)
public org.dashbuilder.dataset.group.AggregateFunctionManager getAggregateFunctionManager()
public org.dashbuilder.dataset.engine.group.IntervalBuilderLocator getIntervalBuilderLocator()
public String getDownloadFileUrl(Path path)
Returns the download URL for a given file provided by a servlet method.
path
- The path of the file.Copyright © 2012–2018 JBoss by Red Hat. All rights reserved.