io.objectbox.generator.model

Class Entity

java.lang.Object

io.objectbox.generator.model.Entity

All Implemented Interfaces:

HasParsedElement

public class Entity
extends java.lang.Object
implements HasParsedElement

Model class for an entity: a Java data object mapped to a data base representation. A new entity is added to a Schema by Schema.addEntity(String).

Use the various add methods to add entity properties, indexes, and relations to other entities (addToOne, addToMany).

Method Summary

Modifier and Type	Method and Description
Property.PropertyBuilder	addIdProperty() Adds a standard id property.
Entity	addIndex(io.objectbox.generator.model.Index index) Adds a new index to the entity.
Property.PropertyBuilder	addProperty(PropertyType propertyType, java.lang.String propertyName)
io.objectbox.generator.model.ToManyStandalone	addToMany(io.objectbox.generator.model.ToManyStandalone toMany, Entity target) Adds a (stand-alone) to-many relation (ToManyStandalone) to another entity.
io.objectbox.generator.model.ToManyByBacklink	addToManyByToManyBacklink(io.objectbox.generator.model.ToManyByBacklink toMany, Entity targetEntity, io.objectbox.generator.model.ToManyStandalone targetToMany) Adds a to-many relation based on a (stand-alone) to-many relation (addToMany(io.objectbox.generator.model.ToManyStandalone, io.objectbox.generator.model.Entity)) from another entity to this entity.
io.objectbox.generator.model.ToManyByBacklink	addToManyByToOneBacklink(io.objectbox.generator.model.ToManyByBacklink toMany, Entity targetEntity, io.objectbox.generator.model.ToOne targetToOne) Adds a to-many relation based on a to-one relation (addToOne(io.objectbox.generator.model.ToOne, io.objectbox.generator.model.Entity)) from another entity to this entity.
io.objectbox.generator.model.ToOne	addToOne(io.objectbox.generator.model.ToOne toOne, Entity target) Adds a to-one relationship to the given target entity.
void	computeEntityFlags() Based on this entities attributes computes required EntityFlags.
Property	findPropertyByName(java.lang.String name)
java.util.Collection<java.lang.String>	getAdditionalImportsDao()
java.lang.String	getClassName()
java.lang.String	getClassNameDao()
java.lang.String	getDbName()
int	getEntityFlags() Returns combined EntityFlags value.
java.lang.Integer	getEntityFlagsForModelFile() Returns combined EntityFlags value of only those flags that should be stored in the model file.
java.util.Set<java.lang.String>	getEntityFlagsNames() Returns names of EntityFlags.
boolean	getHasBoxStoreField()
java.util.List<ToManyBase>	getIncomingToManyRelations()
java.util.List<io.objectbox.generator.model.Index>	getIndexes()
java.lang.String	getJavaPackage()
java.lang.String	getJavaPackageDao()
io.objectbox.generator.IdUid	getLastPropertyId()
java.lang.Integer	getModelId()
java.lang.Long	getModelUid()
java.util.List<io.objectbox.generator.model.Index>	getMultiIndexes()
java.lang.Object	getParsedElement()
Property	getPkProperty() Internal property used by templates, don't use during entity definition.
java.lang.String	getPkType() Internal property used by templates, don't use during entity definition.
java.util.List<Property>	getProperties()
java.util.List<Property>	getPropertiesColumns()
java.util.List<Property>	getPropertiesPk() Internal property used by templates, don't use during entity definition.
Schema	getSchema()
java.util.List<ToManyBase>	getToManyRelations()
java.util.List<io.objectbox.generator.model.ToOne>	getToOneRelations()
boolean	hasAllArgsConstructor()
boolean	hasRelations()
protected void	init2ndPassNamesWithDefaults()
boolean	isSyncEnabled()
boolean	isSyncSharedGlobalIds()
void	setClassNameDao(java.lang.String classNameDao)
void	setDbName(java.lang.String dbName)
void	setHasAllArgsConstructor(boolean hasAllArgsConstructor) Set to indicate the associated class has a constructor with an argument for every property available.
void	setHasBoxStoreField(boolean hasBoxStoreField)
void	setJavaPackage(java.lang.String javaPackage)
void	setJavaPackageDao(java.lang.String javaPackageDao)
Entity	setLastPropertyId(io.objectbox.generator.IdUid lastPropertyId)
Entity	setModelId(java.lang.Integer modelId)
Entity	setModelUid(java.lang.Long modelUid)
void	setParsedElement(java.lang.Object parsedElement)
void	setSyncEnabled(boolean syncEnabled)
void	setSyncSharedGlobalIds(boolean enabled)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

setModelId

public Entity setModelId(java.lang.Integer modelId)

getModelId

public java.lang.Integer getModelId()

setModelUid

public Entity setModelUid(java.lang.Long modelUid)

getModelUid

public java.lang.Long getModelUid()

getLastPropertyId

public io.objectbox.generator.IdUid getLastPropertyId()

setLastPropertyId

public Entity setLastPropertyId(io.objectbox.generator.IdUid lastPropertyId)

addProperty

public Property.PropertyBuilder addProperty(PropertyType propertyType,
                                            java.lang.String propertyName)
                                     throws ModelException

Throws:

ModelException

addIdProperty

public Property.PropertyBuilder addIdProperty()
                                       throws ModelException

Adds a standard id property.

Throws:

ModelException

addToManyByToOneBacklink

public io.objectbox.generator.model.ToManyByBacklink addToManyByToOneBacklink(io.objectbox.generator.model.ToManyByBacklink toMany,
                                                                              Entity targetEntity,
                                                                              io.objectbox.generator.model.ToOne targetToOne)
                                                                       throws ModelException

Adds a to-many relation based on a to-one relation (addToOne(io.objectbox.generator.model.ToOne, io.objectbox.generator.model.Entity)) from another entity to this entity.

Throws:

ModelException - if this entity already has a property or relation with name.

addToManyByToManyBacklink

public io.objectbox.generator.model.ToManyByBacklink addToManyByToManyBacklink(io.objectbox.generator.model.ToManyByBacklink toMany,
                                                                               Entity targetEntity,
                                                                               io.objectbox.generator.model.ToManyStandalone targetToMany)
                                                                        throws ModelException

Adds a to-many relation based on a (stand-alone) to-many relation (addToMany(io.objectbox.generator.model.ToManyStandalone, io.objectbox.generator.model.Entity)) from another entity to this entity.

Throws:

ModelException - if this entity already has a property or relation with name.

addToMany

public io.objectbox.generator.model.ToManyStandalone addToMany(io.objectbox.generator.model.ToManyStandalone toMany,
                                                               Entity target)
                                                        throws ModelException

Adds a (stand-alone) to-many relation (ToManyStandalone) to another entity.

Throws:

ModelException - if this entity already has a property or relation with name.

addToOne

public io.objectbox.generator.model.ToOne addToOne(io.objectbox.generator.model.ToOne toOne,
                                                   Entity target)
                                            throws ModelException

Adds a to-one relationship to the given target entity.

Throws:

ModelException - if this entity already has a property or relation with name.

addIndex

public Entity addIndex(io.objectbox.generator.model.Index index)

Adds a new index to the entity.

getSchema

public Schema getSchema()

getDbName

public java.lang.String getDbName()

setDbName

public void setDbName(java.lang.String dbName)

getClassName

public java.lang.String getClassName()

getProperties

public java.util.List<Property> getProperties()

findPropertyByName

public Property findPropertyByName(java.lang.String name)

getPropertiesColumns

public java.util.List<Property> getPropertiesColumns()

getJavaPackage

public java.lang.String getJavaPackage()

setJavaPackage

public void setJavaPackage(java.lang.String javaPackage)

getJavaPackageDao

public java.lang.String getJavaPackageDao()

setJavaPackageDao

public void setJavaPackageDao(java.lang.String javaPackageDao)

getClassNameDao

public java.lang.String getClassNameDao()

setClassNameDao

public void setClassNameDao(java.lang.String classNameDao)

getPropertiesPk

public java.util.List<Property> getPropertiesPk()

Internal property used by templates, don't use during entity definition.

getPkProperty

public Property getPkProperty()

Internal property used by templates, don't use during entity definition.

getIndexes

public java.util.List<io.objectbox.generator.model.Index> getIndexes()

getPkType

public java.lang.String getPkType()

Internal property used by templates, don't use during entity definition.

hasAllArgsConstructor

public boolean hasAllArgsConstructor()

setHasAllArgsConstructor

public void setHasAllArgsConstructor(boolean hasAllArgsConstructor)

Set to indicate the associated class has a constructor with an argument for every property available.

hasRelations

public boolean hasRelations()

getToOneRelations

public java.util.List<io.objectbox.generator.model.ToOne> getToOneRelations()

getToManyRelations

public java.util.List<ToManyBase> getToManyRelations()

getIncomingToManyRelations

public java.util.List<ToManyBase> getIncomingToManyRelations()

getAdditionalImportsDao

public java.util.Collection<java.lang.String> getAdditionalImportsDao()

getHasBoxStoreField

public boolean getHasBoxStoreField()

setHasBoxStoreField

public void setHasBoxStoreField(boolean hasBoxStoreField)

init2ndPassNamesWithDefaults

protected void init2ndPassNamesWithDefaults()

getMultiIndexes

public java.util.List<io.objectbox.generator.model.Index> getMultiIndexes()

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

isSyncEnabled

public boolean isSyncEnabled()

setSyncEnabled

public void setSyncEnabled(boolean syncEnabled)

isSyncSharedGlobalIds

public boolean isSyncSharedGlobalIds()

setSyncSharedGlobalIds

public void setSyncSharedGlobalIds(boolean enabled)

computeEntityFlags

public void computeEntityFlags()

Based on this entities attributes computes required EntityFlags.

See Also:

getEntityFlags(), getEntityFlagsForModelFile(), getEntityFlagsNames()

getEntityFlags

public int getEntityFlags()

Returns combined EntityFlags value.

getEntityFlagsForModelFile

@Nullable
public java.lang.Integer getEntityFlagsForModelFile()

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

getEntityFlagsNames

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

Returns names of EntityFlags.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object