com.haulmont.cuba.core.global

Class EntityLoadInfo

java.lang.Object

com.haulmont.cuba.core.global.EntityLoadInfo

Direct Known Subclasses:

OriginalEntityLoadInfo

public class EntityLoadInfo
extends java.lang.Object

Class that encapsulates an information needed to load an entity instance.
This information has the following string representation: metaclassName-id[-viewName], e.g.:

 sec$User-60885987-1b61-4247-94c7-dff348347f93
 sec$Role-0c018061-b26f-4de2-a5be-dff348347f93-role.browse
 ref$Seller-101
 ref$Currency-{usd}
 

viewName part is optional.
id part should be:

• For UUID keys: canonical UUID representation with 5 groups of hex digits delimited by dashes
• For numeric keys: decimal representation of the number
• For string keys: the key surrounded by curly brackets, e.g {mykey}

Use EntityLoadInfoBuilder.parse(String) and toString() methods to convert from/to a string.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NEW_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EntityLoadInfo(java.lang.Object id, MetaClass metaClass, java.lang.String viewName, boolean stringKey)
protected	EntityLoadInfo(java.lang.Object id, MetaClass metaClass, java.lang.String viewName, boolean stringKey, boolean newEntity)

Method Summary

Modifier and Type	Method and Description
static EntityLoadInfo	create(Entity entity) Create a new info instance with empty view name.
static EntityLoadInfo	create(Entity entity, java.lang.String viewName) Create a new info instance.
java.lang.Object	getId()
MetaClass	getMetaClass()
java.lang.String	getViewName()
boolean	isNewEntity()
static EntityLoadInfo	parse(java.lang.String str) Parse an info from the string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NEW_PREFIX

public static final java.lang.String NEW_PREFIX

See Also:

Constant Field Values

Constructor Detail

EntityLoadInfo

protected EntityLoadInfo(java.lang.Object id,
                         MetaClass metaClass,
                         java.lang.String viewName,
                         boolean stringKey)

EntityLoadInfo

protected EntityLoadInfo(java.lang.Object id,
                         MetaClass metaClass,
                         java.lang.String viewName,
                         boolean stringKey,
                         boolean newEntity)

Method Detail

getId

public java.lang.Object getId()

getMetaClass

public MetaClass getMetaClass()

getViewName

@Nullable
public java.lang.String getViewName()

isNewEntity

public boolean isNewEntity()

create

public static EntityLoadInfo create(Entity entity,
                                    @Nullable
                                    java.lang.String viewName)

Create a new info instance.

Consider using EntityLoadInfoBuilder for better performance.

Parameters:

entity - entity instance

viewName - view name, can be null

Returns:

info instance

create

public static EntityLoadInfo create(Entity entity)

Create a new info instance with empty view name.

Consider using EntityLoadInfoBuilder for better performance.

Parameters:

entity - entity instance

Returns:

info instance

parse

@Nullable
public static EntityLoadInfo parse(java.lang.String str)

Parse an info from the string.

Consider using EntityLoadInfoBuilder for better performance.

Parameters:

str - string representation of the info

Returns:

info instance or null if the string can not be parsed. Any exception is silently swallowed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object