org.exist.storage
Interface Indexable

All Superinterfaces:

Comparable

All Known Implementing Classes:

AbstractDateTimeValue, AnyURIValue, AtomicValue, Base64Binary, BinaryValue, BooleanValue, ComputableValue, DateTimeValue, DateValue, DayTimeDurationValue, DecimalValue, DoubleValue, DurationValue, FloatValue, FunctionReference, GDayValue, GMonthDayValue, GMonthValue, GYearMonthValue, GYearValue, HexBinary, IntegerValue, JavaObjectValue, NumericValue, QNameValue, StringValue, TimeValue, UntypedAtomicValue, YearMonthDurationValue

public interface Indexable
extends Comparable

This interface should be implemented by all basic types to be used as keys in a value index.

Author:

wolf

See Also:

NativeValueIndex

Method Summary

int	getType() Returns the type of the Indexable as one of the constants defined in Type.
byte[]	serializeValue(int offset) Serialize the value to an array of bytes for the persistant storage.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

serializeValue

byte[] serializeValue(int offset)
                      throws EXistException

Serialize the value to an array of bytes for the persistant storage. The returned byte array has the following format: (offset-1 free bytes, byte type, byte[] value)

Parameters:

offset - starting index for writing in array data

Returns:

the size actually writen in the array argument

Throws:

EXistException

getType

int getType()

Returns the type of the Indexable as one of the constants defined in Type.

Returns:

Type of the Indexable