Package org.apache.jackrabbit.oak.index.indexer.document.indexstore

Class IndexStoreUtils

java.lang.Object

org.apache.jackrabbit.oak.index.indexer.document.indexstore.IndexStoreUtils

public class IndexStoreUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static String	METADATA_SUFFIX
static String	OAK_INDEXER_USE_LZ4
static String	OAK_INDEXER_USE_ZIP

Constructor Summary

Constructors

Constructor	Description
IndexStoreUtils()

Method Summary

Modifier and Type	Method	Description
static Compression	compressionAlgorithm()
static boolean	compressionEnabled()
static OutputStream	createOutputStream(Path file, Compression algorithm)
static BufferedReader	createReader(File file, boolean compressionEnabled)	This function by default uses GNU zip as compression algorithm for backward compatibility.
static BufferedReader	createReader(File file, Compression algorithm)
static BufferedWriter	createWriter(File file, boolean compressionEnabled)	This function by default uses GNU zip as compression algorithm for backward compatibility.
static BufferedWriter	createWriter(File file, Compression algorithm)
static File	getMetadataFile(File indexStoreFile, Compression algorithm)
static String	getMetadataFileName(Compression algorithm)
static String	getSortedStoreFileName(Compression algorithm)
static long	sizeOf(List<File> sortedFiles)
static boolean	useLZ4()
static void	validateFlatFileStoreFileName(File file, @NotNull Compression algorithm)	This method validates the compression suffix is in correspondence with compression algorithm.

Methods inherited from class java.lang.Object

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

Field Detail

METADATA_SUFFIX

public static final String METADATA_SUFFIX

See Also:

Constant Field Values

OAK_INDEXER_USE_ZIP

public static final String OAK_INDEXER_USE_ZIP

See Also:

Constant Field Values

OAK_INDEXER_USE_LZ4

public static final String OAK_INDEXER_USE_LZ4

See Also:

Constant Field Values

Constructor Detail

IndexStoreUtils

public IndexStoreUtils()

Method Detail

compressionEnabled

public static boolean compressionEnabled()

useLZ4

public static boolean useLZ4()

compressionAlgorithm

public static Compression compressionAlgorithm()

createReader

public static BufferedReader createReader(File file,
                                          boolean compressionEnabled)

This function by default uses GNU zip as compression algorithm for backward compatibility.

createReader

public static BufferedReader createReader(File file,
                                          Compression algorithm)

createWriter

public static BufferedWriter createWriter(File file,
                                          boolean compressionEnabled)
                                   throws IOException

This function by default uses GNU zip as compression algorithm for backward compatibility.

Throws:

IOException

createWriter

public static BufferedWriter createWriter(File file,
                                          Compression algorithm)
                                   throws IOException

Throws:

IOException

createOutputStream

public static OutputStream createOutputStream(Path file,
                                              Compression algorithm)
                                       throws IOException

Throws:

IOException

sizeOf

public static long sizeOf(List<File> sortedFiles)

getSortedStoreFileName

public static String getSortedStoreFileName(Compression algorithm)

getMetadataFileName

public static String getMetadataFileName(Compression algorithm)

getMetadataFile

public static File getMetadataFile(File indexStoreFile,
                                   Compression algorithm)

validateFlatFileStoreFileName

public static void validateFlatFileStoreFileName(File file,
                                                 @NotNull
                                                 @NotNull Compression algorithm)

This method validates the compression suffix is in correspondence with compression algorithm.