io.jmix.core

Class FetchPlan

java.lang.Object

io.jmix.core.FetchPlan

All Implemented Interfaces:

java.io.Serializable

public class FetchPlan
extends java.lang.Object
implements java.io.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 and Description
static java.lang.String	BASE Includes all local properties and properties defined by InstanceName (effectively INSTANCE_NAME + LOCAL).
protected java.lang.Class<?>	entityClass
static java.lang.String	INSTANCE_NAME Includes only properties contained in InstanceName.
protected boolean	loadPartialEntities
static java.lang.String	LOCAL Includes all local properties.
protected java.lang.String	name
protected java.util.Map<java.lang.String,FetchPlanProperty>	properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FetchPlan(java.lang.Class<?> entityClass, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
boolean	containsProperty(java.lang.String name) Check if a directly owned property with the given name exists in the fetchPlan.
boolean	equals(java.lang.Object o)
java.lang.Class<?>	getEntityClass()
java.lang.String	getName()
java.util.Collection<FetchPlanProperty>	getProperties()
FetchPlanProperty	getProperty(java.lang.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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOCAL

public static final java.lang.String LOCAL

Includes all local properties.

See Also:

Constant Field Values

INSTANCE_NAME

public static final java.lang.String INSTANCE_NAME

Includes only properties contained in InstanceName.

See Also:

Constant Field Values

BASE

public static final java.lang.String BASE

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

See Also:

Constant Field Values

entityClass

protected java.lang.Class<?> entityClass

name

protected java.lang.String name

properties

protected java.util.Map<java.lang.String,FetchPlanProperty> properties

loadPartialEntities

protected boolean loadPartialEntities

Constructor Detail

FetchPlan

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

Method Detail

getEntityClass

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

Returns:

entity class this fetchPlan belongs to

getName

public java.lang.String getName()

Returns:

fetchPlan name, unique within an entity

getProperties

public java.util.Collection<FetchPlanProperty> getProperties()

Returns:

collection of properties

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.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 java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getProperty

@Nullable
public FetchPlanProperty getProperty(java.lang.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(java.lang.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.