Package io.objectbox.generator.model

Class Schema

java.lang.Object

io.objectbox.generator.model.Schema

public class Schema
extends java.lang.Object

The "root" model class to which you can add entities to.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_NAME

Constructor Summary

Constructors

Constructor	Description
Schema(int version, java.lang.String defaultJavaPackage)
Schema(java.lang.String name, int version, java.lang.String defaultJavaPackage)

Method Summary

Modifier and Type	Method	Description
Entity	addEntity(java.lang.String className)	Adds a new entity to the schema.
void	finish()	Sets DAO names for ObjectBox (Cursor), runs 2nd and 3rd pass on schema.
java.lang.String	getDefaultJavaPackage()
java.lang.String	getDefaultJavaPackageDao()
java.util.List<Entity>	getEntities()
io.objectbox.generator.IdUid	getLastEntityId()
io.objectbox.generator.IdUid	getLastIndexId()
io.objectbox.generator.IdUid	getLastRelationId()
java.lang.String	getName()
java.lang.String	getPrefix()
int	getVersion()
boolean	isFinished()
java.lang.String	mapToDbType(PropertyType propertyType)
short	mapToDbTypeId(PropertyType propertyType)
java.lang.String	mapToJavaTypeNotNull(PropertyType propertyType)
java.lang.String	mapToJavaTypeNullable(PropertyType propertyType)
void	setLastEntityId(io.objectbox.generator.IdUid lastEntityId)
void	setLastIndexId(io.objectbox.generator.IdUid lastIndexId)
void	setLastRelationId(io.objectbox.generator.IdUid lastRelationId)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAME

public static final java.lang.String DEFAULT_NAME

See Also:

Constant Field Values

Constructor Detail

Schema

public Schema(java.lang.String name,
              int version,
              java.lang.String defaultJavaPackage)

Schema

public Schema(int version,
              java.lang.String defaultJavaPackage)

Method Detail

addEntity

public Entity addEntity(java.lang.String className)

Adds a new entity to the schema.

mapToDbType

public java.lang.String mapToDbType(PropertyType propertyType)

mapToDbTypeId

public short mapToDbTypeId(PropertyType propertyType)

mapToJavaTypeNullable

public java.lang.String mapToJavaTypeNullable(PropertyType propertyType)

mapToJavaTypeNotNull

public java.lang.String mapToJavaTypeNotNull(PropertyType propertyType)

getVersion

public int getVersion()

getDefaultJavaPackage

public java.lang.String getDefaultJavaPackage()

getDefaultJavaPackageDao

public java.lang.String getDefaultJavaPackageDao()

getEntities

public java.util.List<Entity> getEntities()

getName

public java.lang.String getName()

getPrefix

public java.lang.String getPrefix()

getLastEntityId

public io.objectbox.generator.IdUid getLastEntityId()

setLastEntityId

public void setLastEntityId(io.objectbox.generator.IdUid lastEntityId)

getLastIndexId

public io.objectbox.generator.IdUid getLastIndexId()

setLastIndexId

public void setLastIndexId(io.objectbox.generator.IdUid lastIndexId)

getLastRelationId

public io.objectbox.generator.IdUid getLastRelationId()

setLastRelationId

public void setLastRelationId(io.objectbox.generator.IdUid lastRelationId)

isFinished

public boolean isFinished()

finish

public void finish()
            throws ModelException

Sets DAO names for ObjectBox (Cursor), runs 2nd and 3rd pass on schema. Afterwards isFinished().

Throws:

ModelException