alluxio.worker.block.annotator

Interface BlockIterator

All Known Implementing Classes:

DefaultBlockIterator, EmulatingBlockIterator

public interface BlockIterator

An interface to provide various block iteration utilities for eviction and various management tasks.

Method Summary

Modifier and Type	Method and Description
boolean	aligned(BlockStoreLocation srcLocation, BlockStoreLocation dstLocation, BlockOrder order, java.util.function.Function<Long,Boolean> blockFilterFunc) Used to detect presence of an overlap between two locations.
List<Long>	getIntersectionList(BlockStoreLocation srcLocation, BlockOrder srcOrder, BlockStoreLocation dstLocation, BlockOrder dstOrder, int intersectionWidth, BlockOrder intersectionOrder, java.util.function.Function<Long,Boolean> blockFilterFunc) Used to get blocks within an intersection of locations in sorted order.
Iterator<Long>	getIterator(BlockStoreLocation location, BlockOrder order) Gets an iterator of block-Ids.
List<BlockStoreEventListener>	getListeners() Used to acquire and register listeners that are used by this iterator.
Pair<List<Long>,List<Long>>	getSwaps(BlockStoreLocation srcLocation, BlockOrder srcOrder, BlockStoreLocation dstLocation, BlockOrder dstOrder, int swapRange, BlockOrder intersectionOrder, java.util.function.Function<Long,Boolean> blockFilterFunc) Used to list of blocks, that if swapped, could eliminate overlap between two tiers.

Method Detail

getIterator

Iterator<Long> getIterator(BlockStoreLocation location,
                           BlockOrder order)

Gets an iterator of block-Ids.

Parameters:

location - location to iterate for blocks

order - order of blocks

Returns:

an iterator

getIntersectionList

List<Long> getIntersectionList(BlockStoreLocation srcLocation,
                               BlockOrder srcOrder,
                               BlockStoreLocation dstLocation,
                               BlockOrder dstOrder,
                               int intersectionWidth,
                               BlockOrder intersectionOrder,
                               java.util.function.Function<Long,Boolean> blockFilterFunc)

Used to get blocks within an intersection of locations in sorted order. It receives a filter using which certain blocks could be excluded from intersection iterator.

Parameters:

srcLocation - source location

srcOrder - order for the source location

dstLocation - destination location

dstOrder - order for the destination location

intersectionWidth - width of intersection

intersectionOrder - the order of intersected blocks

blockFilterFunc - a filter for blocks

Returns:

list of blocks in intersection

getSwaps

Pair<List<Long>,List<Long>> getSwaps(BlockStoreLocation srcLocation,
                                     BlockOrder srcOrder,
                                     BlockStoreLocation dstLocation,
                                     BlockOrder dstOrder,
                                     int swapRange,
                                     BlockOrder intersectionOrder,
                                     java.util.function.Function<Long,Boolean> blockFilterFunc)

Used to list of blocks, that if swapped, could eliminate overlap between two tiers. It receives a filter using which certain blocks could be excluded from intersection iterator.

Parameters:

srcLocation - source location

srcOrder - order for the source location

dstLocation - destination location

dstOrder - order for the destination location

swapRange - per-tier range of swap

intersectionOrder - the order of intersected blocks

blockFilterFunc - a filter for blocks

Returns:

2 list of blocks to swap

aligned

boolean aligned(BlockStoreLocation srcLocation,
                BlockStoreLocation dstLocation,
                BlockOrder order,
                java.util.function.Function<Long,Boolean> blockFilterFunc)

Used to detect presence of an overlap between two locations. Overlap will be decided based on configured eviction order policy. It receives a filter using which certain blocks could be excluded from overlap decision.

Parameters:

srcLocation - source location

dstLocation - destination location

order - order of comparison between locations

blockFilterFunc - a filter for blocks

Returns:

true if tiers are aligned

getListeners

List<BlockStoreEventListener> getListeners()

Used to acquire and register listeners that are used by this iterator.

Returns:

list of event listeners