com.haulmont.cuba.gui.relatedentities

Class RelatedEntitiesBean

java.lang.Object

com.haulmont.cuba.gui.relatedentities.RelatedEntitiesBean

All Implemented Interfaces:

RelatedEntitiesAPI

@Component(value="cuba_RelatedEntities")
public class RelatedEntitiesBean
extends java.lang.Object
implements RelatedEntitiesAPI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RelatedEntitiesBean.MetaDataDescriptor

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.relatedentities.RelatedEntitiesAPI

RelatedEntitiesAPI.RelatedScreenDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected ExtendedEntities	extendedEntities
protected FilterParser	filterParser
protected Messages	messages
protected MessageTools	messageTools
protected Metadata	metadata
protected MetadataTools	metadataTools
protected ConditionParamBuilder	paramBuilder
protected RelatedEntitiesService	relatedEntitiesService
protected UserSessionSource	userSessionSource
protected WindowConfig	windowConfig
protected WindowManagerProvider	windowManagerProvider

Fields inherited from interface com.haulmont.cuba.gui.relatedentities.RelatedEntitiesAPI

NAME

Constructor Summary

Constructors

Constructor and Description
RelatedEntitiesBean()

Method Summary

Modifier and Type	Method and Description
protected void	applyFilter(Filter component, java.util.Collection<? extends Entity> selectedParents, RelatedEntitiesAPI.RelatedScreenDescriptor descriptor, RelatedEntitiesBean.MetaDataDescriptor metaDataDescriptor)
RelatedEntitiesBuilder	builder(FrameOwner frameOwner) Creates a related screen builder.
protected Screen	buildScreen(RelatedEntitiesBuilder builder)
protected Screen	createScreen(RelatedEntitiesBuilder builder, MetaClass metaClass, MetaProperty metaProperty)
protected org.dom4j.Element	getConditionXmlElement(java.lang.String conditionName, MetaClass metaClass)
protected MetaClass	getFilterMetaClass(Filter filter)
protected AbstractCondition	getManyToManyCondition(java.util.List<java.lang.Object> parentIds, MetaClass metaClass, java.lang.String filterComponentName, java.lang.String relatedPrimaryKey, RelatedEntitiesBean.MetaDataDescriptor descriptor)
protected AbstractCondition	getManyToOneCondition(java.util.List<java.lang.Object> parentIds, MetaClass metaClass, java.lang.String filterComponentName, java.lang.String relatedPrimaryKey, RelatedEntitiesBean.MetaDataDescriptor descriptor)
protected MetaClass	getMetaClassNN(RelatedEntitiesBuilder builder)
protected MetaProperty	getMetaPropertyNN(RelatedEntitiesBuilder builder, MetaClass metaClass)
protected PropertyCondition	getNonOptimizedCondition(MetaClass metaClass, java.util.List<java.lang.Object> ids, Filter component, java.lang.String filterComponentName, java.lang.String primaryKey)
protected AbstractCondition	getOneToManyCondition(java.util.List<java.lang.Object> parentIds, MetaClass metaClass, java.lang.String filterComponentName, RelatedEntitiesBean.MetaDataDescriptor descriptor)
protected AbstractCondition	getOptimizedCondition(java.util.List<java.lang.Object> parentIds, MetaClass metaClass, java.lang.String filterComponentName, java.lang.String relatedPrimaryKey, RelatedEntitiesBean.MetaDataDescriptor descriptor)
protected CustomCondition	getParentEntitiesCondition(java.util.List<java.lang.Object> parentIds, java.lang.String parentPrimaryKey, MetaClass metaClass, java.lang.String filterComponentName, MetaClass parentMetaClass)
protected Param	getParentEntitiesParam(java.util.List<java.lang.Object> parentIds, java.lang.String parentPrimaryKey, MetaClass metaClass, java.lang.Class parentPrimaryKeyClass, java.lang.String paramName, MetaClass parentMetaClass)
protected java.util.List<java.lang.Object>	getParentIds(java.util.Collection<? extends Entity> selectedParents)
protected java.lang.String	getRelatedEntitiesFilterXml(MetaClass relatedMetaCLass, java.util.Collection<? extends Entity> selectedEntities, Filter component, RelatedEntitiesBean.MetaDataDescriptor descriptor)
protected java.util.List<java.lang.Object>	getRelatedIds(java.util.Collection<? extends Entity> selectedParents, RelatedEntitiesBean.MetaDataDescriptor descriptor)
void	openRelatedScreen(java.util.Collection<? extends Entity> selectedEntities, MetaClass metaClass, MetaProperty metaProperty) Shows found related entities in default browse screen.
void	openRelatedScreen(java.util.Collection<? extends Entity> selectedEntities, MetaClass metaClass, MetaProperty metaProperty, RelatedEntitiesAPI.RelatedScreenDescriptor descriptor) Shows found related entities in chosen screen.
<T extends Entity> void	openRelatedScreen(java.util.Collection<T> selectedEntities, java.lang.Class<T> clazz, java.lang.String property) Shows found related entities in default browse screen.
<T extends Entity> void	openRelatedScreen(java.util.Collection<T> selectedEntities, java.lang.Class<T> clazz, java.lang.String property, RelatedEntitiesAPI.RelatedScreenDescriptor descriptor) Shows found related entities in chosen screen.

Methods inherited from class java.lang.Object

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

Field Detail

extendedEntities

@Inject
protected ExtendedEntities extendedEntities

relatedEntitiesService

@Inject
protected RelatedEntitiesService relatedEntitiesService

messages

@Inject
protected Messages messages

messageTools

@Inject
protected MessageTools messageTools

windowConfig

@Inject
protected WindowConfig windowConfig

windowManagerProvider

@Inject
protected WindowManagerProvider windowManagerProvider

userSessionSource

@Inject
protected UserSessionSource userSessionSource

metadata

@Inject
protected Metadata metadata

metadataTools

@Inject
protected MetadataTools metadataTools

filterParser

@Inject
protected FilterParser filterParser

paramBuilder

@Inject
protected ConditionParamBuilder paramBuilder

Constructor Detail

RelatedEntitiesBean

public RelatedEntitiesBean()

Method Detail

builder

public RelatedEntitiesBuilder builder(FrameOwner frameOwner)

Description copied from interface: RelatedEntitiesAPI

Creates a related screen builder.

Note, it is necessary to set MetaClass or entity class and property or MetaProperty to builder.

Example of creating screen with entity class and property:

      RelatedEntitiesBuilder builder = relatedEntitiesAPI.builder(this);
      Screen colourBrowser = builder
              .withEntityClass(Car.class)
              .withProperty("colour")
              .withSelectedEntities(carsTable.getSelected())
              .withScreenClass(ColourBrowser.class)
              .build();
      colourBrowser.show();
 

Specified by:

builder in interface RelatedEntitiesAPI

Parameters:

frameOwner - invoking screen

Returns:

builder instance

openRelatedScreen

public void openRelatedScreen(java.util.Collection<? extends Entity> selectedEntities,
                              MetaClass metaClass,
                              MetaProperty metaProperty)

Description copied from interface: RelatedEntitiesAPI

Shows found related entities in default browse screen.

Specified by:

openRelatedScreen in interface RelatedEntitiesAPI

Parameters:

selectedEntities - set of entities which represents one side of relation

metaClass - metaClass of single entity from selectedEntities

metaProperty - chosen field to find related entities. Can be obtained from metaClass

openRelatedScreen

public void openRelatedScreen(java.util.Collection<? extends Entity> selectedEntities,
                              MetaClass metaClass,
                              MetaProperty metaProperty,
                              RelatedEntitiesAPI.RelatedScreenDescriptor descriptor)

Description copied from interface: RelatedEntitiesAPI

Shows found related entities in chosen screen.

Specified by:

openRelatedScreen in interface RelatedEntitiesAPI

Parameters:

selectedEntities - set of entities which represents one side of relation

metaClass - metaClass of single entity from selectedEntities

metaProperty - chosen field to find related entities. Can be obtained from metaClass

descriptor - descriptor contains screen id, WindowManager.OpenType and generated filter caption

openRelatedScreen

public <T extends Entity> void openRelatedScreen(java.util.Collection<T> selectedEntities,
                                                 java.lang.Class<T> clazz,
                                                 java.lang.String property)

Description copied from interface: RelatedEntitiesAPI

Shows found related entities in default browse screen.

Specified by:

openRelatedScreen in interface RelatedEntitiesAPI

Parameters:

selectedEntities - set of entities which represents one side of relation

clazz - class of single entity from selectedEntities

property - chosen field to find related entities

openRelatedScreen

public <T extends Entity> void openRelatedScreen(java.util.Collection<T> selectedEntities,
                                                 java.lang.Class<T> clazz,
                                                 java.lang.String property,
                                                 RelatedEntitiesAPI.RelatedScreenDescriptor descriptor)

Description copied from interface: RelatedEntitiesAPI

Shows found related entities in chosen screen.

Specified by:

openRelatedScreen in interface RelatedEntitiesAPI

Parameters:

selectedEntities - set of entities which represents one side of relation

clazz - class of single entity from selectedEntities

property - chosen field to find related entities

descriptor - descriptor contains screen id, WindowManager.OpenType and generated filter caption

applyFilter

protected void applyFilter(Filter component,
                           java.util.Collection<? extends Entity> selectedParents,
                           RelatedEntitiesAPI.RelatedScreenDescriptor descriptor,
                           RelatedEntitiesBean.MetaDataDescriptor metaDataDescriptor)

getRelatedEntitiesFilterXml

protected java.lang.String getRelatedEntitiesFilterXml(MetaClass relatedMetaCLass,
                                                       java.util.Collection<? extends Entity> selectedEntities,
                                                       Filter component,
                                                       RelatedEntitiesBean.MetaDataDescriptor descriptor)

getFilterMetaClass

protected MetaClass getFilterMetaClass(Filter filter)

getOptimizedCondition

@Nullable
protected AbstractCondition getOptimizedCondition(java.util.List<java.lang.Object> parentIds,
                                                            MetaClass metaClass,
                                                            java.lang.String filterComponentName,
                                                            java.lang.String relatedPrimaryKey,
                                                            RelatedEntitiesBean.MetaDataDescriptor descriptor)

getOneToManyCondition

@Nullable
protected AbstractCondition getOneToManyCondition(java.util.List<java.lang.Object> parentIds,
                                                            MetaClass metaClass,
                                                            java.lang.String filterComponentName,
                                                            RelatedEntitiesBean.MetaDataDescriptor descriptor)

getManyToManyCondition

@Nullable
protected AbstractCondition getManyToManyCondition(java.util.List<java.lang.Object> parentIds,
                                                             MetaClass metaClass,
                                                             java.lang.String filterComponentName,
                                                             java.lang.String relatedPrimaryKey,
                                                             RelatedEntitiesBean.MetaDataDescriptor descriptor)

getManyToOneCondition

@Nullable
protected AbstractCondition getManyToOneCondition(java.util.List<java.lang.Object> parentIds,
                                                            MetaClass metaClass,
                                                            java.lang.String filterComponentName,
                                                            java.lang.String relatedPrimaryKey,
                                                            RelatedEntitiesBean.MetaDataDescriptor descriptor)

getParentEntitiesParam

protected Param getParentEntitiesParam(java.util.List<java.lang.Object> parentIds,
                                       java.lang.String parentPrimaryKey,
                                       MetaClass metaClass,
                                       java.lang.Class parentPrimaryKeyClass,
                                       java.lang.String paramName,
                                       MetaClass parentMetaClass)

getParentEntitiesCondition

protected CustomCondition getParentEntitiesCondition(java.util.List<java.lang.Object> parentIds,
                                                     java.lang.String parentPrimaryKey,
                                                     MetaClass metaClass,
                                                     java.lang.String filterComponentName,
                                                     MetaClass parentMetaClass)

getConditionXmlElement

protected org.dom4j.Element getConditionXmlElement(java.lang.String conditionName,
                                                   MetaClass metaClass)

getNonOptimizedCondition

protected PropertyCondition getNonOptimizedCondition(MetaClass metaClass,
                                                     java.util.List<java.lang.Object> ids,
                                                     Filter component,
                                                     java.lang.String filterComponentName,
                                                     java.lang.String primaryKey)

getRelatedIds

protected java.util.List<java.lang.Object> getRelatedIds(java.util.Collection<? extends Entity> selectedParents,
                                                         RelatedEntitiesBean.MetaDataDescriptor descriptor)

getParentIds

protected java.util.List<java.lang.Object> getParentIds(java.util.Collection<? extends Entity> selectedParents)

buildScreen

protected Screen buildScreen(RelatedEntitiesBuilder builder)

getMetaClassNN

protected MetaClass getMetaClassNN(RelatedEntitiesBuilder builder)

getMetaPropertyNN

protected MetaProperty getMetaPropertyNN(RelatedEntitiesBuilder builder,
                                         MetaClass metaClass)

createScreen

protected Screen createScreen(RelatedEntitiesBuilder builder,
                              MetaClass metaClass,
                              MetaProperty metaProperty)