Package io.jmix.aitools.dataload.introspection.model

Class EnumPropertyDescriptor

java.lang.Object

io.jmix.aitools.dataload.introspection.model.AbstractEntityPropertyDescriptor

io.jmix.aitools.dataload.introspection.model.EnumPropertyDescriptor

All Implemented Interfaces:

EntityPropertyDescriptor

public class EnumPropertyDescriptor
extends AbstractEntityPropertyDescriptor

Descriptor of an enum entity property. Adds the enum class description and how its values are stored (for example by id, name or ordinal) on top of the common property attributes.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable String	enumStorageMode
protected EnumClassDescriptor	enumType

Fields inherited from class io.jmix.aitools.dataload.introspection.model.AbstractEntityPropertyDescriptor

comment, identifier, javaType, localizedNames, mandatory, name, persistent, propertyType

Constructor Summary

Constructors

Constructor	Description
EnumPropertyDescriptor(String name, List<String> localizedNames, String javaType, String propertyType, @Nullable Boolean identifier, Boolean persistent, Boolean mandatory, @Nullable String comment, EnumClassDescriptor enumType, @Nullable String enumStorageMode)

Method Summary

Modifier and Type	Method	Description
protected String	fieldsToString()
@Nullable String	getEnumStorageMode()	Returns how the enum values are stored.
EnumClassDescriptor	getEnumType()	Returns the description of the enum class, including its constants.

Methods inherited from class io.jmix.aitools.dataload.introspection.model.AbstractEntityPropertyDescriptor

getComment, getIdentifier, getJavaType, getLocalizedNames, getMandatory, getName, getPersistent, getPropertyType, toString

Methods inherited from class java.lang.Object

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

Field Details

enumType

protected EnumClassDescriptor enumType

enumStorageMode

protected @Nullable String enumStorageMode

Constructor Details

EnumPropertyDescriptor

public EnumPropertyDescriptor(String name,
 List<String> localizedNames,
 String javaType,
 String propertyType,
 @Nullable Boolean identifier,
 Boolean persistent,
 Boolean mandatory,
 @Nullable String comment,
 EnumClassDescriptor enumType,
 @Nullable String enumStorageMode)

Method Details

getEnumType

public EnumClassDescriptor getEnumType()

Returns the description of the enum class, including its constants.

Returns:

enum class descriptor

getEnumStorageMode

public @Nullable String getEnumStorageMode()

Returns how the enum values are stored.

Returns:

storage mode (for example "ordinal" or "string"), or null for a Jmix EnumClass

fieldsToString

protected String fieldsToString()

Overrides:

fieldsToString in class AbstractEntityPropertyDescriptor