org.apache.ignite.internal.commandline.indexreader

Interface IgniteIndexReaderFilePageStoreFactory

All Known Implementing Classes:

IgniteIndexReaderFilePageStoreFactoryImpl

public interface IgniteIndexReaderFilePageStoreFactory

Factory FilePageStore for analyzing partition and index files.

Method Summary

Modifier and Type	Method and Description
@Nullable FilePageStore	createFilePageStore(int partId, byte type, Collection<Throwable> errors) Creating new FilePageStore.
default @Nullable FilePageStore	createFilePageStoreWithEnsure(int partId, byte type, Collection<Throwable> errors) Creating new FilePageStore and initializing it.
default File	getFile(File dir, int partId, @Nullable String fileExt) Getting a partition or index file that may not exist.
default ByteBuffer	headerBuffer(byte type) Create buffer with header.
int	pageSize() Return page size.
int	partitionCount() Return partition count.

Method Detail

createFilePageStore

@Nullable
@Nullable FilePageStore createFilePageStore(int partId,
                                                      byte type,
                                                      Collection<Throwable> errors)
                                               throws IgniteCheckedException

Creating new FilePageStore. It can return null if partition file were not found, for example: node should not contain it by affinity.

Parameters:

partId - Partition ID.

type - Data type, can be PageIdAllocator.FLAG_IDX or PageIdAllocator.FLAG_DATA.

errors - Errors while reading partition.

Returns:

New instance of FilePageStore or null.

Throws:

IgniteCheckedException - If there are errors when creating FilePageStore.

createFilePageStoreWithEnsure

@Nullable
default @Nullable FilePageStore createFilePageStoreWithEnsure(int partId,
                                                                        byte type,
                                                                        Collection<Throwable> errors)
                                                                 throws IgniteCheckedException

Creating new FilePageStore and initializing it. It can return null if partition file were not found, for example: node should not contain it by affinity.

Parameters:

partId - Partition ID.

type - Data type, can be PageIdAllocator.FLAG_IDX or PageIdAllocator.FLAG_DATA.

errors - Errors while reading partition.

Returns:

New instance of FilePageStore or null.

Throws:

IgniteCheckedException - If there are errors when creating or initializing FilePageStore.

headerBuffer

default ByteBuffer headerBuffer(byte type)
                         throws IgniteCheckedException

Create buffer with header.

Parameters:

type - Data type, can be PageIdAllocator.FLAG_IDX or PageIdAllocator.FLAG_DATA.

Returns:

New buffer with header.

Throws:

IgniteCheckedException

getFile

default File getFile(File dir,
                     int partId,
                     @Nullable
                     @Nullable String fileExt)

Getting a partition or index file that may not exist.

Parameters:

dir - Directory to get partition or index file.

partId - ID of partition or index.

fileExt - File extension if it differs from FilePageStoreManager.FILE_SUFFIX.

Returns:

Partition or index file that may not exist.

pageSize

int pageSize()

Return page size.

Returns:

Page size.

partitionCount

int partitionCount()

Return partition count.

Returns:

Partition count.