Package io.objectbox

Class ModelBuilder.PropertyBuilder

java.lang.Object

io.objectbox.ModelBuilder.PropertyBuilder

Enclosing class:

ModelBuilder

public class ModelBuilder.PropertyBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	finished
private int	flags
private int	hnswParamsOffset
private int	id
private int	indexId
private int	indexMaxValueLength
private long	indexUid
private final int	propertyNameOffset
private int	secondaryNameOffset
private final int	targetEntityOffset
private final int	type
private long	uid
private final int	virtualTargetOffset

Constructor Summary

Constructors

Constructor	Description
PropertyBuilder(String name, String targetEntityName, String virtualTarget, int type)

Method Summary

Modifier and Type	Method	Description
private void	checkNotFinished()
int	finish()
ModelBuilder.PropertyBuilder	flags(int flags)
ModelBuilder.PropertyBuilder	hnswParams(long dimensions, Long neighborsPerNode, Long indexingSearchCount, Integer flags, Short distanceType, Float reparationBacklinkProbability, Long vectorCacheHintSizeKb)	Set parameters for HnswIndex.
ModelBuilder.PropertyBuilder	id(int id, long uid)
ModelBuilder.PropertyBuilder	indexId(int indexId, long indexUid)
ModelBuilder.PropertyBuilder	indexMaxValueLength(int indexMaxValueLength)
ModelBuilder.PropertyBuilder	secondaryName(String secondaryName)

Methods inherited from class java.lang.Object

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

Field Details

type

private final int type

virtualTargetOffset

private final int virtualTargetOffset

propertyNameOffset

private final int propertyNameOffset

targetEntityOffset

private final int targetEntityOffset

secondaryNameOffset

private int secondaryNameOffset

finished

boolean finished

flags

private int flags

id

private int id

uid

private long uid

indexId

private int indexId

indexUid

private long indexUid

indexMaxValueLength

private int indexMaxValueLength

hnswParamsOffset

private int hnswParamsOffset

Constructor Details

PropertyBuilder

PropertyBuilder(String name,
 @Nullable
 String targetEntityName,
 @Nullable
 String virtualTarget,
 int type)

Method Details

id

public ModelBuilder.PropertyBuilder id(int id,
 long uid)

indexId

public ModelBuilder.PropertyBuilder indexId(int indexId,
 long indexUid)

indexMaxValueLength

public ModelBuilder.PropertyBuilder indexMaxValueLength(int indexMaxValueLength)

hnswParams

public ModelBuilder.PropertyBuilder hnswParams(long dimensions,
 @Nullable
 Long neighborsPerNode,
 @Nullable
 Long indexingSearchCount,
 @Nullable
 Integer flags,
 @Nullable
 Short distanceType,
 @Nullable
 Float reparationBacklinkProbability,
 @Nullable
 Long vectorCacheHintSizeKb)

Set parameters for HnswIndex.

Parameters:

dimensions - see HnswIndex.dimensions().

neighborsPerNode - see HnswIndex.neighborsPerNode().

indexingSearchCount - see HnswIndex.indexingSearchCount().

flags - see HnswIndex.flags(), mapped to HnswFlags.

distanceType - see HnswIndex.distanceType(), mapped to HnswDistanceType.

reparationBacklinkProbability - see HnswIndex.reparationBacklinkProbability().

vectorCacheHintSizeKb - see HnswIndex.vectorCacheHintSizeKB().

Returns:

this builder.

flags

public ModelBuilder.PropertyBuilder flags(int flags)

secondaryName

public ModelBuilder.PropertyBuilder secondaryName(String secondaryName)

checkNotFinished

private void checkNotFinished()

finish

public int finish()