org.dashbuilder.dataset.def

Interface DataSetDefRegistry

public interface DataSetDefRegistry

Data set definitions registry service

Method Summary

Modifier and Type	Method and Description
void	addListener(DataSetDefRegistryListener listener) Register a listener interesetd in observe the DataSetDef lifecycle events.
DataSetDef	getDataSetDef(String uuid) Get the definition for the specified data set.
List<DataSetPostProcessor>	getDataSetDefPostProcessors(String uuid) Get the post processors for a given definition for the specified data set.
List<DataSetPreprocessor>	getDataSetDefPreProcessors(String uuid) Get the preprocessors for a given definition for the specified data set.
List<DataSetDef>	getDataSetDefs(boolean onlyPublic) Get the data set definitions available.
void	registerDataSetDef(DataSetDef dataSetDef) Add a data set definition to the registry.
void	registerDataSetDef(DataSetDef dataSetDef, String subjectId, String message) Add a data set definition to the registry.
void	registerPostProcessor(String uuid, DataSetPostProcessor postProcessor) Register a DataSetPostProcessor instance for the given to data set.
void	registerPreprocessor(String uuid, DataSetPreprocessor preprocessor) Register a DataSetPreprocessor instance for the given to data set.
DataSetDef	removeDataSetDef(String uuid) Removes the specified data set definition.
DataSetDef	removeDataSetDef(String uuid, String subjectId, String message) Removes the specified data set definition.

Method Detail

getDataSetDefs

List<DataSetDef> getDataSetDefs(boolean onlyPublic)

Get the data set definitions available.

Parameters:

onlyPublic - Get only those public (shareable) data set definition (public flag set to true)

getDataSetDef

DataSetDef getDataSetDef(String uuid)

Get the definition for the specified data set.

Parameters:

uuid - The unique universal identifier of the data set

Returns:

The data set definition instance or null if the definition does not exist.

getDataSetDefPreProcessors

List<DataSetPreprocessor> getDataSetDefPreProcessors(String uuid)

Get the preprocessors for a given definition for the specified data set.

Parameters:

uuid - The unique universal identifier of the data set

Returns:

The data set preprocesosrs list or null if the definition does not exist or there is no preprocessor registered.

getDataSetDefPostProcessors

List<DataSetPostProcessor> getDataSetDefPostProcessors(String uuid)

Get the post processors for a given definition for the specified data set.

Parameters:

uuid - The unique universal identifier of the data set

Returns:

The data set post processors list or null if the definition does not exist or there is no post processor registered.

registerPreprocessor

void registerPreprocessor(String uuid,
                          DataSetPreprocessor preprocessor)

Register a DataSetPreprocessor instance for the given to data set.

Parameters:

uuid - The unique universal identifier of the data set

preprocessor - A data set preprocessor

registerPostProcessor

void registerPostProcessor(String uuid,
                           DataSetPostProcessor postProcessor)

Register a DataSetPostProcessor instance for the given to data set.

Parameters:

uuid - The unique universal identifier of the data set

postProcessor - A data set postprocessor

registerDataSetDef

void registerDataSetDef(DataSetDef dataSetDef)

Add a data set definition to the registry.

Parameters:

dataSetDef - The data set definition

registerDataSetDef

void registerDataSetDef(DataSetDef dataSetDef,
                        String subjectId,
                        String message)

Add a data set definition to the registry.

Parameters:

dataSetDef - The data set definition

subjectId, - The identifier of the subject making the request. If null is ignored.

message, - A message to store along the registration request. If null is ignored.

removeDataSetDef

DataSetDef removeDataSetDef(String uuid)

Removes the specified data set definition.

Parameters:

uuid - The unique universal identifier of the data set

Returns:

The removed data set definition or null if the definition does not exist.

removeDataSetDef

DataSetDef removeDataSetDef(String uuid,
                            String subjectId,
                            String message)

Removes the specified data set definition.

Parameters:

uuid - The unique universal identifier of the data set

subjectId, - The identifier of the subject making the request. If null is ignored.

message, - A message to store along the registration request. If null is ignored.

Returns:

The removed data set definition or null if the definition does not exist.

addListener

void addListener(DataSetDefRegistryListener listener)

Register a listener interesetd in observe the DataSetDef lifecycle events.