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

Class AbstractEntityPropertyDescriptor

java.lang.Object

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

All Implemented Interfaces:

EntityPropertyDescriptor

Direct Known Subclasses:

DatatypePropertyDescriptor, EmbeddedPropertyDescriptor, EnumPropertyDescriptor, RelationPropertyDescriptor

public abstract class AbstractEntityPropertyDescriptor
extends Object
implements EntityPropertyDescriptor

Base EntityPropertyDescriptor implementation holding the attributes common to all property kinds.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable String	comment
protected @Nullable Boolean	identifier
protected String	javaType
protected List<String>	localizedNames
protected Boolean	mandatory
protected String	name
protected Boolean	persistent
protected String	propertyType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected String	fieldsToString()
@Nullable String	getComment()	Returns the property comment.
@Nullable Boolean	getIdentifier()	Returns whether the property is the entity identifier.
String	getJavaType()	Returns the simple Java type name of the property.
List<String>	getLocalizedNames()	Returns the property captions for the configured locales.
Boolean	getMandatory()	Returns whether the property is mandatory.
String	getName()	Returns the property name.
Boolean	getPersistent()	Returns whether the property is persistent (stored in the database).
String	getPropertyType()	Returns the Jmix property type (for example "datatype" or "enum").
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

name

protected String name

localizedNames

protected List<String> localizedNames

javaType

protected String javaType

propertyType

protected String propertyType

identifier

protected @Nullable Boolean identifier

persistent

protected Boolean persistent

mandatory

protected Boolean mandatory

comment

protected @Nullable String comment

Constructor Details

AbstractEntityPropertyDescriptor

public AbstractEntityPropertyDescriptor(String name,
 List<String> localizedNames,
 String javaType,
 String propertyType,
 @Nullable Boolean identifier,
 Boolean persistent,
 Boolean mandatory,
 @Nullable String comment)

Method Details

getName

public String getName()

Description copied from interface: EntityPropertyDescriptor

Returns the property name.

Specified by:

getName in interface EntityPropertyDescriptor

Returns:

property name

getLocalizedNames

public List<String> getLocalizedNames()

Description copied from interface: EntityPropertyDescriptor

Returns the property captions for the configured locales.

Specified by:

getLocalizedNames in interface EntityPropertyDescriptor

Returns:

localized property names

getJavaType

public String getJavaType()

Description copied from interface: EntityPropertyDescriptor

Returns the simple Java type name of the property.

Specified by:

getJavaType in interface EntityPropertyDescriptor

Returns:

Java type name

getPropertyType

public String getPropertyType()

Description copied from interface: EntityPropertyDescriptor

Returns the Jmix property type (for example "datatype" or "enum").

Specified by:

getPropertyType in interface EntityPropertyDescriptor

Returns:

property type name

getIdentifier

public @Nullable Boolean getIdentifier()

Description copied from interface: EntityPropertyDescriptor

Returns whether the property is the entity identifier.

Specified by:

getIdentifier in interface EntityPropertyDescriptor

Returns:

true if the property is the primary key, or null otherwise

getPersistent

public Boolean getPersistent()

Description copied from interface: EntityPropertyDescriptor

Returns whether the property is persistent (stored in the database).

Specified by:

getPersistent in interface EntityPropertyDescriptor

Returns:

true if the property is persistent

getMandatory

public Boolean getMandatory()

Description copied from interface: EntityPropertyDescriptor

Returns whether the property is mandatory.

Specified by:

getMandatory in interface EntityPropertyDescriptor

Returns:

true if the property is mandatory

getComment

public @Nullable String getComment()

Description copied from interface: EntityPropertyDescriptor

Returns the property comment.

Specified by:

getComment in interface EntityPropertyDescriptor

Returns:

comment text, or null if none

toString

public String toString()

Overrides:

toString in class Object

fieldsToString

protected String fieldsToString()