it.eng.spagobi.tools.dataset.dao
Interface IDataSetDAO

All Superinterfaces:
ISpagoBIDao
All Known Implementing Classes:
DataSetDAOImpl

public interface IDataSetDAO
extends ISpagoBIDao

Defines the interfaces for all methods needed to insert, modify and deleting an engine.


Method Summary
 SbiDataSetHistory copyDataSetHistory(SbiDataSetHistory hibDataSet)
           
 java.lang.Integer countBIObjAssociated(java.lang.Integer dsId)
          Counts number of BIObj associated.
 java.lang.Integer countDatasets()
          Counts number of existent DataSets
 void deleteAllInactiveDataSetVersions(java.lang.Integer dsID)
          Delete all inactive dataset versions.
 void deleteDataSet(java.lang.Integer dsID)
          Delete data set.
 boolean deleteInactiveDataSetVersion(java.lang.Integer dsVerionID)
          Delete the inactive dataset version.
 java.lang.Integer getHigherVersionNumForDS(java.lang.Integer dsId)
          Returns the Higher Version Number of a selected DS
 boolean hasBIObjAssociated(java.lang.String dsId)
          Checks for bi obj associated.
 java.lang.Integer insertDataSet(GuiGenericDataSet dataSet)
          Insert data set.
 it.eng.spagobi.tools.dataset.bo.IDataSet loadActiveDataSetByLabel(java.lang.String label)
          Load data set by label.
 it.eng.spagobi.tools.dataset.bo.IDataSet loadActiveIDataSetByID(java.lang.Integer dsId)
          Load data set by id.
 java.util.List loadAllActiveDataSets()
          Load all active data sets.
 GuiGenericDataSet loadDataSetById(java.lang.Integer dsId)
          Load data set by id.
 GuiGenericDataSet loadDataSetByLabel(java.lang.String dsLabel)
          Load data set by label.
 java.util.List<GuiGenericDataSet> loadFilteredDatasetList(java.lang.String hsql, java.lang.Integer offset, java.lang.Integer fetchSize)
           
 java.util.List<GuiGenericDataSet> loadPagedDatasetList(java.lang.Integer offset, java.lang.Integer fetchSize)
          Returns List of all existent IDataSets with current active version
 java.util.List<SbiDataSetConfig> loadPagedSbiDatasetConfigList(java.lang.Integer offset, java.lang.Integer fetchSize)
          Returns List of all existent SbiDataSetConfig elements (NO DETAIL, only name, label, descr...).
 void modifyDataSet(GuiGenericDataSet dataSet)
          Modify data set.
 GuiGenericDataSet restoreOlderDataSetVersion(java.lang.Integer dsId, java.lang.Integer dsVersion)
          Restore an Older Version of the dataset
 GuiGenericDataSet toDataSet(it.eng.spagobi.tools.dataset.bo.IDataSet iDataSet)
          From the IDataSet as input, return the corrispondent GuiGenericDataSet object.
 it.eng.spagobi.tools.dataset.bo.IDataSet toIDataSet(SbiDataSetHistory hibDataSet)
          From the hibernate DataSet as input, gives the corrispondent DataSet object.
 
Methods inherited from interface it.eng.spagobi.commons.dao.ISpagoBIDao
getUserProfile, setUserID, setUserProfile
 

Method Detail

deleteDataSet

void deleteDataSet(java.lang.Integer dsID)
                   throws it.eng.spago.error.EMFUserError
Delete data set.

Parameters:
dsID - the a data set ID
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

deleteInactiveDataSetVersion

boolean deleteInactiveDataSetVersion(java.lang.Integer dsVerionID)
                                     throws it.eng.spago.error.EMFUserError
Delete the inactive dataset version.

Parameters:
dsVerionID - the a data set version ID
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

deleteAllInactiveDataSetVersions

void deleteAllInactiveDataSetVersions(java.lang.Integer dsID)
                                      throws it.eng.spago.error.EMFUserError
Delete all inactive dataset versions.

Parameters:
dsID - the a data set fo which all old versions need to eb deleted
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

insertDataSet

java.lang.Integer insertDataSet(GuiGenericDataSet dataSet)
                                throws it.eng.spago.error.EMFUserError
Insert data set.

Parameters:
dataSet - the a data set
Throws:
it.eng.spago.error.EMFUserError - the EMF user error
See Also:
it.eng.spagobi.tools.dataset.dao.IDataSetDAO#insertDataSet(it.eng.spagobi.tools.dataset.bo.AbstractDataSet)

restoreOlderDataSetVersion

GuiGenericDataSet restoreOlderDataSetVersion(java.lang.Integer dsId,
                                             java.lang.Integer dsVersion)
                                             throws it.eng.spago.error.EMFUserError
Restore an Older Version of the dataset

Parameters:
dsId - the a data set ID
dsVersion - the a data set Version
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

getHigherVersionNumForDS

java.lang.Integer getHigherVersionNumForDS(java.lang.Integer dsId)
                                           throws it.eng.spago.error.EMFUserError
Returns the Higher Version Number of a selected DS

Parameters:
dsId - the a data set ID
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

modifyDataSet

void modifyDataSet(GuiGenericDataSet dataSet)
                   throws it.eng.spago.error.EMFUserError
Modify data set.

Parameters:
aDataSet - the a data set
Throws:
it.eng.spago.error.EMFUserError - the EMF user error
See Also:
it.eng.spagobi.tools.dataset.dao.IDataSetDAO#modifyDataSet(it.eng.spagobi.tools.dataset.bo.AbstractDataSet)

loadPagedSbiDatasetConfigList

java.util.List<SbiDataSetConfig> loadPagedSbiDatasetConfigList(java.lang.Integer offset,
                                                               java.lang.Integer fetchSize)
                                                               throws it.eng.spago.error.EMFUserError
Returns List of all existent SbiDataSetConfig elements (NO DETAIL, only name, label, descr...).

Parameters:
offset - starting element
fetchSize - number of elements to retrieve
Returns:
List of all existent SbiDataSetConfig
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadFilteredDatasetList

java.util.List<GuiGenericDataSet> loadFilteredDatasetList(java.lang.String hsql,
                                                          java.lang.Integer offset,
                                                          java.lang.Integer fetchSize)
                                                          throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError

loadPagedDatasetList

java.util.List<GuiGenericDataSet> loadPagedDatasetList(java.lang.Integer offset,
                                                       java.lang.Integer fetchSize)
                                                       throws it.eng.spago.error.EMFUserError
Returns List of all existent IDataSets with current active version

Parameters:
offset - starting element
fetchSize - number of elements to retrieve
Returns:
List of all existent IDataSets with current active version
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

countBIObjAssociated

java.lang.Integer countBIObjAssociated(java.lang.Integer dsId)
                                       throws it.eng.spago.error.EMFUserError
Counts number of BIObj associated.

Parameters:
dsId - the ds id
Returns:
Integer, number of BIObj associated
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

countDatasets

java.lang.Integer countDatasets()
                                throws it.eng.spago.error.EMFUserError
Counts number of existent DataSets

Returns:
Integer, number of existent DataSets
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

hasBIObjAssociated

boolean hasBIObjAssociated(java.lang.String dsId)
                           throws it.eng.spago.error.EMFUserError
Checks for bi obj associated.

Parameters:
dsId - the ds id
Returns:
true, if checks for bi obj associated
Throws:
it.eng.spago.error.EMFUserError - the EMF user error
See Also:
it.eng.spagobi.tools.dataSet.dao.IDataSetDAO#hasBIObjAssociated(java.lang.String)

loadActiveIDataSetByID

it.eng.spagobi.tools.dataset.bo.IDataSet loadActiveIDataSetByID(java.lang.Integer dsId)
                                                                throws it.eng.spago.error.EMFUserError
Load data set by id.

Parameters:
dsID - the ds id
Returns:
the data set
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadActiveDataSetByLabel

it.eng.spagobi.tools.dataset.bo.IDataSet loadActiveDataSetByLabel(java.lang.String label)
                                                                  throws it.eng.spago.error.EMFUserError
Load data set by label.

Parameters:
label - the label
Returns:
the data set
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadDataSetById

GuiGenericDataSet loadDataSetById(java.lang.Integer dsId)
                                  throws it.eng.spago.error.EMFUserError
Load data set by id.

Parameters:
datasetId - datasetConfig
Returns:
the data set
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadDataSetByLabel

GuiGenericDataSet loadDataSetByLabel(java.lang.String dsLabel)
                                     throws it.eng.spago.error.EMFUserError
Load data set by label.

Parameters:
datasetId - datasetConfig
Returns:
the data set
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

loadAllActiveDataSets

java.util.List loadAllActiveDataSets()
                                     throws it.eng.spago.error.EMFUserError
Load all active data sets.

Returns:
the list
Throws:
it.eng.spago.error.EMFUserError - the EMF user error

toIDataSet

it.eng.spagobi.tools.dataset.bo.IDataSet toIDataSet(SbiDataSetHistory hibDataSet)
                                                    throws it.eng.spago.error.EMFUserError
From the hibernate DataSet as input, gives the corrispondent DataSet object.

Parameters:
hibDataSet - The hybernate data set
Returns:
The corrispondent DataSet object
Throws:
it.eng.spago.error.EMFUserError

toDataSet

GuiGenericDataSet toDataSet(it.eng.spagobi.tools.dataset.bo.IDataSet iDataSet)
                            throws it.eng.spago.error.EMFUserError
From the IDataSet as input, return the corrispondent GuiGenericDataSet object.

Parameters:
iDataSet - The IDataSet
Returns:
The corrispondent GuiGenericDataSet object
Throws:
it.eng.spago.error.EMFUserError

copyDataSetHistory

SbiDataSetHistory copyDataSetHistory(SbiDataSetHistory hibDataSet)
                                     throws it.eng.spago.error.EMFUserError
Throws:
it.eng.spago.error.EMFUserError