Package io.objectbox.generator.model

Class 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 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)

      • 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()

      • isSyncEnabled

        public boolean isSyncEnabled()

      • setSyncEnabled

        public void setSyncEnabled​(boolean syncEnabled)

      • isSyncSharedGlobalIds

        public boolean isSyncSharedGlobalIds()

      • setSyncSharedGlobalIds

        public void setSyncSharedGlobalIds​(boolean enabled)

      • 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