io.jmix.core

Class FetchPlanBuilder

java.lang.Object

io.jmix.core.FetchPlanBuilder

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

Builds FetchPlans.

Use FetchPlans factory to get the builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected java.util.Map<java.lang.String,FetchPlanBuilder>	builders
protected java.lang.Class<?>	entityClass
protected java.util.Map<java.lang.String,FetchMode>	fetchModes
protected FetchPlanRepository	fetchPlanRepository
protected java.util.Map<java.lang.String,FetchPlan>	fetchPlans
protected boolean	loadPartialEntities
protected MetaClass	metaClass
protected Metadata	metadata
protected MetadataTools	metadataTools
protected java.lang.String	name
protected java.util.Set<java.lang.String>	properties
protected FetchPlan	result
protected boolean	systemProperties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FetchPlanBuilder(java.lang.Class<?> entityClass)

Method Summary

Modifier and Type	Method and Description
FetchPlanBuilder	add(java.lang.String property) Adds property.
FetchPlanBuilder	add(java.lang.String property, java.util.function.Consumer<FetchPlanBuilder> consumer) Adds property.
FetchPlanBuilder	add(java.lang.String property, java.util.function.Consumer<FetchPlanBuilder> consumer, FetchMode fetchMode) Adds property.
FetchPlanBuilder	add(java.lang.String property, FetchPlanBuilder builder) Adds property with FetchPlan specified by builder.
FetchPlanBuilder	add(java.lang.String property, FetchPlanBuilder builder, FetchMode fetchMode) Adds property with FetchPlan specified by builder.
FetchPlanBuilder	add(java.lang.String property, java.lang.String fetchPlanName) Adds property with FetchPlan specified by fetchPlanName.
FetchPlanBuilder	add(java.lang.String property, java.lang.String fetchPlanName, FetchMode fetchMode) Adds property with FetchPlan specified by fetchPlanName and a specific fetch mode.
FetchPlanBuilder	addAll(java.lang.String... properties) Adds all listed properties to FetchPlan
FetchPlanBuilder	addFetchPlan(FetchPlan fetchPlan) Adds all properties from specified fetchPlan.
FetchPlanBuilder	addFetchPlan(java.lang.String fetchPlanName) Adds all properties from specified by fetchPlanName FetchPlan.
FetchPlanBuilder	addSystem() Adds all system properties determined by MetadataTools.getSystemProperties(MetaClass) to FetchPlan
protected void	addSystemProperties()
FetchPlan	build() Builds fetch plan and makes builder immutable. Subsequent method invocations returns the same object.
protected void	checkState() Checks whether FetchPlan has been built.
protected FetchPlan	createFetchPlan(java.lang.Class<?> entityClass, java.lang.String name, java.util.List<FetchPlanProperty> properties, boolean loadPartialEntities)
java.lang.Class<?>	getEntityClass()
protected MetaPropertyPath	getMetaPropertyPath(java.lang.String property)
java.lang.String	getName()
protected FetchPlanBuilder	getNestedPropertyBuilder(FetchPlanBuilder builder, java.lang.String name)
boolean	isBuilt()
FetchPlanBuilder	merge(FetchPlan fetchPlan) Deep merges fetchPlan into current fetchPlan by adding all properties recursively.
FetchPlanBuilder	mergeNestedProperty(java.lang.String propertyPath, FetchPlan fetchPlan) Deep merges fetchPlan into direct or indirect property's fetchPlan by adding all properties recursively.
FetchPlanBuilder	mergeProperty(java.lang.String propName, FetchPlan propFetchPlan, FetchMode propFetchMode) Deep merges fetchPlan into property's fetchPlan by adding all properties recursively.
FetchPlanBuilder	name(java.lang.String name) Sets FetchPlan.name
FetchPlanBuilder	partial() Sets FetchPlan.loadPartialEntities() to true
FetchPlanBuilder	partial(boolean partial) Specifies FetchPlan.loadPartialEntities()
protected void	postConstruct()

Methods inherited from class java.lang.Object

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

Field Detail

applicationContext

@Autowired
protected org.springframework.context.ApplicationContext applicationContext

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected MetadataTools metadataTools

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

entityClass

protected java.lang.Class<?> entityClass

metaClass

protected MetaClass metaClass

properties

protected java.util.Set<java.lang.String> properties

builders

protected java.util.Map<java.lang.String,FetchPlanBuilder> builders

fetchPlans

protected java.util.Map<java.lang.String,FetchPlan> fetchPlans

fetchModes

protected java.util.Map<java.lang.String,FetchMode> fetchModes

systemProperties

protected boolean systemProperties

loadPartialEntities

protected boolean loadPartialEntities

name

protected java.lang.String name

result

protected FetchPlan result

Constructor Detail

FetchPlanBuilder

protected FetchPlanBuilder(java.lang.Class<?> entityClass)

Method Detail

postConstruct

@PostConstruct
protected void postConstruct()

build

public FetchPlan build()

Builds fetch plan and makes builder immutable.
Subsequent method invocations returns the same object.

Returns:

created FetchPlan

createFetchPlan

protected FetchPlan createFetchPlan(java.lang.Class<?> entityClass,
                                    java.lang.String name,
                                    java.util.List<FetchPlanProperty> properties,
                                    boolean loadPartialEntities)

add

public FetchPlanBuilder add(java.lang.String property)

Adds property.

Parameters:

property - name of direct property or dot separated path to indirect property. e.g. "address.country.name"

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

add

public FetchPlanBuilder add(java.lang.String property,
                            java.util.function.Consumer<FetchPlanBuilder> consumer)

Adds property.

Parameters:

property - property name

consumer - to build property fetchPlan

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

add

public FetchPlanBuilder add(java.lang.String property,
                            java.util.function.Consumer<FetchPlanBuilder> consumer,
                            FetchMode fetchMode)

Adds property.

Parameters:

property - property name

consumer - to build property fetchPlan

fetchMode - fetch mode for property

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

add

public FetchPlanBuilder add(java.lang.String property,
                            java.lang.String fetchPlanName)

Adds property with FetchPlan specified by fetchPlanName.

For example:

   FetchPlan orderFP = fetchPlans.builder(Order.class)
       .addFetchPlan(FetchPlan.BASE)
       .add("orderLines", FetchPlan.BASE)
       .add("orderLines.product", FetchPlan.BASE)
       .build();
 

Parameters:

property - name of immediate property or dot separated property path, e.g. "address.country.name"

Throws:

FetchPlanNotFoundException - if specified by fetchPlanName FetchPlan not found for entity determined by property

java.lang.RuntimeException - if FetchPlan has been already built

add

public FetchPlanBuilder add(java.lang.String property,
                            java.lang.String fetchPlanName,
                            FetchMode fetchMode)

Adds property with FetchPlan specified by fetchPlanName and a specific fetch mode.

For example:

     FetchPlan orderFP = fetchPlans.builder(Order.class)
         .addFetchPlan(FetchPlan.BASE)
         .add("orderLines", FetchPlan.BASE, FetchMode.UNDEFINED)
         .add("orderLines.product", FetchPlan.BASE, FetchMode.UNDEFINED)
         .build();
 

Parameters:

property - name of immediate property or dot separated property path, e.g. "address.country.name"

Throws:

FetchPlanNotFoundException - if specified by fetchPlanName FetchPlan not found for entity determined by property

java.lang.RuntimeException - if FetchPlan has been already built

add

public FetchPlanBuilder add(java.lang.String property,
                            FetchPlanBuilder builder)

Adds property with FetchPlan specified by builder.

Parameters:

property - property name

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

add

public FetchPlanBuilder add(java.lang.String property,
                            FetchPlanBuilder builder,
                            FetchMode fetchMode)

Adds property with FetchPlan specified by builder.

Parameters:

property - property name

fetchMode - fetch mode for property

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

addAll

public FetchPlanBuilder addAll(java.lang.String... properties)

Adds all listed properties to FetchPlan

Parameters:

properties - list of properties determined as for simple add(String) method

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

See Also:

add(String)

addSystem

public FetchPlanBuilder addSystem()

Adds all system properties determined by MetadataTools.getSystemProperties(MetaClass) to FetchPlan

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

addSystemProperties

protected void addSystemProperties()

addFetchPlan

public FetchPlanBuilder addFetchPlan(FetchPlan fetchPlan)

Adds all properties from specified fetchPlan. Replaces existing nested fetchPlans.

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

addFetchPlan

public FetchPlanBuilder addFetchPlan(java.lang.String fetchPlanName)

Adds all properties from specified by fetchPlanName FetchPlan. Replaces existing nested fetchPlans.

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

merge

public FetchPlanBuilder merge(FetchPlan fetchPlan)

Deep merges fetchPlan into current fetchPlan by adding all properties recursively.

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

mergeProperty

public FetchPlanBuilder mergeProperty(java.lang.String propName,
                                      @Nullable
                                      FetchPlan propFetchPlan,
                                      @Nullable
                                      FetchMode propFetchMode)

Deep merges fetchPlan into property's fetchPlan by adding all properties recursively.

Parameters:

propName - name of property to merge propFetchPlan to

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

mergeNestedProperty

public FetchPlanBuilder mergeNestedProperty(java.lang.String propertyPath,
                                            @Nullable
                                            FetchPlan fetchPlan)

Deep merges fetchPlan into direct or indirect property's fetchPlan by adding all properties recursively.

Parameters:

propertyPath - name of direct property or dot separated path to indirect property to merge propFetchPlan to

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

partial

public FetchPlanBuilder partial()

Sets FetchPlan.loadPartialEntities() to true

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

partial

public FetchPlanBuilder partial(boolean partial)

Specifies FetchPlan.loadPartialEntities()

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

name

public FetchPlanBuilder name(java.lang.String name)

Sets FetchPlan.name

Throws:

java.lang.RuntimeException - if FetchPlan has been already built

getEntityClass

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

getName

public java.lang.String getName()

Returns:

FetchPlan.name for fetchPlan under construction

isBuilt

public boolean isBuilt()

Returns:

wheser FetchPlan has been already built and builder is not modifiable anymore

checkState

protected void checkState()

Checks whether FetchPlan has been built. Builder cannot be modified after build() invocation

Throws:

java.lang.RuntimeException - if FetchPlan is already built

getMetaPropertyPath

protected MetaPropertyPath getMetaPropertyPath(java.lang.String property)

getNestedPropertyBuilder

protected FetchPlanBuilder getNestedPropertyBuilder(FetchPlanBuilder builder,
                                                    java.lang.String name)