Package io.objectbox.model

Class Model

  • public final class Model
extends Table
    A model describes all entities and other meta data. The current model of an app is synced against ObjectBox's persisted schema. The model itself is not persisted, and thus may change as long as both ends are consistent (Java and native). There could be multiple models/schemas (one dbi per schema) in the future.

    • Constructor Detail

      • Model

        public Model()

    • Method Detail

      • ValidateVersion

        public static void ValidateVersion()

      • getRootAsModel

        public static Model getRootAsModel​(java.nio.ByteBuffer _bb)

      • getRootAsModel

        public static Model getRootAsModel​(java.nio.ByteBuffer _bb,
                                   Model obj)

      • __init

        public void __init​(int _i,
                   java.nio.ByteBuffer _bb)

      • __assign

        public Model __assign​(int _i,
                      java.nio.ByteBuffer _bb)

      • modelVersion

        public long modelVersion()
        (Meta) version of the model, which is verified by model sync (e.g. Java version must match native version)

      • name

        public java.lang.String name()
        currently always "default"

      • nameAsByteBuffer

        public java.nio.ByteBuffer nameAsByteBuffer()

      • nameInByteBuffer

        public java.nio.ByteBuffer nameInByteBuffer​(java.nio.ByteBuffer _bb)

      • version

        public long version()
        User controlled version, not really used at the moment

      • entitiesLength

        public int entitiesLength()

      • lastEntityId

        public IdUid lastEntityId()

      • lastEntityId

        public IdUid lastEntityId​(IdUid obj)

      • lastIndexId

        public IdUid lastIndexId()

      • lastIndexId

        public IdUid lastIndexId​(IdUid obj)

      • lastSequenceId

        public IdUid lastSequenceId()

      • lastSequenceId

        public IdUid lastSequenceId​(IdUid obj)

      • lastRelationId

        public IdUid lastRelationId()

      • lastRelationId

        public IdUid lastRelationId​(IdUid obj)

      • hash

        public int hash​(int j)
        Hash of the model/schema; usually want to check hashes before even creating a model and thus avoiding creating the model altogether. But, at least for now, let language bindings provide it via the model optionally. We use SipHash 128 (16 bytes).

      • hashLength

        public int hashLength()

      • hashAsByteBuffer

        public java.nio.ByteBuffer hashAsByteBuffer()

      • hashInByteBuffer

        public java.nio.ByteBuffer hashInByteBuffer​(java.nio.ByteBuffer _bb)

      • addModelVersion

        public static void addModelVersion​(FlatBufferBuilder builder,
                                   long modelVersion)

      • addName

        public static void addName​(FlatBufferBuilder builder,
                           int nameOffset)

      • addVersion

        public static void addVersion​(FlatBufferBuilder builder,
                              long version)

      • addEntities

        public static void addEntities​(FlatBufferBuilder builder,
                               int entitiesOffset)

      • createEntitiesVector

        public static int createEntitiesVector​(FlatBufferBuilder builder,
                                       int[] data)

      • startEntitiesVector

        public static void startEntitiesVector​(FlatBufferBuilder builder,
                                       int numElems)

      • addLastEntityId

        public static void addLastEntityId​(FlatBufferBuilder builder,
                                   int lastEntityIdOffset)

      • addLastIndexId

        public static void addLastIndexId​(FlatBufferBuilder builder,
                                  int lastIndexIdOffset)

      • addLastSequenceId

        public static void addLastSequenceId​(FlatBufferBuilder builder,
                                     int lastSequenceIdOffset)

      • addLastRelationId

        public static void addLastRelationId​(FlatBufferBuilder builder,
                                     int lastRelationIdOffset)

      • addHash

        public static void addHash​(FlatBufferBuilder builder,
                           int hashOffset)

      • createHashVector

        public static int createHashVector​(FlatBufferBuilder builder,
                                   byte[] data)

      • createHashVector

        public static int createHashVector​(FlatBufferBuilder builder,
                                   java.nio.ByteBuffer data)

      • startHashVector

        public static void startHashVector​(FlatBufferBuilder builder,
                                   int numElems)

      • finishModelBuffer

        public static void finishModelBuffer​(FlatBufferBuilder builder,
                                     int offset)

      • finishSizePrefixedModelBuffer

        public static void finishSizePrefixedModelBuffer​(FlatBufferBuilder builder,
                                                 int offset)