Package com.flowable.platform.service.dashboard

Class DashboardServiceImpl

java.lang.Object

com.flowable.platform.service.dashboard.DashboardServiceImpl

All Implemented Interfaces:

DashboardService

@Transactional
public class DashboardServiceImpl
extends Object
implements DashboardService

Field Summary

Fields

Modifier and Type	Field	Description
protected CmmnRepositoryService	cmmnRepositoryService
protected DashboardComponentQueryResultMapperService	dashboardComponentQueryResultMapperService
protected DashboardConfigurationService	dashboardConfigurationService
protected DashboardComponentInputValuesTransformer	jsonToStandardQueryInputTransformer
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected PlatformRepositoryService	platformRepositoryService
protected QueryResultToCsvTransformerService	queryResultToCsvTransformerService
protected QueryService	queryService
protected RepositoryService	repositoryService
protected ResourceHelper	resourceHelper
protected SearchService	searchService

Constructor Summary

Constructors

Constructor	Description
DashboardServiceImpl()

Method Summary

Modifier and Type	Method	Description
Dashboard	createDashboard(String name, String currentUserId, String currentTenantId)	Creates a new Dashboard for the given user and tenant.
DashboardQuery	createDashboardQuery()	Create a DashboardQuery which can be used to query existing dashboards.
DashboardUpdateBuilder	createDashboardUpdateBuilder(String dashboardId)	Updates the dashboard configuration
void	delete(String dashboardId)	Deletes a Dashboard.
void	exportDataAsCSV(String dashboardId, String componentDefinitionKey, com.fasterxml.jackson.databind.JsonNode requestInputParameterValues, com.fasterxml.jackson.databind.JsonNode requestOptionValues, OutputStream outputStream)
protected List<DashboardAvailableVariable>	extractAvailableVariables(com.fasterxml.jackson.databind.JsonNode queryResponse)
List<DashboardComponentDefinitionModel>	getAvailableComponentDefinitions(String dashboardId)	Returns a catalogue of components (returned as a list of DashboardComponentDefinitionModels) that can be added to the Dashboard with the provided id.
List<DashboardParameterValue>	getAvailableInputParameterValues(String dashboardId, String tenantId, String parameterName)
List<DashboardAvailableVariable>	getAvailableVariables(String dashboardId, String tenantId, String variableNameLike, com.fasterxml.jackson.databind.JsonNode inputParameters, int responseSize)
protected DashboardConfiguration	getDashboardConfiguration(Dashboard dashboard)
List<DashboardComponentDefinitionModel.DashboardComponentInputParameter>	getDashboardInputParameters(String dashboardId)	Returns the union of all input parameters of all components for the dashboard with the provided id.
DashboardComponentData	getData(String dashboardId, String componentDefinitionKey, com.fasterxml.jackson.databind.JsonNode inputParameterValues, com.fasterxml.jackson.databind.JsonNode optionValues)	Returns the data for one component of a dashboard, using the provided input parameters and options.
protected DashboardComponentData	internalGetData(Dashboard dashboard, String componentDefinitionKey, com.fasterxml.jackson.databind.JsonNode inputParameterValues, com.fasterxml.jackson.databind.JsonNode optionValues)

Methods inherited from class java.lang.Object

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

Field Details

dashboardConfigurationService

@Autowired
protected DashboardConfigurationService dashboardConfigurationService

jsonToStandardQueryInputTransformer

@Autowired
protected DashboardComponentInputValuesTransformer jsonToStandardQueryInputTransformer

queryResultToCsvTransformerService

@Autowired
protected QueryResultToCsvTransformerService queryResultToCsvTransformerService

dashboardComponentQueryResultMapperService

@Autowired
protected DashboardComponentQueryResultMapperService dashboardComponentQueryResultMapperService

platformRepositoryService

@Autowired
protected PlatformRepositoryService platformRepositoryService

queryService

@Autowired(required=false)
protected QueryService queryService

searchService

@Autowired(required=false)
protected SearchService searchService

repositoryService

@Autowired
protected RepositoryService repositoryService

cmmnRepositoryService

@Autowired
protected CmmnRepositoryService cmmnRepositoryService

resourceHelper

@Autowired
protected ResourceHelper resourceHelper

objectMapper

@Autowired
protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Details

DashboardServiceImpl

public DashboardServiceImpl()

Method Details

createDashboard

public Dashboard createDashboard(String name,
 String currentUserId,
 String currentTenantId)

Description copied from interface: DashboardService

Creates a new Dashboard for the given user and tenant.

Specified by:

createDashboard in interface DashboardService

createDashboardQuery

public DashboardQuery createDashboardQuery()

Description copied from interface: DashboardService

Create a DashboardQuery which can be used to query existing dashboards.

Specified by:

createDashboardQuery in interface DashboardService

delete

public void delete(String dashboardId)

Description copied from interface: DashboardService

Deletes a Dashboard.

Specified by:

delete in interface DashboardService

getAvailableComponentDefinitions

public List<DashboardComponentDefinitionModel> getAvailableComponentDefinitions(String dashboardId)

Description copied from interface: DashboardService

Returns a catalogue of components (returned as a list of DashboardComponentDefinitionModels) that can be added to the Dashboard with the provided id.

Specified by:

getAvailableComponentDefinitions in interface DashboardService

getAvailableVariables

public List<DashboardAvailableVariable> getAvailableVariables(String dashboardId,
 String tenantId,
 String variableNameLike,
 com.fasterxml.jackson.databind.JsonNode inputParameters,
 int responseSize)

Specified by:

getAvailableVariables in interface DashboardService

getAvailableInputParameterValues

public List<DashboardParameterValue> getAvailableInputParameterValues(String dashboardId,
 String tenantId,
 String parameterName)

Specified by:

getAvailableInputParameterValues in interface DashboardService

extractAvailableVariables

protected List<DashboardAvailableVariable> extractAvailableVariables(com.fasterxml.jackson.databind.JsonNode queryResponse)

createDashboardUpdateBuilder

public DashboardUpdateBuilder createDashboardUpdateBuilder(String dashboardId)

Description copied from interface: DashboardService

Updates the dashboard configuration

Specified by:

createDashboardUpdateBuilder in interface DashboardService

getDashboardInputParameters

public List<DashboardComponentDefinitionModel.DashboardComponentInputParameter> getDashboardInputParameters(String dashboardId)

Description copied from interface: DashboardService

Returns the union of all input parameters of all components for the dashboard with the provided id.

Specified by:

getDashboardInputParameters in interface DashboardService

getData

public DashboardComponentData getData(String dashboardId,
 String componentDefinitionKey,
 com.fasterxml.jackson.databind.JsonNode inputParameterValues,
 com.fasterxml.jackson.databind.JsonNode optionValues)

Description copied from interface: DashboardService

Returns the data for one component of a dashboard, using the provided input parameters and options.

Specified by:

getData in interface DashboardService

exportDataAsCSV

public void exportDataAsCSV(String dashboardId,
 String componentDefinitionKey,
 com.fasterxml.jackson.databind.JsonNode requestInputParameterValues,
 com.fasterxml.jackson.databind.JsonNode requestOptionValues,
 OutputStream outputStream)

Specified by:

exportDataAsCSV in interface DashboardService

internalGetData

protected DashboardComponentData internalGetData(Dashboard dashboard,
 String componentDefinitionKey,
 com.fasterxml.jackson.databind.JsonNode inputParameterValues,
 com.fasterxml.jackson.databind.JsonNode optionValues)

getDashboardConfiguration

protected DashboardConfiguration getDashboardConfiguration(Dashboard dashboard)