Package io.jmix.core

Class FetchPlan

java.lang.Object

io.jmix.core.FetchPlan

All Implemented Interfaces:

Serializable

public class FetchPlan
extends Object
implements Serializable

Class to declare a graph of objects that must be retrieved from the database.

A fetchPlan can be constructed in Java code or defined in XML and deployed to the FetchPlanRepository for recurring usage.

There are the following predefined fetchPlan types:

• LOCAL
• INSTANCE_NAME
• BASE

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE	Includes all local properties and properties defined by InstanceName (effectively INSTANCE_NAME + LOCAL).
protected Class<?>	entityClass
static final String	INSTANCE_NAME	Includes only properties contained in InstanceName.
protected boolean	loadPartialEntities
static final String	LOCAL	Includes all local properties.
protected String	name
protected Map<String,FetchPlanProperty>	properties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FetchPlan(Class<?> entityClass, String name)

Method Summary

Modifier and Type	Method	Description
boolean	containsProperty(String name)	Check if a directly owned property with the given name exists in the fetchPlan.
boolean	equals(Object o)
Class<?>	getEntityClass()
String	getName()
Collection<FetchPlanProperty>	getProperties()
FetchPlanProperty	getProperty(String name)	Get directly owned fetchPlan property by name.
int	hashCode()
boolean	isSupersetOf(FetchPlan fetchPlan)
boolean	loadPartialEntities()	If true, the fetchPlan affects loading of local attributes.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LOCAL

public static final String LOCAL

Includes all local properties.

See Also:

• Constant Field Values

INSTANCE_NAME

public static final String INSTANCE_NAME

Includes only properties contained in InstanceName.

See Also:

• Constant Field Values

BASE

public static final String BASE

Includes all local properties and properties defined by InstanceName (effectively INSTANCE_NAME + LOCAL).

See Also:

• Constant Field Values

entityClass

protected Class<?> entityClass

name

protected String name

properties

protected Map<String,FetchPlanProperty> properties

loadPartialEntities

protected boolean loadPartialEntities

Constructor Details

FetchPlan

protected FetchPlan(Class<?> entityClass,
 String name)

Method Details

getEntityClass

public Class<?> getEntityClass()

Returns:

entity class this fetchPlan belongs to

getName

public String getName()

Returns:

fetchPlan name, unique within an entity

getProperties

public Collection<FetchPlanProperty> getProperties()

Returns:

collection of properties

equals

public boolean equals(Object o)

Overrides:

equals in class Object

isSupersetOf

public boolean isSupersetOf(FetchPlan fetchPlan)

Returns:

whether this fetch plan contains all attributes of fetchPlan including nested plans attributes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getProperty

@Nullable
public FetchPlanProperty getProperty(String name)

Get directly owned fetchPlan property by name.

Parameters:

name - property name

Returns:

fetchPlan property instance or null if it is not found

containsProperty

public boolean containsProperty(String name)

Check if a directly owned property with the given name exists in the fetchPlan.

Parameters:

name - property name

Returns:

true if such property found

loadPartialEntities

public boolean loadPartialEntities()

If true, the fetchPlan affects loading of local attributes. If false, only reference attributes are affected and local are always loaded.