org.apache.hudi.common.util.hash

Class HoodieIndexID

java.lang.Object

org.apache.hudi.common.util.hash.HoodieIndexID

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ColumnIndexID, FileIndexID, PartitionIndexID

public abstract class HoodieIndexID
extends Object
implements Serializable

A serializable ID that can be used to identify any Hoodie table fields and resources in the on-disk index.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HoodieIndexID.Type Supported ID types.

Constructor Summary

Constructors

Constructor and Description
HoodieIndexID()

Method Summary

Modifier and Type	Method and Description
String	asBase64EncodedString() Get the Base64 encoded version of the ID.
abstract byte[]	asBytes() Get this ID as a byte array.
abstract int	bits() Get the number of bits representing this ID in memory.
abstract String	getName() Get the resource name for which this index id is generated.
protected abstract HoodieIndexID.Type	getType() Get the ID type.
boolean	isColumnID() Is this ID a ColumnID type ?
boolean	isFileID() Is this ID a FileID type ?
boolean	isPartition() Is this ID a Partition type ?
abstract String	toString() Get the String version of this ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

HoodieIndexID

public HoodieIndexID()

Method Detail

getName

public abstract String getName()

Get the resource name for which this index id is generated.

Returns:

The resource name

bits

public abstract int bits()

Get the number of bits representing this ID in memory.

Note: Will be in multiples of 8 only.

Returns:

The number of bits in this ID

asBytes

public abstract byte[] asBytes()

Get this ID as a byte array.

Returns:

A byte array representing this ID

toString

public abstract String toString()

Get the String version of this ID.

Overrides:

toString in class Object

Returns:

String version of this ID.

asBase64EncodedString

public String asBase64EncodedString()

Get the Base64 encoded version of the ID.

getType

protected abstract HoodieIndexID.Type getType()

Get the ID type.

Returns:

This ID type

isColumnID

public final boolean isColumnID()

Is this ID a ColumnID type ?

Returns:

True if this ID of ColumnID type

isPartition

public final boolean isPartition()

Is this ID a Partition type ?

Returns:

True if this ID of PartitionID type

isFileID

public final boolean isFileID()

Is this ID a FileID type ?

Returns:

True if this ID of FileID type