Package org.apache.polaris.persistence.nosql.api.obj

Interface ObjRef

@PolarisImmutable
public interface ObjRef

Describes a reference to an object.

Note that the persisted object key is just the integer ID, the object type and numParts() attributes are rather hints.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ObjRef.ObjRefDeserializer
static class	ObjRef.ObjRefSerializer

Field Summary

Fields

Modifier and Type	Field	Description
static final IndexValueSerializer<ObjRef>	OBJ_REF_SERIALIZER

Method Summary

Modifier and Type	Method	Description
static ObjRef	fromByteBuffer(ByteBuffer bytes)
static ObjRef	fromBytes(byte[] bytes)
long	id()	Numeric ID of this object reference.
int	numParts()	Indicates the number of parts of which the object is split in the backing database.
static ObjRef	objRef(String type, long id)
static ObjRef	objRef(String type, long id, int partNum)
static ObjRef	objRef(Obj obj)
static ObjRef	objRef(ObjType type, long id)
static ObjRef	objRef(ObjType type, long id, int partNum)
static int	serializedNullSize()
default int	serializedSize()
static ByteBuffer	serializeNullToByteBuffer(ByteBuffer target)
default ByteBuffer	serializeToByteBuffer(ByteBuffer bytes)
static ByteBuffer	skipObjId(ByteBuffer bytes)
default ByteBuffer	toByteBuffer()
default byte[]	toBytes()
String	type()	Object type ID this object reference refers to.

Field Details

OBJ_REF_SERIALIZER

static final IndexValueSerializer<ObjRef> OBJ_REF_SERIALIZER

Method Details

objRef

static ObjRef objRef(@Nonnull
 String type,
 long id,
 int partNum)

objRef

static ObjRef objRef(@Nonnull
 ObjType type,
 long id,
 int partNum)

objRef

static ObjRef objRef(@Nonnull
 String type,
 long id)

objRef

static ObjRef objRef(@Nonnull
 ObjType type,
 long id)

objRef

static ObjRef objRef(@Nonnull
 Obj obj)

type

@Parameter(order=1)
String type()

Object type ID this object reference refers to.

id

@Parameter(order=2)
long id()

Numeric ID of this object reference.

numParts

@Parameter(order=3)
@Auxiliary
int numParts()

Indicates the number of parts of which the object is split in the backing database. This value is available after the object has been written.

This value is rather a hint than a strictly correct value. This value should be correct, but Persistence implementations must expect the case that the real number of written parts is different.

toByteBuffer

default ByteBuffer toByteBuffer()

serializedNullSize

static int serializedNullSize()

serializedSize

default int serializedSize()

serializeNullToByteBuffer

static ByteBuffer serializeNullToByteBuffer(ByteBuffer target)

serializeToByteBuffer

default ByteBuffer serializeToByteBuffer(ByteBuffer bytes)

toBytes

default byte[] toBytes()

skipObjId

static ByteBuffer skipObjId(@Nonnull
 ByteBuffer bytes)

fromByteBuffer

static ObjRef fromByteBuffer(ByteBuffer bytes)

fromBytes

static ObjRef fromBytes(byte[] bytes)