Package io.jmix.core.impl

Class InstanceNameProviderImpl

java.lang.Object

io.jmix.core.impl.InstanceNameProviderImpl

All Implemented Interfaces:

InstanceNameProvider

@Component("core_InstanceNameProvider")
public class InstanceNameProviderImpl
extends Object
implements InstanceNameProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	InstanceNameProviderImpl.EvaluationResult
static class	InstanceNameProviderImpl.InstanceNameRec
protected static class	InstanceNameProviderImpl.State

Field Summary

Fields

Modifier and Type	Field	Description
protected CoreProperties	coreProperties
protected DatatypeRegistry	datatypeRegistry
protected ExtendedEntities	extendedEntities
protected Messages	messages
protected Metadata	metadata
protected MetadataGenerationManager	metadataGenerationManager
protected MetadataTools	metadataTools
protected MethodArgumentsProvider	methodArgumentsProvider
protected ContextArgumentResolverComposite	resolvers
protected final GenerationStateStore<InstanceNameProviderImpl.State>	stateStore
static final String	UNFETCHED_EXCEPTION_MESSAGE_PREFIX

Constructor Summary

Constructors

Constructor	Description
InstanceNameProviderImpl()

Method Summary

Modifier and Type	Method	Description
void	evictInstanceNameCache()	Evicts cached instance name metadata for all entities.
protected InstanceNameProviderImpl.EvaluationResult	getInstanceName(InstanceNameProviderImpl.InstanceNameRec rec, Object instance)
String	getInstanceName(Object instance)	Gets entity instance name defined by InstanceName annotation.
String	getInstanceName(Object instance, MetaClass metaClass)	Gets entity instance name defined by InstanceName annotation in metaClass or its ancestor if CoreProperties.instanceNameFallbackEnabled is true.
String	getInstanceName(Object instance, Class<?> clazz)	Gets entity instance name defined by InstanceName annotation in entityClass or its ancestor if CoreProperties.instanceNameFallbackEnabled is true.
protected Collection<MetaProperty>	getInstanceNameProperties(MetaClass metaClass, @Nullable Method nameMethod, @Nullable MetaProperty nameProperty)
Collection<MetaProperty>	getInstanceNameRelatedProperties(MetaClass metaClass, boolean useOriginal)	Return a collection of properties included into entity's name pattern (see InstanceName).
ArgumentResolverComposite	getResolvers()
protected InstanceNameProviderImpl.State	getState()
protected boolean	hasRuntimeInstanceNameAnnotation(MetaProperty metaProperty)
boolean	isInstanceNameDefined(Class<?> aClass)	Checks if InstanceName annotation is present in an entity class, i.e.
protected boolean	isInstanceNameProperty(MetaProperty metaProperty)
protected boolean	isPreferredNameProperty(MetaProperty candidate, MetaProperty current)
void	onMetadataGenerationRetired(MetadataGenerationRetiredEvent event)	Drops instance-name cache entries associated with a retired metadata generation.
@Nullable InstanceNameProviderImpl.InstanceNameRec	parseNamePattern(MetaClass metaClass)
protected MetaProperty	selectNameProperty(List<MetaProperty> nameProperties)
void	setResolvers(ContextArgumentResolverComposite resolvers)

Methods inherited from class java.lang.Object

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

Field Details

UNFETCHED_EXCEPTION_MESSAGE_PREFIX

public static final String UNFETCHED_EXCEPTION_MESSAGE_PREFIX

See Also:

• Constant Field Values

metadata

@Autowired
protected Metadata metadata

extendedEntities

@Autowired
protected ExtendedEntities extendedEntities

datatypeRegistry

@Autowired
protected DatatypeRegistry datatypeRegistry

messages

@Autowired
protected Messages messages

metadataTools

@Autowired
protected MetadataTools metadataTools

coreProperties

@Autowired
protected CoreProperties coreProperties

resolvers

protected ContextArgumentResolverComposite resolvers

methodArgumentsProvider

protected MethodArgumentsProvider methodArgumentsProvider

metadataGenerationManager

@Autowired
protected MetadataGenerationManager metadataGenerationManager

stateStore

protected final GenerationStateStore<InstanceNameProviderImpl.State> stateStore

Constructor Details

InstanceNameProviderImpl

public InstanceNameProviderImpl()

Method Details

getResolvers

public ArgumentResolverComposite getResolvers()

setResolvers

@Autowired
public void setResolvers(ContextArgumentResolverComposite resolvers)

getState

protected InstanceNameProviderImpl.State getState()

onMetadataGenerationRetired

@EventListener
public void onMetadataGenerationRetired(MetadataGenerationRetiredEvent event)

Drops instance-name cache entries associated with a retired metadata generation.

Parameters:

event - retired-generation event

isInstanceNameDefined

public boolean isInstanceNameDefined(Class<?> aClass)

Description copied from interface: InstanceNameProvider

Checks if InstanceName annotation is present in an entity class, i.e. whether instance name can be obtained for entity instances.

Specified by:

isInstanceNameDefined in interface InstanceNameProvider

Parameters:

aClass - an entity class to check

Returns:

true if InstanceName annotation is present, false otherwise

getInstanceName

public String getInstanceName(Object instance)

Description copied from interface: InstanceNameProvider

Gets entity instance name defined by InstanceName annotation. If InstanceName annotation is not defined, returns entity.toString().

Specified by:

getInstanceName in interface InstanceNameProvider

Parameters:

instance - an entity instance to get instance name

Returns:

instance name

getInstanceName

public String getInstanceName(Object instance,
 Class<?> clazz)

Description copied from interface: InstanceNameProvider

Gets entity instance name defined by InstanceName annotation in entityClass or its ancestor if CoreProperties.instanceNameFallbackEnabled is true.

Specified by:

getInstanceName in interface InstanceNameProvider

Parameters:

instance - instance

clazz - class to get @InstanceName definition from

Returns:

instance name

See Also:

• CoreProperties.instanceNameFallbackEnabled

getInstanceName

public String getInstanceName(Object instance,
 MetaClass metaClass)

Description copied from interface: InstanceNameProvider

Gets entity instance name defined by InstanceName annotation in metaClass or its ancestor if CoreProperties.instanceNameFallbackEnabled is true.

Specified by:

getInstanceName in interface InstanceNameProvider

Parameters:

instance - instance

metaClass - class to get @InstanceName definition from

Returns:

instance name

See Also:

• CoreProperties.instanceNameFallbackEnabled

getInstanceName

protected InstanceNameProviderImpl.EvaluationResult getInstanceName(InstanceNameProviderImpl.InstanceNameRec rec,
 Object instance)

getInstanceNameRelatedProperties

public Collection<MetaProperty> getInstanceNameRelatedProperties(MetaClass metaClass,
 boolean useOriginal)

Description copied from interface: InstanceNameProvider

Return a collection of properties included into entity's name pattern (see InstanceName).

Specified by:

getInstanceNameRelatedProperties in interface InstanceNameProvider

Parameters:

metaClass - entity metaclass

useOriginal - if true, and if the given metaclass doesn't define a InstanceName and if it is an extended entity, this method tries to find a name pattern in an original entity

Returns:

collection of the name pattern properties

evictInstanceNameCache

public void evictInstanceNameCache()

Description copied from interface: InstanceNameProvider

Evicts cached instance name metadata for all entities.

Specified by:

evictInstanceNameCache in interface InstanceNameProvider

getInstanceNameProperties

protected Collection<MetaProperty> getInstanceNameProperties(MetaClass metaClass,
 @Nullable Method nameMethod,
 @Nullable MetaProperty nameProperty)

parseNamePattern

public @Nullable InstanceNameProviderImpl.InstanceNameRec parseNamePattern(MetaClass metaClass)

isInstanceNameProperty

protected boolean isInstanceNameProperty(MetaProperty metaProperty)

selectNameProperty

protected MetaProperty selectNameProperty(List<MetaProperty> nameProperties)

isPreferredNameProperty

protected boolean isPreferredNameProperty(MetaProperty candidate,
 MetaProperty current)

hasRuntimeInstanceNameAnnotation

protected boolean hasRuntimeInstanceNameAnnotation(MetaProperty metaProperty)