fr.cnes.sitools.dataset.model
Class DataSet

java.lang.Object
  fr.cnes.sitools.dataset.model.DataSet

All Implemented Interfaces:

IResource, java.io.Serializable

public final class DataSet
extends java.lang.Object
implements IResource, java.io.Serializable

Class defining a DataSet The DataSet is shared by all resources of the DataSetApplication. Do not modify the element TODO : voir comment faire un dataset plugin qui permet d'accéder au dataset uniquement en lecture

Author:

jp.boignard (AKKA Technologies)

See Also:

Serialized Form

Constructor Summary

DataSet()
Default constructor

DataSet(java.lang.String id)
Constructor : return an initialized DataSet, depending of the Id

DataSet(java.lang.String id, java.lang.String name, java.lang.String description)
Full constructor

Method Summary

void	addColumn(Column column) Add a column to DataSet
Column	findByColumnAlias(java.lang.String columnAlias) Gets the column with a header
java.util.List<Column>	getColumnModel() Gets the columnModel value Warning : do not modify the List
java.util.List<Column>	getColumnOrderBy() Get the list of columns "order-by"-ed
DatasetView	getDatasetView() Gets the datasetView value
java.util.List<Property>	getDatasetViewConfig() Gets the datasetViewConfig value
Resource	getDatasource() Gets the DataSource value
java.util.List<Column>	getDefaultColumnVisible() Get the list of default column set to visible
java.lang.String	getDescription() Gets the description value
java.lang.String	getDescriptionHTML() Gets the descriptionHTML value
java.util.List<java.lang.String>	getDictionaryIds() Gets the list of dictionary identifiers involved in a mapping
DictionaryMapping	getDictionaryMapping(java.lang.String dictionaryId) Gets the DictionaryMapping corresponding to the given dictionaryId
java.util.List<DictionaryMapping>	getDictionaryMappings() Gets the dictionaryMappings value
java.lang.Boolean	getDirty() Gets the dirty value
java.util.Date	getExpirationDate() Gets the expirationDate value
java.util.List<Resource>	getExpositions() Gets the expositions value
java.lang.String	getId() Gets the id value
Resource	getImage() Gets the image value
java.lang.String	getName() Gets the name value
int	getNbRecords() Gets the number of results for the DataSet
java.util.List<Predicat>	getPredicat() Gets the predicate value
java.util.List<SitoolsProperty>	getProperties() Gets the properties value
SitoolsProperty	getProperty(java.lang.String propertyName) Get a SitoolsProperty for a given propertyName
java.lang.String	getQueryType() Gets the queryType value
java.lang.String	getSitoolsAttachementForUsers() Gets the sitoolsAttachementForUsers value
java.lang.String	getSqlQuery() Gets the sqlQuery value
java.lang.String	getStatus() Gets the status value
SitoolsStructure	getStructure() Gets the structure value
java.util.List<Structure>	getStructures() Gets the structures value
boolean	isAuthorized() Gets the authorized value
boolean	isVisible() Gets the visible value
void	setAuthorized(boolean authorized) Sets the value of authorized
void	setColumnModel(java.util.List<Column> columnModel) Sets the value of columnModel Warning : do not modify the List
void	setDatasetView(DatasetView datasetView) Sets the value of datasetView
void	setDatasetViewConfig(java.util.List<Property> datasetViewConfig) Sets the value of datasetViewConfig
void	setDatasource(Resource datasource) Sets the value of DataSource
void	setDescription(java.lang.String description) Sets the value of description
void	setDescriptionHTML(java.lang.String descriptionHTML) Sets the value of descriptionHTML
void	setDictionaryMappings(java.util.List<DictionaryMapping> dictionaryMappings) Sets the value of dictionaryMappings
void	setDirty(java.lang.Boolean dirty) Sets the value of dirty
void	setExpirationDate(java.util.Date expirationDate) Sets the value of expirationDate
void	setExpositions(java.util.List<Resource> expositions) Sets the value of expositions
void	setId(java.lang.String id) Sets the value of id
void	setImage(Resource image) Sets the value of image
void	setName(java.lang.String name) Sets the value of name
void	setNbRecords(int nbRecords) Sets the number of results
void	setPredicat(java.util.List<Predicat> predicat) Sets the value of predicate
void	setProperties(java.util.List<SitoolsProperty> properties) Sets the value of properties
void	setQueryType(java.lang.String queryType) Sets the value of queryType
void	setSitoolsAttachementForUsers(java.lang.String sitoolsAttachementForUsers) Sets the value of sitoolsAttachementForUsers
void	setSqlQuery(java.lang.String sqlQuery) Sets the value of sqlQuery
void	setStatus(java.lang.String status) Sets the value of status
void	setStructure(SitoolsStructure structure) Sets the value of structure
void	setStructures(java.util.List<Structure> structures) Sets the value of structures
void	setVisible(boolean visible) Sets the value of visible

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSet

public DataSet(java.lang.String id)

Constructor : return an initialized DataSet, depending of the Id

Parameters:

id - identifier

DataSet

public DataSet(java.lang.String id,
               java.lang.String name,
               java.lang.String description)

Full constructor

Parameters:

id - identifier

name - name

description - description

DataSet

public DataSet()

Default constructor

Method Detail

addColumn

public void addColumn(Column column)

Add a column to DataSet

Parameters:

column - Column

getId

public java.lang.String getId()

Gets the id value

Specified by:

getId in interface IResource

Returns:

the id

setId

public void setId(java.lang.String id)

Sets the value of id

Specified by:

setId in interface IResource

Parameters:

id - the id to set

getName

public java.lang.String getName()

Gets the name value

Specified by:

getName in interface IResource

Returns:

the name

setName

public void setName(java.lang.String name)

Sets the value of name

Parameters:

name - the name to set

getDescription

public java.lang.String getDescription()

Gets the description value

Specified by:

getDescription in interface IResource

Returns:

the description

getNbRecords

public int getNbRecords()

Gets the number of results for the DataSet

Returns:

the number of results

setNbRecords

public void setNbRecords(int nbRecords)

Sets the number of results

Parameters:

nbRecords - number of records

setDescription

public void setDescription(java.lang.String description)

Sets the value of description

Parameters:

description - the description to set

getImage

public Resource getImage()

Gets the image value

Returns:

the image

setImage

public void setImage(Resource image)

Sets the value of image

Parameters:

image - the image to set

getDatasource

public Resource getDatasource()

Gets the DataSource value

Returns:

the DataSource

setDatasource

public void setDatasource(Resource datasource)

Sets the value of DataSource

Parameters:

datasource - the DataSource to set

getStatus

public java.lang.String getStatus()

Gets the status value

Returns:

the status

setStatus

public void setStatus(java.lang.String status)

Sets the value of status

Parameters:

status - the status to set

getExpositions

public java.util.List<Resource> getExpositions()

Gets the expositions value

Returns:

the expositions

setExpositions

public void setExpositions(java.util.List<Resource> expositions)

Sets the value of expositions

Parameters:

expositions - the expositions to set

getSitoolsAttachementForUsers

public java.lang.String getSitoolsAttachementForUsers()

Gets the sitoolsAttachementForUsers value

Returns:

the sitoolsAttachementForUsers

setSitoolsAttachementForUsers

public void setSitoolsAttachementForUsers(java.lang.String sitoolsAttachementForUsers)

Sets the value of sitoolsAttachementForUsers

Parameters:

sitoolsAttachementForUsers - the sitoolsAttachementForUsers to set

getColumnModel

public java.util.List<Column> getColumnModel()

Gets the columnModel value

Warning : do not modify the List

Returns:

the columnModel

setColumnModel

public void setColumnModel(java.util.List<Column> columnModel)

Sets the value of columnModel

Warning : do not modify the List

Parameters:

columnModel - the columnModel to set

getStructures

public java.util.List<Structure> getStructures()

Gets the structures value

Returns:

the structures

setStructures

public void setStructures(java.util.List<Structure> structures)

Sets the value of structures

Parameters:

structures - the structures to set

getQueryType

public java.lang.String getQueryType()

Gets the queryType value

Returns:

the queryType

setQueryType

public void setQueryType(java.lang.String queryType)

Sets the value of queryType

Parameters:

queryType - the queryType to set

getSqlQuery

public java.lang.String getSqlQuery()

Gets the sqlQuery value

Returns:

the sqlQuery

setSqlQuery

public void setSqlQuery(java.lang.String sqlQuery)

Sets the value of sqlQuery

Parameters:

sqlQuery - the sqlQuery to set

getPredicat

public java.util.List<Predicat> getPredicat()

Gets the predicate value

Returns:

the predicate

setPredicat

public void setPredicat(java.util.List<Predicat> predicat)

Sets the value of predicate

Parameters:

predicat - the predicate to set

getExpirationDate

public java.util.Date getExpirationDate()

Gets the expirationDate value

Returns:

the expirationDate

setExpirationDate

public void setExpirationDate(java.util.Date expirationDate)

Sets the value of expirationDate

Parameters:

expirationDate - the expirationDate to set

setDescriptionHTML

public void setDescriptionHTML(java.lang.String descriptionHTML)

Sets the value of descriptionHTML

Parameters:

descriptionHTML - the descriptionHTML to set

getDescriptionHTML

public java.lang.String getDescriptionHTML()

Gets the descriptionHTML value

Returns:

the descriptionHTML

isVisible

public boolean isVisible()

Gets the visible value

Returns:

the visible

setVisible

public void setVisible(boolean visible)

Sets the value of visible

Parameters:

visible - the visible to set

isAuthorized

public boolean isAuthorized()

Gets the authorized value

Returns:

the authorized

setAuthorized

public void setAuthorized(boolean authorized)

Sets the value of authorized

Parameters:

authorized - the authorized to set

getDirty

public java.lang.Boolean getDirty()

Gets the dirty value

Returns:

the dirty

setDirty

public void setDirty(java.lang.Boolean dirty)

Sets the value of dirty

Parameters:

dirty - the dirty to set

getStructure

public SitoolsStructure getStructure()

Gets the structure value

Returns:

the structure

setStructure

public void setStructure(SitoolsStructure structure)

Sets the value of structure

Parameters:

structure - the structure to set

getDatasetView

public DatasetView getDatasetView()

Gets the datasetView value

Returns:

the datasetView

setDatasetView

public void setDatasetView(DatasetView datasetView)

Sets the value of datasetView

Parameters:

datasetView - the datasetView to set

findByColumnAlias

public Column findByColumnAlias(java.lang.String columnAlias)

Gets the column with a header

Parameters:

columnAlias - the columnAlias looked at

Returns:

Column

getDefaultColumnVisible

public java.util.List<Column> getDefaultColumnVisible()

Get the list of default column set to visible

Returns:

List a list of column

getColumnOrderBy

public java.util.List<Column> getColumnOrderBy()

Get the list of columns "order-by"-ed

Returns:

the list of columns where the order by is defined

setDictionaryMappings

public void setDictionaryMappings(java.util.List<DictionaryMapping> dictionaryMappings)

Sets the value of dictionaryMappings

Parameters:

dictionaryMappings - the dictionaryMappings to set

getDictionaryMappings

public java.util.List<DictionaryMapping> getDictionaryMappings()

Gets the dictionaryMappings value

Returns:

the dictionaryMappings

getDictionaryIds

public java.util.List<java.lang.String> getDictionaryIds()

Gets the list of dictionary identifiers involved in a mapping

Returns:

the list of dictionary identifiers

getDictionaryMapping

public DictionaryMapping getDictionaryMapping(java.lang.String dictionaryId)

Gets the DictionaryMapping corresponding to the given dictionaryId

Parameters:

dictionaryId - the id of the dictionary

Returns:

the DictionaryMapping corresponding to the given dictionaryId

getProperties

public java.util.List<SitoolsProperty> getProperties()

Gets the properties value

Returns:

the properties

setProperties

public void setProperties(java.util.List<SitoolsProperty> properties)

Sets the value of properties

Parameters:

properties - the properties to set

getProperty

public SitoolsProperty getProperty(java.lang.String propertyName)

Get a SitoolsProperty for a given propertyName

Parameters:

propertyName - the name of the property

Returns:

the DataSetProperty with the given name or null if it is not found

getDatasetViewConfig

public java.util.List<Property> getDatasetViewConfig()

Gets the datasetViewConfig value

Returns:

the datasetViewConfig

setDatasetViewConfig

public void setDatasetViewConfig(java.util.List<Property> datasetViewConfig)

Sets the value of datasetViewConfig

Parameters:

datasetViewConfig - the datasetViewConfig to set