com.haulmont.cuba.gui.data.impl

Class AbstractDatasource<T extends Entity>

java.lang.Object

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

All Implemented Interfaces:

Datasource<T>, DatasourceImplementation<T>

Direct Known Subclasses:

DatasourceImpl, EmbeddedDatasourceImpl, PropertyDatasourceImpl, RuntimePropsDatasourceImpl

public abstract class AbstractDatasource<T extends Entity>
extends java.lang.Object
implements Datasource<T>, DatasourceImplementation<T>

Nested Class Summary

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>

Constructor Summary

Constructors

Constructor and Description
AbstractDatasource()

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) Add listener to datasource events.
void	addStateChangeListener(Datasource.StateChangeListener<T> listener)
void	clearCommitLists() Clear new, modified and deleted lists.
void	deleted(T item) Invoked when the given instance is deleted.
boolean	enableListeners(boolean enable) Enables or disables datasource listeners.
Datasource.CommitMode	getCommitMode()
java.lang.String	getId()
java.util.Collection<T>	getItemsToCreate() New instances to be committed.
java.util.Collection<T>	getItemsToDelete() Deleted instances to be committed.
java.util.Collection<T>	getItemsToUpdate() Modified instances to be committed.
boolean	getLoadDynamicAttributes()
Datasource	getParent() Returns parent datasource or null.
boolean	isAllowCommit()
boolean	isModified()
void	modified(T item) Invoked when the given instance is modified.
void	removeItemChangeListener(Datasource.ItemChangeListener<T> listener)
void	removeItemPropertyChangeListener(Datasource.ItemPropertyChangeListener<T> listener)
void	removeListener(DatasourceListener<T> listener) Remove listener to datasource events
void	removeStateChangeListener(Datasource.StateChangeListener<T> listener)
void	setAllowCommit(boolean allowCommit) Switch on/off ability to commit.
void	setCommitMode(Datasource.CommitMode commitMode) Sets commit mode explicitly.
void	setLoadDynamicAttributes(boolean value)
void	setModified(boolean modified) Sets "modified" state.
void	setParent(Datasource datasource) Sets parent datasource.
void	setup(DsContext dsContext, DataSupplier dataSupplier, java.lang.String id, MetaClass metaClass, View view) Setup the datasource right after creation.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

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

committed, initialized, valid

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

commit, getDataSupplier, getDsContext, getItem, getItemIfValid, getMetaClass, getState, getView, invalidate, refresh, setItem

Constructor Detail

AbstractDatasource

public AbstractDatasource()

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>

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

getId

public java.lang.String getId()

Specified by:

getId in interface Datasource<T extends Entity>

Returns:

this datasource ID as defined in XML descriptor

isModified

public boolean isModified()

Specified by:

isModified in interface Datasource<T extends Entity>

Returns:

true if the datasource contains uncommitted changes

setModified

public void setModified(boolean modified)

Description copied from interface: DatasourceImplementation

Sets "modified" state.

Specified by:

setModified in interface DatasourceImplementation<T extends Entity>

isAllowCommit

public boolean isAllowCommit()

Specified by:

isAllowCommit in interface Datasource<T extends Entity>

Returns:

true if this datasource can commit data to the database

setAllowCommit

public void setAllowCommit(boolean allowCommit)

Description copied from interface: Datasource

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

Specified by:

setAllowCommit in interface Datasource<T extends Entity>

getItemsToCreate

public java.util.Collection<T> getItemsToCreate()

Description copied from interface: DatasourceImplementation

New instances to be committed.

Specified by:

getItemsToCreate in interface DatasourceImplementation<T extends Entity>

getItemsToUpdate

public java.util.Collection<T> getItemsToUpdate()

Description copied from interface: DatasourceImplementation

Modified instances to be committed.

Specified by:

getItemsToUpdate in interface DatasourceImplementation<T extends Entity>

getItemsToDelete

public java.util.Collection<T> getItemsToDelete()

Description copied from interface: DatasourceImplementation

Deleted instances to be committed.

Specified by:

getItemsToDelete in interface DatasourceImplementation<T extends Entity>

modified

public void modified(T item)

Description copied from interface: DatasourceImplementation

Invoked when the given instance is modified.

Specified by:

modified in interface DatasourceImplementation<T extends Entity>

deleted

public void deleted(T item)

Description copied from interface: DatasourceImplementation

Invoked when the given instance is deleted.

Specified by:

deleted in interface DatasourceImplementation<T extends Entity>

enableListeners

public boolean enableListeners(boolean enable)

Description copied from interface: DatasourceImplementation

Enables or disables datasource listeners.

Specified by:

enableListeners in interface DatasourceImplementation<T extends Entity>

Parameters:

enable - true to enable, false to disable

Returns:

previous state

getCommitMode

public Datasource.CommitMode getCommitMode()

Specified by:

getCommitMode in interface Datasource<T extends Entity>

Returns:

where to commit changes

setCommitMode

public void setCommitMode(Datasource.CommitMode commitMode)

Description copied from interface: DatasourceImplementation

Sets commit mode explicitly. Usually commit mode is defined by the presence of a parent datasource.

Specified by:

setCommitMode in interface DatasourceImplementation<T extends Entity>

See Also:

DatasourceImplementation.setParent(Datasource)

getParent

public Datasource getParent()

Description copied from interface: DatasourceImplementation

Returns parent datasource or null.

If a parent datasource is set, it will receive changed data from the current datasource on commit. Otherwise, the datasource commits to the database.

Specified by:

getParent in interface DatasourceImplementation<T extends Entity>

setParent

public void setParent(Datasource datasource)

Description copied from interface: DatasourceImplementation

Sets parent datasource.

If a parent datasource is set, it will receive changed data from the current datasource on commit. Otherwise, the datasource commits to the database.

Specified by:

setParent in interface DatasourceImplementation<T extends Entity>

addListener

public void addListener(DatasourceListener<T> listener)

Description copied from interface: Datasource

Add listener to datasource events.

Specified by:

addListener in interface Datasource<T extends Entity>

removeListener

public void removeListener(DatasourceListener<T> listener)

Description copied from interface: Datasource

Remove listener to datasource events

Specified by:

removeListener in interface Datasource<T extends Entity>

addItemChangeListener

public void addItemChangeListener(Datasource.ItemChangeListener<T> listener)

Specified by:

addItemChangeListener in interface Datasource<T extends Entity>

removeItemChangeListener

public void removeItemChangeListener(Datasource.ItemChangeListener<T> listener)

Specified by:

removeItemChangeListener in interface Datasource<T extends Entity>

addItemPropertyChangeListener

public void addItemPropertyChangeListener(Datasource.ItemPropertyChangeListener<T> listener)

Specified by:

addItemPropertyChangeListener in interface Datasource<T extends Entity>

removeItemPropertyChangeListener

public void removeItemPropertyChangeListener(Datasource.ItemPropertyChangeListener<T> listener)

Specified by:

removeItemPropertyChangeListener in interface Datasource<T extends Entity>

addStateChangeListener

public void addStateChangeListener(Datasource.StateChangeListener<T> listener)

Specified by:

addStateChangeListener in interface Datasource<T extends Entity>

removeStateChangeListener

public void removeStateChangeListener(Datasource.StateChangeListener<T> listener)

Specified by:

removeStateChangeListener in interface Datasource<T extends Entity>

clearCommitLists

public void clearCommitLists()

Description copied from interface: DatasourceImplementation

Clear new, modified and deleted lists.

Specified by:

clearCommitLists in interface DatasourceImplementation<T extends Entity>

getLoadDynamicAttributes

public boolean getLoadDynamicAttributes()

Specified by:

getLoadDynamicAttributes in interface Datasource<T extends Entity>

Returns:

whether to load dynamic attributes

setLoadDynamicAttributes

public void setLoadDynamicAttributes(boolean value)

Specified by:

setLoadDynamicAttributes in interface Datasource<T extends Entity>

Parameters:

value - whether to load dynamic attributes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object