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

Class RelationPropertyDescriptor

java.lang.Object

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

io.jmix.aitools.dataload.introspection.model.RelationPropertyDescriptor

All Implemented Interfaces:

EntityPropertyDescriptor

public class RelationPropertyDescriptor
extends AbstractEntityPropertyDescriptor

Descriptor of an association or composition (relation) entity property.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	cardinality
protected @Nullable String	mappedBy
protected @Nullable Boolean	optionalRelation
protected List<String>	targetEntityLocalizedNames
protected String	targetEntityName

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

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

Constructor Summary

Constructors

Constructor	Description
RelationPropertyDescriptor(String name, List<String> localizedNames, String javaType, String propertyType, @Nullable Boolean identifier, Boolean persistent, Boolean mandatory, @Nullable String comment, @Nullable String mappedBy, String targetEntityName, List<String> targetEntityLocalizedNames, @Nullable Boolean optionalRelation, String cardinality)

Method Summary

Modifier and Type	Method	Description
protected String	fieldsToString()
String	getCardinality()	Returns the relation cardinality (for example "ONE_TO_MANY").
@Nullable String	getMappedBy()	Returns the name of the inverse property that owns this relation.
@Nullable Boolean	getOptionalRelation()	Returns whether the relation is optional.
List<String>	getTargetEntityLocalizedNames()	Returns the captions of the target entity for the configured locales.
String	getTargetEntityName()	Returns the name of the entity this relation points to.

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

mappedBy

protected @Nullable String mappedBy

targetEntityName

protected String targetEntityName

targetEntityLocalizedNames

protected List<String> targetEntityLocalizedNames

optionalRelation

protected @Nullable Boolean optionalRelation

cardinality

protected String cardinality

Constructor Details

RelationPropertyDescriptor

public RelationPropertyDescriptor(String name,
 List<String> localizedNames,
 String javaType,
 String propertyType,
 @Nullable Boolean identifier,
 Boolean persistent,
 Boolean mandatory,
 @Nullable String comment,
 @Nullable String mappedBy,
 String targetEntityName,
 List<String> targetEntityLocalizedNames,
 @Nullable Boolean optionalRelation,
 String cardinality)

Method Details

getMappedBy

public @Nullable String getMappedBy()

Returns the name of the inverse property that owns this relation.

Returns:

mappedBy property name, or null if this side owns the relation

getTargetEntityName

public String getTargetEntityName()

Returns the name of the entity this relation points to.

Returns:

target entity name

getTargetEntityLocalizedNames

public List<String> getTargetEntityLocalizedNames()

Returns the captions of the target entity for the configured locales.

Returns:

localized target entity names

getOptionalRelation

public @Nullable Boolean getOptionalRelation()

Returns whether the relation is optional.

Returns:

false if the relation is required, or null if it is optional

getCardinality

public String getCardinality()

Returns the relation cardinality (for example "ONE_TO_MANY").

Returns:

cardinality name

fieldsToString

protected String fieldsToString()

Overrides:

fieldsToString in class AbstractEntityPropertyDescriptor