com.haulmont.cuba.gui.data.impl

Class RuntimePropsDatasourceImpl

java.lang.Object

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

com.haulmont.cuba.gui.data.impl.RuntimePropsDatasourceImpl

All Implemented Interfaces:

Datasource<DynamicAttributesEntity>, DatasourceImplementation<DynamicAttributesEntity>, RuntimePropsDatasource<DynamicAttributesEntity>

public class RuntimePropsDatasourceImpl
extends AbstractDatasource<DynamicAttributesEntity>
implements RuntimePropsDatasource<DynamicAttributesEntity>

Specific datasource for dynamic attributes. It will be initialized only when main datasource will be valid.

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
RuntimePropsDatasourceImpl(DsContext dsContext, DataSupplier dataSupplier, java.lang.String id, java.lang.String mainDsId, MetaClass categorizedEntityClass)

Method Summary

Modifier and Type	Method and Description
void	commit() Performs commit
void	committed(java.util.Set<Entity> entities) Invoked after commit.
DataSupplier	getDataSupplier()
Category	getDefaultCategory()
DsContext	getDsContext()
DynamicAttributesEntity	getItem()
DynamicAttributesEntity	getItemIfValid()
Datasource	getMainDs()
MetaClass	getMetaClass()
java.util.Collection<DynamicAttributesMetaProperty>	getPropertiesFilteredByCategory()
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
MetaClass	resolveCategorizedEntityClass()
void	setItem(DynamicAttributesEntity item) Set current entity in the datasource.
void	setup(DsContext dsContext, DataSupplier dataSupplier, java.lang.String id, MetaClass metaClass, View view) Setup the datasource right after creation.
void	valid() Moves the datasource to State#VALID.

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

addItemChangeListener, addItemPropertyChangeListener, addListener, addStateChangeListener, clearCommitLists, deleted, enableListeners, getCommitMode, getId, getItemsToCreate, getItemsToDelete, getItemsToUpdate, getLoadDynamicAttributes, getParent, isAllowCommit, isModified, modified, removeItemChangeListener, removeItemPropertyChangeListener, removeListener, removeStateChangeListener, setAllowCommit, setCommitMode, setLoadDynamicAttributes, setModified, setParent, 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.Datasource

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

Constructor Detail

RuntimePropsDatasourceImpl

public RuntimePropsDatasourceImpl(DsContext dsContext,
                                  DataSupplier dataSupplier,
                                  java.lang.String id,
                                  java.lang.String mainDsId,
                                  @Nullable
                                  MetaClass categorizedEntityClass)

Method Detail

setup

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

Description copied from interface: Datasource

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

Specified by:

setup in interface Datasource<DynamicAttributesEntity>

Overrides:

setup in class AbstractDatasource<DynamicAttributesEntity>

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.

resolveCategorizedEntityClass

public MetaClass resolveCategorizedEntityClass()

Specified by:

resolveCategorizedEntityClass in interface RuntimePropsDatasource<DynamicAttributesEntity>

getDsContext

public DsContext getDsContext()

Specified by:

getDsContext in interface Datasource<DynamicAttributesEntity>

Returns:

enclosing DsContext

getDataSupplier

public DataSupplier getDataSupplier()

Specified by:

getDataSupplier in interface Datasource<DynamicAttributesEntity>

Returns:

a DataSupplier that is used to work with Middleware

commit

public void commit()

Description copied from interface: Datasource

Performs commit

Specified by:

commit in interface Datasource<DynamicAttributesEntity>

getState

public Datasource.State getState()

Specified by:

getState in interface Datasource<DynamicAttributesEntity>

Returns:

current state

getItem

public DynamicAttributesEntity getItem()

Specified by:

getItem in interface Datasource<DynamicAttributesEntity>

Returns:

current entity contained in the datasource

getItemIfValid

@Nullable
public DynamicAttributesEntity getItemIfValid()

Specified by:

getItemIfValid in interface Datasource<DynamicAttributesEntity>

Returns:

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

setItem

public void setItem(DynamicAttributesEntity item)

Description copied from interface: Datasource

Set current entity in the datasource.

Specified by:

setItem in interface Datasource<DynamicAttributesEntity>

Parameters:

item - entity instance

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<DynamicAttributesEntity>

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<DynamicAttributesEntity>

getMetaClass

public MetaClass getMetaClass()

Specified by:

getMetaClass in interface Datasource<DynamicAttributesEntity>

Returns:

MetaClass of an entity contained in the datasource

getView

public View getView()

Specified by:

getView in interface Datasource<DynamicAttributesEntity>

Returns:

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

initialized

public void initialized()

Description copied from interface: DatasourceImplementation

Moves the datasource to State#INVALID.

Specified by:

initialized in interface DatasourceImplementation<DynamicAttributesEntity>

valid

public void valid()

Description copied from interface: DatasourceImplementation

Moves the datasource to State#VALID.

Specified by:

valid in interface DatasourceImplementation<DynamicAttributesEntity>

committed

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

Description copied from interface: DatasourceImplementation

Invoked after commit.

Specified by:

committed in interface DatasourceImplementation<DynamicAttributesEntity>

Parameters:

entities - committed entities returned from middleware

getMainDs

public Datasource getMainDs()

Specified by:

getMainDs in interface RuntimePropsDatasource<DynamicAttributesEntity>

getPropertiesFilteredByCategory

public java.util.Collection<DynamicAttributesMetaProperty> getPropertiesFilteredByCategory()

Specified by:

getPropertiesFilteredByCategory in interface RuntimePropsDatasource<DynamicAttributesEntity>

getDefaultCategory

@Nullable
public Category getDefaultCategory()