com.haulmont.cuba.gui.data.impl

Class DatasourceImpl<T extends Entity>

java.lang.Object

com.haulmont.cuba.gui.data.impl.AbstractDatasource<T>

com.haulmont.cuba.gui.data.impl.DatasourceImpl<T>

Type Parameters:

T -

All Implemented Interfaces:

Datasource<T>, DatasourceImplementation<T>

Direct Known Subclasses:

AbstractCollectionDatasource, EntityDiffDatasource

public class DatasourceImpl<T extends Entity>
extends AbstractDatasource<T>
implements DatasourceImplementation<T>

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.data.impl.AbstractDatasource

AbstractDatasource.ItemListener

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.data.Datasource

Datasource.CommitMode, Datasource.ItemChangeEvent<T extends Entity>, Datasource.ItemChangeListener<T extends Entity>, Datasource.ItemPropertyChangeEvent<T extends Entity>, Datasource.ItemPropertyChangeListener<T extends Entity>, Datasource.State, Datasource.StateChangeEvent<T extends Entity>, Datasource.StateChangeListener<T extends Entity>

Field Summary

Fields

Modifier and Type	Field and Description
protected DataSupplier	dataSupplier
protected DsContext	dsContext
protected T	item
protected MetaClass	metaClass
protected Datasource.State	state
protected View	view

Fields inherited from class com.haulmont.cuba.gui.data.impl.AbstractDatasource

allowCommit, backgroundWorker, commitMode, id, itemsToCreate, itemsToDelete, itemsToUpdate, listener, listenersEnabled, loadDynamicAttributes, metadata, modified, parentDs

Constructor Summary

Constructors

Constructor and Description
DatasourceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	__setItem(T item)
void	commit() Performs commit
void	committed(java.util.Set<Entity> entities) Invoked after commit.
DataSupplier	getDataSupplier()
DsContext	getDsContext()
T	getItem()
T	getItemIfValid()
MetaClass	getMetaClass()
Datasource.State	getState()
View	getView()
void	initialized() Moves the datasource to State#INVALID.
void	invalidate() Clears internal data and sets the datasource in Datasource.State.INVALID state.
void	refresh() Refreshes the datasource moving it to the Datasource.State.VALID state
void	setDataSupplier(DataSupplier dataService)
void	setDsContext(DsContext dsContext)
void	setItem(T item) Set current entity in the datasource.
void	setMetaClass(MetaClass metaClass)
void	setup(DsContext dsContext, DataSupplier dataSupplier, java.lang.String id, MetaClass metaClass, View view) Setup the datasource right after creation.
void	setView(java.lang.String viewName)
void	setView(View view)
void	valid() Moves the datasource to State#VALID.

Methods inherited from class com.haulmont.cuba.gui.data.impl.AbstractDatasource

addItemChangeListener, addItemPropertyChangeListener, addParentsToNested, addStateChangeListener, attachListener, clearCommitLists, deleted, detachListener, enableListeners, fireItemChanged, fireStateChanged, getCommitMode, getEventRouter, getId, getItemsToCreate, getItemsToDelete, getItemsToUpdate, getLoadDynamicAttributes, getParent, isAllowCommit, isModified, modified, removeItemChangeListener, removeItemPropertyChangeListener, removeStateChangeListener, setAllowCommit, setCommitMode, setLoadDynamicAttributes, setModified, setParent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.haulmont.cuba.gui.data.impl.DatasourceImplementation

clearCommitLists, deleted, enableListeners, getItemsToCreate, getItemsToDelete, getItemsToUpdate, getParent, modified, setCommitMode, setModified, setParent

Methods inherited from interface com.haulmont.cuba.gui.data.Datasource

addItemChangeListener, addItemPropertyChangeListener, addStateChangeListener, getCommitMode, getId, getLoadDynamicAttributes, isAllowCommit, isModified, removeItemChangeListener, removeItemPropertyChangeListener, removeStateChangeListener, setAllowCommit, setLoadDynamicAttributes

Field Detail

dsContext

protected DsContext dsContext

dataSupplier

protected DataSupplier dataSupplier

metaClass

protected MetaClass metaClass

view

protected View view

state

protected Datasource.State state

item

protected T extends Entity item

Constructor Detail

DatasourceImpl

public DatasourceImpl()

Method Detail

setup

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

Description copied from interface: Datasource

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

Specified by:

setup in interface Datasource<T extends Entity>

Overrides:

setup in class AbstractDatasource<T extends Entity>

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

setView

public void setView(View view)

setView

public void setView(java.lang.String viewName)

getDsContext

public DsContext getDsContext()

Specified by:

getDsContext in interface Datasource<T extends Entity>

Returns:

enclosing DsContext

setDsContext

public void setDsContext(DsContext dsContext)

getDataSupplier

public DataSupplier getDataSupplier()

Specified by:

getDataSupplier in interface Datasource<T extends Entity>

Returns:

a DataSupplier that is used to work with Middleware

setDataSupplier

public void setDataSupplier(DataSupplier dataService)

commit

public void commit()

Description copied from interface: Datasource

Performs commit

Specified by:

commit in interface Datasource<T extends Entity>

getMetaClass

public MetaClass getMetaClass()

Specified by:

getMetaClass in interface Datasource<T extends Entity>

Returns:

MetaClass of an entity contained in the datasource

setMetaClass

public void setMetaClass(MetaClass metaClass)

getView

public View getView()

Specified by:

getView in interface Datasource<T extends Entity>

Returns:

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

getState

public Datasource.State getState()

Specified by:

getState in interface Datasource<T extends Entity>

Returns:

current state

getItem

public T getItem()

Specified by:

getItem in interface Datasource<T extends Entity>

Returns:

current entity contained in the datasource

getItemIfValid

@Nullable
public T getItemIfValid()

Specified by:

getItemIfValid in interface Datasource<T extends Entity>

Returns:

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

refresh

public void refresh()

Description copied from interface: Datasource

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

Specified by:

refresh in interface Datasource<T extends Entity>

setItem

public void setItem(T item)

Description copied from interface: Datasource

Set current entity in the datasource.

Specified by:

setItem in interface Datasource<T extends Entity>

Parameters:

item - entity instance

__setItem

protected void __setItem(T item)

invalidate

public void invalidate()

Description copied from interface: Datasource

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

Specified by:

invalidate in interface Datasource<T extends Entity>

initialized

public void initialized()

Description copied from interface: DatasourceImplementation

Moves the datasource to State#INVALID.

Specified by:

initialized in interface DatasourceImplementation<T extends Entity>

valid

public void valid()

Description copied from interface: DatasourceImplementation

Moves the datasource to State#VALID.

Specified by:

valid in interface DatasourceImplementation<T extends Entity>

committed

public void committed(java.util.Set<Entity> entities)

Description copied from interface: DatasourceImplementation

Invoked after commit.

Specified by:

committed in interface DatasourceImplementation<T extends Entity>

Parameters:

entities - committed entities returned from middleware