com.haulmont.cuba.gui.data.impl

Class DsContextImpl

java.lang.Object

com.haulmont.cuba.gui.data.impl.DsContextImpl

All Implemented Interfaces:

DsContext, DsContextImplementation

public class DsContextImpl
extends java.lang.Object
implements DsContextImplementation

Nested Class Summary

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

DsContextImplementation.LazyTask

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

DsContext.AfterCommitListener, DsContext.BeforeCommitListener, DsContext.CommitListener, DsContext.CommitListenerAdapter

Constructor Summary

Constructors

Constructor and Description
DsContextImpl(DataSupplier dataservice)

Method Summary

Modifier and Type	Method and Description
void	addAfterCommitListener(DsContext.AfterCommitListener listener)
void	addBeforeCommitListener(DsContext.BeforeCommitListener listener)
void	addLazyTask(DsContextImplementation.LazyTask lazyTask)
void	addListener(DsContext.CommitListener listener) Add commit events listener.
boolean	commit() Commit all changed datasources.
void	executeLazyTasks()
void	fireAfterCommit(CommitContext context, java.util.Set<Entity> committedEntities)
void	fireBeforeCommit(CommitContext context)
Datasource	get(java.lang.String id) Get datasource by name.
java.util.Collection<Datasource>	getAll()
java.util.List<DsContext>	getChildren()
DataSupplier	getDataSupplier()
FrameContext	getFrameContext()
Datasource	getNN(java.lang.String name) Get datasource by name.
DsContext	getParent()
boolean	isDiscardCommitted() Indicates that the DsContext will be discarded right after commit hence it doesn't need committed instances.
boolean	isModified()
void	refresh() Refresh all datasources.
void	register(Datasource datasource)
void	registerDependency(Datasource datasource, Datasource dependFrom, java.lang.String propertyName) Register dependency between datasources.
void	registerListener(ParameterInfo item, Datasource datasource)
void	removeAfterCommitListener(DsContext.AfterCommitListener listener)
void	removeBeforeCommitListener(DsContext.BeforeCommitListener listener)
void	removeListener(DsContext.CommitListener listener) Remove commit events listener.
void	resumeSuspended()
void	setDiscardCommitted(boolean discardCommitted) Set to true if the DsContext will be discarded right after commit hence it doesn't need committed instances.
void	setFrameContext(FrameContext windowContext)
void	setParent(DsContext parent)
void	unregister(Datasource datasource)

Methods inherited from class java.lang.Object

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

Constructor Detail

DsContextImpl

public DsContextImpl(DataSupplier dataservice)

Method Detail

addLazyTask

public void addLazyTask(DsContextImplementation.LazyTask lazyTask)

Specified by:

addLazyTask in interface DsContextImplementation

executeLazyTasks

public void executeLazyTasks()

Specified by:

executeLazyTasks in interface DsContextImplementation

resumeSuspended

public void resumeSuspended()

Specified by:

resumeSuspended in interface DsContextImplementation

getFrameContext

public FrameContext getFrameContext()

Specified by:

getFrameContext in interface DsContext

Returns:

context of a frame that owns this DsContext. If the DsContext belongs to Window, its WindowContext is returned.

setFrameContext

public void setFrameContext(FrameContext windowContext)

Specified by:

setFrameContext in interface DsContext

commit

public boolean commit()

Description copied from interface: DsContext

Commit all changed datasources.

Specified by:

commit in interface DsContext

Returns:

true if there were changes and commit has been done

isDiscardCommitted

public boolean isDiscardCommitted()

Description copied from interface: DsContext

Indicates that the DsContext will be discarded right after commit hence it doesn't need committed instances.

Specified by:

isDiscardCommitted in interface DsContext

setDiscardCommitted

public void setDiscardCommitted(boolean discardCommitted)

Description copied from interface: DsContext

Set to true if the DsContext will be discarded right after commit hence it doesn't need committed instances.

Specified by:

setDiscardCommitted in interface DsContext

fireBeforeCommit

public void fireBeforeCommit(CommitContext context)

Specified by:

fireBeforeCommit in interface DsContextImplementation

fireAfterCommit

public void fireAfterCommit(CommitContext context,
                            java.util.Set<Entity> committedEntities)

Specified by:

fireAfterCommit in interface DsContextImplementation

registerDependency

public void registerDependency(Datasource datasource,
                               Datasource dependFrom,
                               java.lang.String propertyName)

Description copied from interface: DsContext

Register dependency between datasources.
Dependent datasource is refreshed if one of the following events occurs on master datasource:

• itemChanged
• collectionChanged with Operation.REFRESH
• valueChanged with the specified property

Specified by:

registerDependency in interface DsContext

Parameters:

datasource - dependent datasource

dependFrom - master datasource

propertyName - property of master datasource. If specified, the dependent datasource will be refreshed also on this property value change

addListener

public void addListener(DsContext.CommitListener listener)

Description copied from interface: DsContext

Add commit events listener.

Specified by:

addListener in interface DsContext

removeListener

public void removeListener(DsContext.CommitListener listener)

Description copied from interface: DsContext

Remove commit events listener.

Specified by:

removeListener in interface DsContext

addBeforeCommitListener

public void addBeforeCommitListener(DsContext.BeforeCommitListener listener)

Specified by:

addBeforeCommitListener in interface DsContext

removeBeforeCommitListener

public void removeBeforeCommitListener(DsContext.BeforeCommitListener listener)

Specified by:

removeBeforeCommitListener in interface DsContext

addAfterCommitListener

public void addAfterCommitListener(DsContext.AfterCommitListener listener)

Specified by:

addAfterCommitListener in interface DsContext

removeAfterCommitListener

public void removeAfterCommitListener(DsContext.AfterCommitListener listener)

Specified by:

removeAfterCommitListener in interface DsContext

getDataSupplier

public DataSupplier getDataSupplier()

Specified by:

getDataSupplier in interface DsContext

Returns:

a reference to DataSupplier

get

public Datasource get(java.lang.String id)

Description copied from interface: DsContext

Get datasource by name. Name may contain path to a datasource in nested frame e.g. someFrameId.someDatasourceId

Specified by:

get in interface DsContext

Parameters:

id - datasource name

Returns:

datasource instance or null if not found

getNN

public Datasource getNN(java.lang.String name)

Description copied from interface: DsContext

Get datasource by name. Name may contain path to a datasource in nested frame e.g. someFrameId.someDatasourceId.

Never returns null.

Specified by:

getNN in interface DsContext

Parameters:

name - datasource name

Returns:

datasource instance

getAll

public java.util.Collection<Datasource> getAll()

Specified by:

getAll in interface DsContext

Returns:

all datasources contained in this context

isModified

public boolean isModified()

Specified by:

isModified in interface DsContext

Returns:

true if any contained datasource is modified

refresh

public void refresh()

Description copied from interface: DsContext

Refresh all datasources.

Specified by:

refresh in interface DsContext

register

public void register(Datasource datasource)

Specified by:

register in interface DsContextImplementation

unregister

public void unregister(Datasource datasource)

Specified by:

unregister in interface DsContextImplementation

registerListener

public void registerListener(ParameterInfo item,
                             Datasource datasource)

Specified by:

registerListener in interface DsContextImplementation

getParent

public DsContext getParent()

Specified by:

getParent in interface DsContext

Returns:

a parent DsContext if this DsContext is defined in a frame

setParent

public void setParent(DsContext parent)

Specified by:

setParent in interface DsContextImplementation

getChildren

public java.util.List<DsContext> getChildren()

Specified by:

getChildren in interface DsContext

Returns:

list of DsContext's of frames included in the current screen, if any