com.haulmont.cuba.gui.data

Interface Datasource<T extends Entity>

Type Parameters:

T - type of entity this datasource is working with

All Known Subinterfaces:

CollectionDatasource<T,K>, CollectionDatasource.Aggregatable<T,K>, CollectionDatasource.Indexed<T,K>, CollectionDatasource.Lazy<T,K>, CollectionDatasource.Ordered<T,K>, CollectionDatasource.Sortable<T,K>, CollectionDatasource.SupportsApplyToSelected<T,K>, CollectionDatasource.SupportsPaging<T,K>, CollectionDatasource.SupportsRefreshMode<T,K>, CollectionDatasource.Suspendable<T,K>, DatasourceImplementation<T>, EmbeddedDatasource<T>, GroupDatasource<T,K>, HierarchicalDatasource<T,K>, NestedDatasource<T>, PropertyDatasource<T>, RuntimePropsDatasource<T>, TreeTableDatasource<T,K>

All Known Implementing Classes:

AbstractCollectionDatasource, AbstractDatasource, AbstractTreeDatasource, AbstractTreeTableDatasource, AppPropertiesDatasource, BasicPermissionTreeDatasource, CollectionDatasourceImpl, CollectionPropertyDatasourceImpl, ConditionDescriptorsDs, ConditionsDs, CustomCollectionDatasource, CustomGroupDatasource, CustomHierarchicalDatasource, CustomValueCollectionDatasource, CustomValueGroupDatasource, CustomValueHierarchicalDatasource, DatasourceImpl, DiffTreeDatasource, EmbeddedDatasourceImpl, EntityDiffDatasource, EntityParamsDatasource, EntityPermissionTargetsDatasource, EntitySnapshotsDatasource, GroupDatasourceImpl, GroupPropertyDatasourceImpl, HierarchicalDatasourceImpl, HierarchicalPropertyDatasourceImpl, JmxInstancesDatasource, ManagedBeanAttributeDatasource, ManagedBeanInfoDatasource, MultiplePermissionTargetsDatasource, PropertyDatasourceImpl, RestorablePermissionDatasource, RuntimePropsDatasourceImpl, ScreenComponentsTreeDatasource, ScreenHistoryDatasource, ScreenPermissionTreeDatasource, ScreenProfilerDatasourse, SpecificPermissionTreeDatasource, StatisticsDatasource, ThreadsDatasource, UiPermissionsDatasource, UserSessionsDatasource, ValueCollectionDatasourceImpl, ValueGroupDatasourceImpl, ValueHierarchicalDatasourceImpl

public interface Datasource<T extends Entity>

Root of datasources abstraction layer. Contains one entity instance.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Datasource.CommitMode Where to commit changes
static class	Datasource.ItemChangeEvent<T extends Entity>
static interface	Datasource.ItemChangeListener<T extends Entity> Listener to datasource item change events.
static class	Datasource.ItemPropertyChangeEvent<T extends Entity>
static interface	Datasource.ItemPropertyChangeListener<T extends Entity> Listener to datasource item property value change events.
static class	Datasource.State Possible states of datasource: Datasource.State.NOT_INITIALIZED, Datasource.State.INVALID, Datasource.State.VALID
static class	Datasource.StateChangeEvent<T extends Entity>
static interface	Datasource.StateChangeListener<T extends Entity> Listener to datasource state change events.

Method Summary

Modifier and Type	Method and Description
void	addItemChangeListener(Datasource.ItemChangeListener<T> listener)
void	addItemPropertyChangeListener(Datasource.ItemPropertyChangeListener<T> listener)
void	addListener(DatasourceListener<T> listener) Deprecated. See new methods addItemChangeListener(ItemChangeListener) addItemPropertyChangeListener(ItemPropertyChangeListener) addStateChangeListener(StateChangeListener) CollectionDatasource.addCollectionChangeListener(CollectionDatasource.CollectionChangeListener)
void	addStateChangeListener(Datasource.StateChangeListener<T> listener)
void	commit() Performs commit
Datasource.CommitMode	getCommitMode()
DataSupplier	getDataSupplier()
DsContext	getDsContext()
java.lang.String	getId()
T	getItem()
T	getItemIfValid()
boolean	getLoadDynamicAttributes()
MetaClass	getMetaClass()
Datasource.State	getState()
View	getView()
void	invalidate() Clears internal data and sets the datasource in Datasource.State.INVALID state.
boolean	isAllowCommit()
boolean	isModified()
void	refresh() Refreshes the datasource moving it to the Datasource.State.VALID state
void	removeItemChangeListener(Datasource.ItemChangeListener<T> listener)
void	removeItemPropertyChangeListener(Datasource.ItemPropertyChangeListener<T> listener)
void	removeListener(DatasourceListener<T> listener) Deprecated.
void	removeStateChangeListener(Datasource.StateChangeListener<T> listener)
void	setAllowCommit(boolean allowCommit) Switch on/off ability to commit.
void	setItem(T item) Set current entity in the datasource.
void	setLoadDynamicAttributes(boolean value)
void	setup(DsContext dsContext, DataSupplier dataSupplier, java.lang.String id, MetaClass metaClass, View view) Setup the datasource right after creation.

Method Detail

setup

void setup(DsContext dsContext,
           DataSupplier dataSupplier,
           java.lang.String id,
           MetaClass metaClass,
           @Nullable
           View view)
    throws java.lang.UnsupportedOperationException

Setup the datasource right after creation. This method should be called only once.

Parameters:

dsContext - DsContext instance

dataSupplier - DataSupplier instance

id - datasource ID

metaClass - MetaClass of an entity that will be stored in this datasource

view - a view that will be used to load entities form DB, can be null

Throws:

java.lang.UnsupportedOperationException - if an implementation doesn't support this method. This is the case for example for NestedDatasource implementors, that have their own setup method.

getId

java.lang.String getId()

Returns:

this datasource ID as defined in XML descriptor

getDsContext

DsContext getDsContext()

Returns:

enclosing DsContext

getDataSupplier

DataSupplier getDataSupplier()

Returns:

a DataSupplier that is used to work with Middleware

isModified

boolean isModified()

Returns:

true if the datasource contains uncommitted changes

isAllowCommit

boolean isAllowCommit()

Returns:

true if this datasource can commit data to the database

setAllowCommit

void setAllowCommit(boolean allowCommit)

Switch on/off ability to commit. If disabled, isModified() always returns false and commit() has no effect.

getCommitMode

Datasource.CommitMode getCommitMode()

Returns:

where to commit changes

commit

void commit()

Performs commit

getState

Datasource.State getState()

Returns:

current state

getItem

T getItem()

Returns:

current entity contained in the datasource

getItemIfValid

@Nullable
T getItemIfValid()

Returns:

current entity contained in the datasource or null if state is not VALID

setItem

void setItem(@Nullable
             T item)

Set current entity in the datasource.

Parameters:

item - entity instance

invalidate

void invalidate()

Clears internal data and sets the datasource in Datasource.State.INVALID state. In Datasource.State.NOT_INITIALIZED does nothing.

refresh

void refresh()

Refreshes the datasource moving it to the Datasource.State.VALID state

getMetaClass

MetaClass getMetaClass()

Returns:

MetaClass of an entity contained in the datasource

getView

@Nullable
View getView()

Returns:

View that is used to load entities form DB, can be null

addListener

@Deprecated
void addListener(DatasourceListener<T> listener)

Deprecated. See new methods
addItemChangeListener(ItemChangeListener)
addItemPropertyChangeListener(ItemPropertyChangeListener)
addStateChangeListener(StateChangeListener)
CollectionDatasource.addCollectionChangeListener(CollectionDatasource.CollectionChangeListener)

Add listener to datasource events.

removeListener

@Deprecated
void removeListener(DatasourceListener<T> listener)

Deprecated.

Remove listener to datasource events

addItemChangeListener

void addItemChangeListener(Datasource.ItemChangeListener<T> listener)

removeItemChangeListener

void removeItemChangeListener(Datasource.ItemChangeListener<T> listener)

addStateChangeListener

void addStateChangeListener(Datasource.StateChangeListener<T> listener)

removeStateChangeListener

void removeStateChangeListener(Datasource.StateChangeListener<T> listener)

addItemPropertyChangeListener

void addItemPropertyChangeListener(Datasource.ItemPropertyChangeListener<T> listener)

removeItemPropertyChangeListener

void removeItemPropertyChangeListener(Datasource.ItemPropertyChangeListener<T> listener)

getLoadDynamicAttributes

boolean getLoadDynamicAttributes()

Returns:

whether to load dynamic attributes

setLoadDynamicAttributes

void setLoadDynamicAttributes(boolean value)

Parameters:

value - whether to load dynamic attributes