Package org.apache.beam.runners.dataflow.internal

Class IsmFormat.Footer

java.lang.Object

org.apache.beam.runners.dataflow.internal.IsmFormat.Footer

Enclosing class:

IsmFormat

public abstract static class IsmFormat.Footer
extends Object

The footer stores the relevant information required to locate the index and bloom filter. It also stores a version byte and the number of keys stored.

The footer is encoded as the value containing:

• start of bloom filter offset (big endian long coding)
• start of shard index position offset (big endian long coding)
• number of keys in file (big endian long coding)
• 0x01 (version key as a single byte)

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FIXED_LENGTH
static final int	LONG_BYTES
static final byte	VERSION

Constructor Summary

Constructors

Constructor	Description
Footer()

Method Summary

Modifier and Type	Method	Description
abstract long	getBloomFilterPosition()
abstract long	getIndexPosition()
abstract long	getNumberOfKeys()
abstract byte	getVersion()
static IsmFormat.Footer	of(long indexPosition, long bloomFilterPosition, long numberOfKeys)

Methods inherited from class java.lang.Object

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

Field Details

LONG_BYTES

public static final int LONG_BYTES

See Also:

• Constant Field Values

FIXED_LENGTH

public static final int FIXED_LENGTH

See Also:

• Constant Field Values

VERSION

public static final byte VERSION

See Also:

• Constant Field Values

Constructor Details

Footer

public Footer()

Method Details

getVersion

public abstract byte getVersion()

getIndexPosition

public abstract long getIndexPosition()

getBloomFilterPosition

public abstract long getBloomFilterPosition()

getNumberOfKeys

public abstract long getNumberOfKeys()

of

public static IsmFormat.Footer of(long indexPosition,
 long bloomFilterPosition,
 long numberOfKeys)