com.haulmont.cuba.core.global

Class View

java.lang.Object

com.haulmont.cuba.core.global.View

All Implemented Interfaces:

java.io.Serializable

public class View
extends java.lang.Object
implements java.io.Serializable

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

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

There are the following predefined view types:

• LOCAL
• MINIMAL
• BASE

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	View.ViewParams Parameters object to be used in constructors.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASE Includes all local non-system properties and properties defined by NamePattern (effectively MINIMAL + LOCAL).
static java.lang.String	LOCAL Includes all local non-system properties.
static java.lang.String	MINIMAL Includes only properties contained in NamePattern.

Constructor Summary

Constructors

Constructor and Description
View(java.lang.Class<? extends Entity> entityClass)
View(java.lang.Class<? extends Entity> entityClass, boolean includeSystemProperties)
View(java.lang.Class<? extends Entity> entityClass, java.lang.String name)
View(java.lang.Class<? extends Entity> entityClass, java.lang.String name, boolean includeSystemProperties)
View(View.ViewParams viewParams)
View(View src, java.lang.Class<? extends Entity> entityClass, java.lang.String name, boolean includeSystemProperties)
View(View src, java.lang.String name, boolean includeSystemProperties)

Method Summary

Modifier and Type	Method and Description
View	addProperty(java.lang.String name) Add a property to this view.
View	addProperty(java.lang.String name, View view) Add a property to this view.
View	addProperty(java.lang.String name, View view, boolean lazy) Deprecated.
View	addProperty(java.lang.String name, View view, FetchMode fetchMode) Add a property to this view.
boolean	containsProperty(java.lang.String name) Check if a directly owned property with the given name exists in the view.
static View	copy(View view)
boolean	equals(java.lang.Object o)
java.lang.Class<? extends Entity>	getEntityClass()
java.lang.String	getName()
java.util.Collection<ViewProperty>	getProperties()
ViewProperty	getProperty(java.lang.String name) Get directly owned view property by name.
int	hashCode()
boolean	hasLazyProperties() Deprecated.
boolean	loadPartialEntities() If true, the view affects loading of local attributes.
View	setLoadPartialEntities(boolean loadPartialEntities) Specifies whether the view affects loading of local attributes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOCAL

public static final java.lang.String LOCAL

Includes all local non-system properties.

See Also:

Constant Field Values

MINIMAL

public static final java.lang.String MINIMAL

Includes only properties contained in NamePattern.

See Also:

Constant Field Values

BASE

public static final java.lang.String BASE

Includes all local non-system properties and properties defined by NamePattern (effectively MINIMAL + LOCAL).

See Also:

Constant Field Values

Constructor Detail

View

public View(java.lang.Class<? extends Entity> entityClass)

View

public View(java.lang.Class<? extends Entity> entityClass,
            boolean includeSystemProperties)

View

public View(java.lang.Class<? extends Entity> entityClass,
            java.lang.String name)

View

public View(java.lang.Class<? extends Entity> entityClass,
            java.lang.String name,
            boolean includeSystemProperties)

View

public View(View src,
            java.lang.String name,
            boolean includeSystemProperties)

View

public View(View src,
            @Nullable
            java.lang.Class<? extends Entity> entityClass,
            java.lang.String name,
            boolean includeSystemProperties)

View

public View(View.ViewParams viewParams)

Method Detail

copy

public static View copy(@Nullable
                        View view)

getEntityClass

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

Returns:

entity class this view belongs to

getName

public java.lang.String getName()

Returns:

view name, unique within an entity

getProperties

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

Returns:

collection of properties

addProperty

public View addProperty(java.lang.String name,
                        @Nullable
                        View view,
                        FetchMode fetchMode)

Add a property to this view.

Parameters:

name - property name

view - a view for a reference attribute, or null

fetchMode - fetch mode for a reference attribute

Returns:

this view instance for chaining

addProperty

@Deprecated
public View addProperty(java.lang.String name,
                                    @Nullable
                                    View view,
                                    boolean lazy)

Deprecated.

addProperty

public View addProperty(java.lang.String name,
                        View view)

Add a property to this view.

Parameters:

name - property name

view - a view for a reference attribute, or null

Returns:

this view instance for chaining

addProperty

public View addProperty(java.lang.String name)

Add a property to this view.

Parameters:

name - property name

Returns:

this view instance for chaining

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

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 ViewProperty getProperty(java.lang.String name)

Get directly owned view property by name.

Parameters:

name - property name

Returns:

view 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 view.

Parameters:

name - property name

Returns:

true if such property found

loadPartialEntities

public boolean loadPartialEntities()

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

See Also:

setLoadPartialEntities(boolean)

setLoadPartialEntities

public View setLoadPartialEntities(boolean loadPartialEntities)

Specifies whether the view affects loading of local attributes. By default only reference attributes are affected and local are always loaded.

Parameters:

loadPartialEntities - true to affect loading of local attributes

Returns:

this view instance for chaining

hasLazyProperties

@Deprecated
public boolean hasLazyProperties()

Deprecated.

DEPRECATED since v.6