io.objectbox.generator.model

Class Property

java.lang.Object

io.objectbox.generator.model.Property

All Implemented Interfaces:

HasParsedElement

public class Property
extends java.lang.Object
implements HasParsedElement

Model class for an entity's property: a Java property mapped to a data base representation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Property.PropertyBuilder

Constructor Summary

Constructors

Constructor and Description
Property(Schema schema, Entity entity, PropertyType propertyType, java.lang.String propertyName)

Method Summary

Modifier and Type	Method and Description
void	computePropertyFlags() Based on this properties attributes computes required PropertyFlags.
java.lang.String	getConverter()
java.lang.String	getConverterClassName()
java.lang.String	getCustomType()
java.lang.String	getCustomTypeClassName()
java.lang.String	getDatabaseValueExpression()
java.lang.String	getDatabaseValueExpression(java.lang.String entityValue)
java.lang.String	getDbName()
java.lang.String	getDbType() String representation of a PropertyType enum.
java.lang.Short	getDbTypeId() ID of the PropertyType.
Entity	getEntity()
java.lang.String	getGetterMethodName()
io.objectbox.generator.model.HnswParams	getHnswParams()
java.lang.String	getHnswParamsExpression()
io.objectbox.generator.model.Index	getIndex() Note: index is not set until after finishing schema.
java.lang.String	getJavaRawType() If the Java type is generic, returns the raw type.
java.lang.String	getJavaType() Returns the type including type parameters, e.g.
java.lang.String	getJavaTypeInEntity()
io.objectbox.generator.IdUid	getModelId()
io.objectbox.generator.IdUid	getModelIndexId()
int	getOrdinal()
java.lang.Object	getParsedElement()
java.util.Set<java.lang.String>	getPropertyFlagsForGeneratedCode() Returns names of PropertyFlags to be used in generated model builder code.
java.lang.Integer	getPropertyFlagsForModelFile() Returns combined PropertyFlags value of only those flags that should be stored in the model file.
java.lang.String	getPropertyName()
PropertyType	getPropertyType()
java.lang.String	getSetValueExpression(java.lang.String value)
Entity	getTargetEntity()
java.lang.String	getValueExpression()
java.lang.String	getVirtualTargetName()
java.lang.String	getVirtualTargetValueExpression()
boolean	hasHnswParams()
boolean	isIdAssignable() If PropertyFlags.ID_SELF_ASSIGNABLE should be set on this property.
boolean	isIdCompanion() If PropertyFlags.ID_COMPANION should be set on this property.
boolean	isList() For a vector property, if it is a List or an array.
boolean	isNonPrimitiveFlag() If PropertyFlags.NON_PRIMITIVE_TYPE should be set on this property.
boolean	isNotNullFlag() If PropertyFlags.NOT_NULL should be set on this property.
boolean	isPrimaryKey() If this property is a primary key and PropertyFlags.ID should be set.
boolean	isTypeNotNull() If a property value may never be null, so e.g.
boolean	isUnsigned() If PropertyFlags.UNSIGNED should be set on this property.
boolean	isVirtual() If this property does not actually exist in the entity class, but only in the model and PropertyFlags.VIRTUAL should be set.
void	setIndex(io.objectbox.generator.model.Index index)
void	setModelId(io.objectbox.generator.IdUid modelId)
void	setModelIndexId(io.objectbox.generator.IdUid modelIndexId)
void	setParsedElement(java.lang.Object parsedElement)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

public Property(Schema schema,
                Entity entity,
                PropertyType propertyType,
                java.lang.String propertyName)

Method Detail

getPropertyName

public java.lang.String getPropertyName()

getPropertyType

public PropertyType getPropertyType()

getModelId

public io.objectbox.generator.IdUid getModelId()

setModelId

public void setModelId(io.objectbox.generator.IdUid modelId)

getModelIndexId

public io.objectbox.generator.IdUid getModelIndexId()

setModelIndexId

public void setModelIndexId(io.objectbox.generator.IdUid modelIndexId)

getDbName

public java.lang.String getDbName()

getDbType

public java.lang.String getDbType()

String representation of a PropertyType enum.

getDbTypeId

public java.lang.Short getDbTypeId()

ID of the PropertyType.

isPrimaryKey

public boolean isPrimaryKey()

If this property is a primary key and PropertyFlags.ID should be set.

isIdCompanion

public boolean isIdCompanion()

If PropertyFlags.ID_COMPANION should be set on this property.

isTypeNotNull

public boolean isTypeNotNull()

If a property value may never be null, so e.g. null checks in generated code are not necessary.

Note: this is not related to PropertyFlags.NOT_NULL, use isNotNullFlag() instead.

isNotNullFlag

public boolean isNotNullFlag()

If PropertyFlags.NOT_NULL should be set on this property.

Note: this does not indicate if the property value may never be null, use isTypeNotNull() instead.

isNonPrimitiveFlag

public boolean isNonPrimitiveFlag()

If PropertyFlags.NON_PRIMITIVE_TYPE should be set on this property.

This will indicate to the database that either

• a wrapper type should be used for a scalar property (e.g. Long instead of long),
• a custom type is used, or
• List<String> should be used instead of String[] when creating an instance of the property.

Note: use isTypeNotNull() instead to check if the property value can be null.

isList

public boolean isList()

For a vector property, if it is a List or an array.

Currently only supported for PropertyType.StringArray.

isUnsigned

public boolean isUnsigned()

If PropertyFlags.UNSIGNED should be set on this property.

isIdAssignable

public boolean isIdAssignable()

If PropertyFlags.ID_SELF_ASSIGNABLE should be set on this property.

getJavaType

public java.lang.String getJavaType()

Returns the type including type parameters, e.g. List<String>.

getJavaRawType

public java.lang.String getJavaRawType()

If the Java type is generic, returns the raw type. E.g. List instead of List<String>. Otherwise, returns the same as getJavaType().

getJavaTypeInEntity

public java.lang.String getJavaTypeInEntity()

getOrdinal

public int getOrdinal()

getCustomType

public java.lang.String getCustomType()

getCustomTypeClassName

public java.lang.String getCustomTypeClassName()

getConverter

public java.lang.String getConverter()

getConverterClassName

public java.lang.String getConverterClassName()

isVirtual

public boolean isVirtual()

If this property does not actually exist in the entity class, but only in the model and PropertyFlags.VIRTUAL should be set.

getVirtualTargetValueExpression

public java.lang.String getVirtualTargetValueExpression()

getVirtualTargetName

public java.lang.String getVirtualTargetName()

getGetterMethodName

public java.lang.String getGetterMethodName()

getTargetEntity

public Entity getTargetEntity()

getValueExpression

public java.lang.String getValueExpression()

getSetValueExpression

public java.lang.String getSetValueExpression(java.lang.String value)

getDatabaseValueExpression

public java.lang.String getDatabaseValueExpression()

getDatabaseValueExpression

public java.lang.String getDatabaseValueExpression(java.lang.String entityValue)

getHnswParams

@Nullable
public io.objectbox.generator.model.HnswParams getHnswParams()

hasHnswParams

public boolean hasHnswParams()

getHnswParamsExpression

public java.lang.String getHnswParamsExpression()

Returns:

see HnswParams.getExpression().

getEntity

public Entity getEntity()

getIndex

@Nullable
public io.objectbox.generator.model.Index getIndex()

Note: index is not set until after finishing schema.

setIndex

public void setIndex(io.objectbox.generator.model.Index index)

getParsedElement

public java.lang.Object getParsedElement()

Specified by:

getParsedElement in interface HasParsedElement

setParsedElement

public void setParsedElement(java.lang.Object parsedElement)

Specified by:

setParsedElement in interface HasParsedElement

computePropertyFlags

public void computePropertyFlags()

Based on this properties attributes computes required PropertyFlags.

See Also:

getPropertyFlagsForModelFile(), getPropertyFlagsForGeneratedCode()

getPropertyFlagsForModelFile

@Nullable
public java.lang.Integer getPropertyFlagsForModelFile()

Returns combined PropertyFlags value of only those flags that should be stored in the model file. Returns null if there would be no flags.

These may be different from getPropertyFlagsForGeneratedCode(), see computePropertyFlags().

getPropertyFlagsForGeneratedCode

public java.util.Set<java.lang.String> getPropertyFlagsForGeneratedCode()

Returns names of PropertyFlags to be used in generated model builder code.

These may be different from getPropertyFlagsForModelFile(), see computePropertyFlags().

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object