Index (objectbox-java-api 5.0.1 API)

A B C D E F G H I J M N O P R S T U V
All Classes and Interfaces|All Packages

A

assignable() - Element in annotation interface io.objectbox.annotation.Id: Allows IDs of new entities to be assigned manually.

B

Backlink - Annotation Interface in io.objectbox.annotation: Defines a backlink relation, which is based on another relation reversing the direction.
BaseEntity - Annotation Interface in io.objectbox.annotation: Marks a class as an ObjectBox Entity super class.
Beta - Annotation Interface in io.objectbox.annotation.apihint: APIs annotated with @Beta may change and may be even removed in a future release (but is somewhat less likely compared to Experimental).
BSON - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: Placeholder (not yet used) for a BSON document.

C

ConflictStrategy - Enum Class in io.objectbox.annotation: Used with Unique to specify the conflict resolution strategy.
Convert - Annotation Interface in io.objectbox.annotation: Supplies a converter to store custom Property types as a supported Convert.dbType().
converter() - Element in annotation interface io.objectbox.annotation.Convert: The converter class that ObjectBox should use.
convertToDatabaseValue(P) - Method in interface io.objectbox.converter.PropertyConverter
convertToEntityProperty(D) - Method in interface io.objectbox.converter.PropertyConverter
COSINE - Enum constant in enum class io.objectbox.annotation.VectorDistanceType: Cosine similarity compares two vectors irrespective of their magnitude (compares the angle of two vectors).

D

DatabaseType - Enum Class in io.objectbox.annotation: Use with @Type to override how a property value is stored and interpreted in the database.
DateNano - Enum constant in enum class io.objectbox.annotation.DatabaseType: Use with 64-bit long properties to store them as high precision time representing nanoseconds since 1970-01-01 (unix epoch).
dbType() - Element in annotation interface io.objectbox.annotation.Convert: The Property type the Java field value is converted to/from.
debugLogs() - Element in annotation interface io.objectbox.annotation.HnswFlags: Enables debug logs.
debugLogsDetailed() - Element in annotation interface io.objectbox.annotation.HnswFlags: Enables "high volume" debug logs, e.g.
DECIMAL_128 - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: IEEE 754 decimal128 type, e.g.
DEFAULT - Enum constant in enum class io.objectbox.annotation.IndexType: Use the default index type depending on the property type: IndexType.VALUE for scalars and IndexType.HASH for Strings.
DEFAULT - Enum constant in enum class io.objectbox.annotation.VectorDistanceType: The default; currently EUCLIDEAN.
DefaultValue - Annotation Interface in io.objectbox.annotation: Defines the Java code of the default value to use for a property, when getting an existing entity and the database value for the property is null.
dimensions() - Element in annotation interface io.objectbox.annotation.HnswIndex: Dimensions of vectors; vector data with fewer dimensions are ignored.
distanceType() - Element in annotation interface io.objectbox.annotation.HnswIndex: The distance type used for the HNSW index.
DOT_PRODUCT - Enum constant in enum class io.objectbox.annotation.VectorDistanceType: For normalized vectors (vector length == 1.0), the dot product is equivalent to the cosine similarity.
DOT_PRODUCT_NON_NORMALIZED - Enum constant in enum class io.objectbox.annotation.VectorDistanceType: A custom dot product similarity measure that does not require the vectors to be normalized.

E

Entity - Annotation Interface in io.objectbox.annotation: Marks a class as an ObjectBox Entity.
EUCLIDEAN - Enum constant in enum class io.objectbox.annotation.VectorDistanceType: Typically "Euclidean squared" internally.
Experimental - Annotation Interface in io.objectbox.annotation.apihint: APIs annotated with @Experimental are likely to change and may be even removed in a future release.
ExternalName - Annotation Interface in io.objectbox.annotation: Sets the name of an @Entity, a property or a ToMany in an external system (like another database).
ExternalPropertyType - Enum Class in io.objectbox.annotation: A property type of an external system (e.g.
ExternalType - Annotation Interface in io.objectbox.annotation: Sets the type of a property or the type of object IDs of a ToMany in an external system (like another database).

F

FAIL - Enum constant in enum class io.objectbox.annotation.ConflictStrategy: Throws UniqueViolationException if any property violates a Unique constraint.
flags() - Element in annotation interface io.objectbox.annotation.HnswIndex: See HnswFlags.
FLEX_MAP - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: A key/value map; e.g.
FLEX_VECTOR - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: A vector (aka list or array) of flexible elements; e.g.

G

GEO - Enum constant in enum class io.objectbox.annotation.VectorDistanceType: For geospatial coordinates, more specifically latitude and longitude pairs.

H

HASH - Enum constant in enum class io.objectbox.annotation.IndexType: Use a (fast non-cryptographic) hash of the property value to build the index.
HASH64 - Enum constant in enum class io.objectbox.annotation.IndexType: Use a long (fast non-cryptographic) hash of the property value to build the index.
HnswFlags - Annotation Interface in io.objectbox.annotation: Flags as a part of the HnswIndex configuration.
HnswIndex - Annotation Interface in io.objectbox.annotation: Parameters to configure HNSW-based approximate nearest neighbor (ANN) search.

I

Id - Annotation Interface in io.objectbox.annotation: Marks the ID property of an @Entity.
IdCompanion - Annotation Interface in io.objectbox.annotation: Marks a property as a companion to an @Id property.
Index - Annotation Interface in io.objectbox.annotation: Specifies that the property should be indexed.
indexingSearchCount() - Element in annotation interface io.objectbox.annotation.HnswIndex: Aka "efConstruction": the number of neighbor searched for while indexing (default: 100).
IndexType - Enum Class in io.objectbox.annotation: ObjectBox offers a value and two hash index types, from which it chooses a reasonable default (see IndexType.DEFAULT).
INT_128 - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: Representing type: ByteVector
INT_128_VECTOR - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: A vector (array) of Int128 values.
Internal - Annotation Interface in io.objectbox.annotation.apihint: APIs annotated with @Internal must NOT be used.
io.objectbox.annotation - package io.objectbox.annotation: Annotations to mark a class as an @Entity, to specify the @Id Property, to create an @Index or a @Transient Property.
io.objectbox.annotation.apihint - package io.objectbox.annotation.apihint: Annotations to mark APIs as for example @Internal or @Experimental.
io.objectbox.converter - package io.objectbox.converter: For use with @Convert: PropertyConverter to convert custom Property types.

J

JAVASCRIPT - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: JavaScript source code.
JSON - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: Placeholder (not yet used) for a JSON document.
JSON_TO_NATIVE - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: A JSON string that is converted to a native "complex" representation in the external system.

M

MONGO_BINARY - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: Representing type: ByteVector
MONGO_ID - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: The 12-byte ObjectId type in MongoDB.
MONGO_ID_VECTOR - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: A vector (array) of MongoId values.
MONGO_REGEX - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: Representing type: string vector with 2 elements (index 0: pattern, index 1: options)
MONGO_TIMESTAMP - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: Representing type: Long

N

NameInDb - Annotation Interface in io.objectbox.annotation: Allows to specify a simple name mapping for entities and properties.
neighborsPerNode() - Element in annotation interface io.objectbox.annotation.HnswIndex: Aka "M": the max number of connections per node (default: 30).

O

onConflict() - Element in annotation interface io.objectbox.annotation.Unique: The strategy to use when a conflict is detected when an object is put.

P

PropertyConverter<P,D> - Interface in io.objectbox.converter: To use custom types in your entity, implement this to convert db values to entity values and back.

R

reparationBacklinkProbability() - Element in annotation interface io.objectbox.annotation.HnswIndex: When repairing the graph after a node was removed, this gives the probability of adding backlinks to the repaired neighbors.
reparationLimitCandidates() - Element in annotation interface io.objectbox.annotation.HnswFlags: If the speed of removing nodes becomes a concern in your use case, you can speed it up by setting this flag.
REPLACE - Enum constant in enum class io.objectbox.annotation.ConflictStrategy: Any conflicting objects are deleted before the object is inserted.

S

sharedGlobalIds() - Element in annotation interface io.objectbox.annotation.Sync: Set to true to enable shared global IDs for a Sync-enabled Entity class.
Sync - Annotation Interface in io.objectbox.annotation: Enables sync for an Entity class.

T

TargetIdProperty - Annotation Interface in io.objectbox.annotation: Defines the property serving as the target ID of a ToOne.
to() - Element in annotation interface io.objectbox.annotation.Backlink: Name of the relation the backlink should be based on (e.g.
Transient - Annotation Interface in io.objectbox.annotation: Transient fields are not persisted in the database.
type() - Element in annotation interface io.objectbox.annotation.Index: Sets the IndexType, defaults to IndexType.DEFAULT.
Type - Annotation Interface in io.objectbox.annotation: Use on a property to override how its value is stored and interpreted in the database.

U

Uid - Annotation Interface in io.objectbox.annotation: UIDs identify entities (and properties) uniquely in the meta object model file (objectbox-model/default.json).
Unique - Annotation Interface in io.objectbox.annotation: Enforces that the value of a property is unique among all objects in a box before an object can be put.
Unsigned - Annotation Interface in io.objectbox.annotation: Indicates that values of an integer property (e.g.
useNoArgConstructor() - Element in annotation interface io.objectbox.annotation.Entity: Use a no-arg constructor instead of an all properties constructor (generated).
UUID - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: A UUID (Universally Unique Identifier) as defined by RFC 9562.
UUID_STRING - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: UUID represented as a string of 36 characters, e.g.
UUID_V4 - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: A UUID (Universally Unique Identifier) as defined by RFC 9562.
UUID_V4_STRING - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: Like ExternalPropertyType.UUID_STRING, but using the UUIDv4 scheme (completely random) to create new UUID.
UUID_VECTOR - Enum constant in enum class io.objectbox.annotation.ExternalPropertyType: A vector (array) of Uuid values.

V

value() - Element in annotation interface io.objectbox.annotation.DefaultValue
value() - Element in annotation interface io.objectbox.annotation.ExternalName: The name assigned to the annotated element in the external system.
value() - Element in annotation interface io.objectbox.annotation.ExternalType
value() - Element in annotation interface io.objectbox.annotation.NameInDb: Name used in the database.
value() - Element in annotation interface io.objectbox.annotation.TargetIdProperty: Name used in the database.
value() - Element in annotation interface io.objectbox.annotation.Type
value() - Element in annotation interface io.objectbox.annotation.Uid: The UID associated with an entity/property.
VALUE - Enum constant in enum class io.objectbox.annotation.IndexType: Use the property value to build the index.
valueOf(String) - Static method in enum class io.objectbox.annotation.ConflictStrategy: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.objectbox.annotation.DatabaseType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.objectbox.annotation.ExternalPropertyType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.objectbox.annotation.IndexType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.objectbox.annotation.VectorDistanceType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.objectbox.annotation.ConflictStrategy: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.objectbox.annotation.DatabaseType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.objectbox.annotation.ExternalPropertyType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.objectbox.annotation.IndexType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.objectbox.annotation.VectorDistanceType: Returns an array containing the constants of this enum class, in the order they are declared.
vectorCacheHintSizeKB() - Element in annotation interface io.objectbox.annotation.HnswIndex: A non-binding hint at the maximum size of the vector cache in KB (default: 2097152 or 2 GB/GiB).
vectorCacheSimdPaddingOff() - Element in annotation interface io.objectbox.annotation.HnswFlags: Padding for SIMD is enabled by default, which uses more memory but may be faster.
VectorDistanceType - Enum Class in io.objectbox.annotation: The vector distance algorithm used by an HnswIndex (vector search).

A B C D E F G H I J M N O P R S T U V
All Classes and Interfaces|All Packages