com.haulmont.cuba.gui.data

Class DsBuilder

java.lang.Object

com.haulmont.cuba.gui.data.DsBuilder

@Component(value="cuba_DsBuilder")
 @Scope(value="prototype")
public class DsBuilder
extends java.lang.Object

Datasources builder.

Use setters to provide parameters and then invoke one of the build* methods to obtain the datasource implementation.

Sample usage:

 CollectionDatasource usersDs = DsBuilder.create(getDsContext())
               .setMetaClass(metaClass)
               .setId("usersDs")
               .setViewName(View.MINIMAL)
               .buildCollectionDatasource();

If you set master and property properties you will get a PropertyDatasource implementation.

In order to provide your own implementations of standard datasources, create a subclass, override corresponding createXYZDatasource() methods and register the subclass in spring.xml, for example:

     <bean id="cuba_DsBuilder" class="com.company.sample.gui.MyDsBuilder" scope="prototype"/>
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
DsBuilder() INTERNAL
DsBuilder(DsContext dsContext) INTERNAL

Method Summary

Modifier and Type	Method and Description
CollectionDatasource	buildCollectionDatasource() Build a CollectionDatasource with the standard implementation.
<T> T	buildCollectionDatasource(java.lang.Class<T> datasourceClass) Build a CollectionDatasource with the specified implementation class.
Datasource	buildDatasource()
GroupDatasource	buildGroupDatasource() Build a GroupDatasource with the standard implementation.
<T> T	buildGroupDatasource(java.lang.Class<T> datasourceClass) Build a GroupDatasource with the specified implementation class.
HierarchicalDatasource	buildHierarchicalDatasource() Build a HierarchicalDatasource with the standard implementation.
<T> T	buildHierarchicalDatasource(java.lang.Class<T> datasourceClass) Build a HierarchicalDatasource with the specified implementation class.
RuntimePropsDatasource	buildRuntimePropsDatasource(java.lang.String mainDsId, MetaClass categorizedEntityClass)
ValueCollectionDatasourceImpl	buildValuesCollectionDatasource() Build a ValueCollectionDatasourceImpl with the standard implementation.
<T> T	buildValuesCollectionDatasource(java.lang.Class<T> datasourceClass) Build a ValueCollectionDatasourceImpl with the specified implementation class.
ValueGroupDatasourceImpl	buildValuesGroupDatasource() Build a ValueGroupDatasourceImpl with the standard implementation.
<T> T	buildValuesGroupDatasource(java.lang.Class<T> datasourceClass) Build a ValueGroupDatasourceImpl with the specified implementation class.
ValueHierarchicalDatasourceImpl	buildValuesHierarchicalDatasource() Build a ValueHierarchicalDatasourceImpl with the standard implementation.
<T> T	buildValuesHierarchicalDatasource(java.lang.Class<T> datasourceClass) Build a ValueHierarchicalDatasourceImpl with the specified implementation class.
static DsBuilder	create() Creates DsBuilder for building datasources not belonging to a DsContext.
static DsBuilder	create(DsContext dsContext) Creates DsBuilder for building datasources for the given DsContext.
protected CollectionDatasource	createCollectionDatasource()
protected CollectionDatasource	createCollectionPropertyDatasource()
protected Datasource	createDatasource()
protected NestedDatasource	createEmbeddedDatasource()
protected GroupDatasource	createGroupDatasource()
protected GroupDatasource	createGroupPropertyDatasource()
protected HierarchicalDatasource	createHierarchicalDatasource()
protected HierarchicalDatasource	createHierarchicalPropertyDatasource()
protected NestedDatasource	createPropertyDatasource()
protected ValueCollectionDatasourceImpl	createValueCollectionDatasource()
protected ValueGroupDatasourceImpl	createValueGroupDatasource()
protected ValueHierarchicalDatasourceImpl	createValueHierarchicalDatasource()
DataSupplier	getDataSupplier()
java.lang.Class<?>	getDsClass()
DsContext	getDsContext()
java.lang.String	getId()
java.lang.Class	getJavaClass()
Datasource	getMaster()
int	getMaxResults()
MetaClass	getMetaClass()
protected Metadata	getMetadata()
protected PersistenceManagerService	getPersistenceManager()
java.lang.String	getProperty()
CollectionDatasource.RefreshMode	getRefreshMode()
View	getView()
java.lang.String	getViewName()
protected ViewRepository	getViewRepository()
protected void	init()
boolean	isAllowCommit()
boolean	isCacheable()
boolean	isSoftDeletion()
DsBuilder	reset()
DsBuilder	setAllowCommit(boolean allowCommit)
DsBuilder	setCacheable(boolean cacheable)
DsBuilder	setDataSupplier(DataSupplier dataSupplier)
DsBuilder	setDsClass(java.lang.Class<?> dsClass) Set datasource implementation class.
DsBuilder	setId(java.lang.String id)
DsBuilder	setJavaClass(java.lang.Class javaClass)
DsBuilder	setMaster(Datasource master)
DsBuilder	setMaxResults(int maxResults)
DsBuilder	setMetaClass(MetaClass metaClass)
DsBuilder	setProperty(java.lang.String property)
DsBuilder	setRefreshMode(CollectionDatasource.RefreshMode refreshMode)
DsBuilder	setSoftDeletion(boolean softDeletion)
DsBuilder	setView(View view)
DsBuilder	setViewName(java.lang.String viewName)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

DsBuilder

public DsBuilder()

INTERNAL

DsBuilder

public DsBuilder(@Nullable
                 DsContext dsContext)

INTERNAL

Method Detail

create

public static DsBuilder create()

Creates DsBuilder for building datasources not belonging to a DsContext.

create

public static DsBuilder create(@Nullable
                               DsContext dsContext)

Creates DsBuilder for building datasources for the given DsContext.

Parameters:

dsContext - context instance or null

createDatasource

protected Datasource createDatasource()

createPropertyDatasource

protected NestedDatasource createPropertyDatasource()

createEmbeddedDatasource

protected NestedDatasource createEmbeddedDatasource()

createCollectionDatasource

protected CollectionDatasource createCollectionDatasource()

createCollectionPropertyDatasource

protected CollectionDatasource createCollectionPropertyDatasource()

createGroupDatasource

protected GroupDatasource createGroupDatasource()

createGroupPropertyDatasource

protected GroupDatasource createGroupPropertyDatasource()

createHierarchicalDatasource

protected HierarchicalDatasource createHierarchicalDatasource()

createHierarchicalPropertyDatasource

protected HierarchicalDatasource createHierarchicalPropertyDatasource()

createValueCollectionDatasource

protected ValueCollectionDatasourceImpl createValueCollectionDatasource()

createValueGroupDatasource

protected ValueGroupDatasourceImpl createValueGroupDatasource()

createValueHierarchicalDatasource

protected ValueHierarchicalDatasourceImpl createValueHierarchicalDatasource()

getPersistenceManager

protected PersistenceManagerService getPersistenceManager()

getViewRepository

protected ViewRepository getViewRepository()

getMetadata

protected Metadata getMetadata()

getDsContext

public DsContext getDsContext()

getDataSupplier

public DataSupplier getDataSupplier()

setDataSupplier

public DsBuilder setDataSupplier(DataSupplier dataSupplier)

getId

public java.lang.String getId()

getMetaClass

public MetaClass getMetaClass()

getJavaClass

public java.lang.Class getJavaClass()

setJavaClass

public DsBuilder setJavaClass(java.lang.Class javaClass)

isAllowCommit

public boolean isAllowCommit()

setAllowCommit

public DsBuilder setAllowCommit(boolean allowCommit)

getView

public View getView()

getViewName

public java.lang.String getViewName()

setId

public DsBuilder setId(java.lang.String id)

setMetaClass

public DsBuilder setMetaClass(MetaClass metaClass)

setView

public DsBuilder setView(@Nullable
                         View view)

setViewName

public DsBuilder setViewName(java.lang.String viewName)

isSoftDeletion

public boolean isSoftDeletion()

setSoftDeletion

public DsBuilder setSoftDeletion(boolean softDeletion)

isCacheable

public boolean isCacheable()

setCacheable

public DsBuilder setCacheable(boolean cacheable)

getMaster

public Datasource getMaster()

setMaster

public DsBuilder setMaster(Datasource master)

getProperty

public java.lang.String getProperty()

setProperty

public DsBuilder setProperty(java.lang.String property)

getRefreshMode

public CollectionDatasource.RefreshMode getRefreshMode()

setRefreshMode

public DsBuilder setRefreshMode(CollectionDatasource.RefreshMode refreshMode)

getMaxResults

public int getMaxResults()

setMaxResults

public DsBuilder setMaxResults(int maxResults)

getDsClass

public java.lang.Class<?> getDsClass()

setDsClass

public DsBuilder setDsClass(java.lang.Class<?> dsClass)

Set datasource implementation class. If not specified, a standard implementation is used.

reset

public DsBuilder reset()

init

protected void init()

buildDatasource

public Datasource buildDatasource()

buildCollectionDatasource

public <T> T buildCollectionDatasource(java.lang.Class<T> datasourceClass)

Build a CollectionDatasource with the specified implementation class.

buildCollectionDatasource

public CollectionDatasource buildCollectionDatasource()

Build a CollectionDatasource with the standard implementation.

buildHierarchicalDatasource

public <T> T buildHierarchicalDatasource(java.lang.Class<T> datasourceClass)

Build a HierarchicalDatasource with the specified implementation class.

buildHierarchicalDatasource

public HierarchicalDatasource buildHierarchicalDatasource()

Build a HierarchicalDatasource with the standard implementation.

buildGroupDatasource

public <T> T buildGroupDatasource(java.lang.Class<T> datasourceClass)

Build a GroupDatasource with the specified implementation class.

buildGroupDatasource

public GroupDatasource buildGroupDatasource()

Build a GroupDatasource with the standard implementation.

buildRuntimePropsDatasource

public RuntimePropsDatasource buildRuntimePropsDatasource(java.lang.String mainDsId,
                                                          @Nullable
                                                          MetaClass categorizedEntityClass)

buildValuesCollectionDatasource

public ValueCollectionDatasourceImpl buildValuesCollectionDatasource()

Build a ValueCollectionDatasourceImpl with the standard implementation.

buildValuesCollectionDatasource

public <T> T buildValuesCollectionDatasource(java.lang.Class<T> datasourceClass)

Build a ValueCollectionDatasourceImpl with the specified implementation class.

buildValuesGroupDatasource

public ValueGroupDatasourceImpl buildValuesGroupDatasource()

Build a ValueGroupDatasourceImpl with the standard implementation.

buildValuesGroupDatasource

public <T> T buildValuesGroupDatasource(java.lang.Class<T> datasourceClass)

Build a ValueGroupDatasourceImpl with the specified implementation class.

buildValuesHierarchicalDatasource

public ValueHierarchicalDatasourceImpl buildValuesHierarchicalDatasource()

Build a ValueHierarchicalDatasourceImpl with the standard implementation.

buildValuesHierarchicalDatasource

public <T> T buildValuesHierarchicalDatasource(java.lang.Class<T> datasourceClass)

Build a ValueHierarchicalDatasourceImpl with the specified implementation class.