Package org.dashbuilder.dataset

Interface DataSetManager

  • public interface DataSetManager
    Main interface for handling data sets.

    • Method Detail

      • createDataSet

        DataSet createDataSet​(String uuid)
        Create a brand new data set instance.
        Parameters:
        uuid - The UUID to assign to the new data set.

      • getDataSet

        DataSet getDataSet​(String uuid)
        Retrieve (load if required) a data set.
        Parameters:
        uuid - The UUID of the data set.
        Returns:
        null, if the data set can be retrieved.

      • registerDataSet

        void registerDataSet​(DataSet dataSet)
        Registers the specified data set instance.

      • registerDataSet

        void registerDataSet​(DataSet dataSet,
                     List<DataSetPreprocessor> preprocessors)
        Registers the specified data set instance with a list of preprocessors

      • removeDataSet

        DataSet removeDataSet​(String uuid)
        Removes the specified data set instance.
        Parameters:
        uuid - The UUID of the data set.
        Returns:
        The data set removed. null - if the data set does not exists.

      • lookupDataSet

        DataSet lookupDataSet​(DataSetLookup lookup)
        Load a data set and apply several operations (filter, sort, group, ...) on top of it.
        Returns:
        null, if the data set can be retrieved.

      • lookupDataSets

        DataSet[] lookupDataSets​(DataSetLookup[] lookup)
        Process multiple data set lookup request in a single shot.

      • getDataSetMetadata

        DataSetMetadata getDataSetMetadata​(String uuid)
        Retrieves the metadata for a given data set
        Returns:
        A DataSetMetadata instance containing general information about the data set, or null if the data set can be retrieved.