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

Class EntityDescriptor

java.lang.Object

io.jmix.aitools.dataload.introspection.model.EntityDescriptor

public class EntityDescriptor
extends Object

Full description of an introspected entity.

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable String	comment
protected List<String>	localizedNames
protected String	name
protected List<EntityPropertyDescriptor>	properties

Constructor Summary

Constructors

Constructor	Description
EntityDescriptor(String name, List<String> localizedNames, List<EntityPropertyDescriptor> properties, @Nullable String comment)

Method Summary

Modifier and Type	Method	Description
@Nullable String	getComment()	Returns the entity comment.
List<String>	getLocalizedNames()	Returns the entity captions for the configured locales.
String	getName()	Returns the Jmix entity name.
List<EntityPropertyDescriptor>	getProperties()	Returns the descriptors of the entity's properties.
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

properties

protected List<EntityPropertyDescriptor> properties

comment

protected @Nullable String comment

Constructor Details

EntityDescriptor

public EntityDescriptor(String name,
 List<String> localizedNames,
 List<EntityPropertyDescriptor> properties,
 @Nullable String comment)

Method Details

getName

public String getName()

Returns the Jmix entity name.

Returns:

entity name

getComment

public @Nullable String getComment()

Returns the entity comment.

Returns:

comment text, or null if none

getLocalizedNames

public List<String> getLocalizedNames()

Returns the entity captions for the configured locales.

Returns:

localized entity names

getProperties

public List<EntityPropertyDescriptor> getProperties()

Returns the descriptors of the entity's properties.

Returns:

property descriptors

toString

public String toString()

Overrides:

toString in class Object