org.terrier.structures.integer

Class IntegerCodecCompressionConfiguration

java.lang.Object

org.terrier.structures.indexing.CompressionFactory.CompressionConfiguration

org.terrier.structures.integer.IntegerCodecCompressionConfiguration

public class IntegerCodecCompressionConfiguration
extends CompressionFactory.CompressionConfiguration

Properties:

• compression."STRUCTURENAME".integer."TYPE".codec - the compression codec to use for the structure STRUCTURENAME for posting payload type TYPE - see IntegerCodec.

For instance, to full compress everything in the inverted index using Frame of Reference (FOR), as recommended by Catena et al, ECIR 2014, you would set the following properties:

 index.structureName.compression.integer.ids.codec=LemireFORVBCodec
 index.structureName.compression.integer.tfs.codec=LemireFORVBCodec
 index.structureName.compression.integer.fields.codec=LemireFORVBCodec
 index.structureName.compression.integer.blocks.codec=LemireFORVBCodec
 indexing.compression.configuration=IntegerCodecCompressionConfiguration
 index.structureName.compression.integer.chunk.size=1024
 

Since:

4.0

Author:

Craig Macdonald

Field Summary

Fields inherited from class org.terrier.structures.indexing.CompressionFactory.CompressionConfiguration

fieldCount, fieldNames, hasBlocks, maxBlocks, structureName

Constructor Summary

Constructors

Constructor and Description
IntegerCodecCompressionConfiguration(String structureName, String[] fieldNames, int hasBlocks, int maxBlocks)

Method Summary

Modifier and Type	Method and Description
Class<? extends IterablePosting>	getPostingIteratorClass() What is the posting iterator class for this structure
AbstractPostingOutputStream	getPostingOutputStream(String filename) Write a file of postings to the given location
Class<? extends PostingIndex<?>>	getStructureClass() What is the structure class for this structure
String	getStructureFileExtension() What is the file extension for this structure.
Class<? extends Iterator<IterablePosting>>	getStructureInputStreamClass() What is the input stream class for this structure
static IntegerCodec	loadCodec(String className)
IntegerCodec	loadCodecForType(String type)
String	toString()
void	writeIndexProperties(Index index, String pointerSourceStreamStructureName) Update the index's properties for this structure
protected void	writeProperties(Properties p)

Methods inherited from class java.lang.Object

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

Constructor Detail

IntegerCodecCompressionConfiguration

public IntegerCodecCompressionConfiguration(String structureName,
                                            String[] fieldNames,
                                            int hasBlocks,
                                            int maxBlocks)

Method Detail

loadCodec

public static IntegerCodec loadCodec(String className)
                              throws Exception

Throws:

Exception

loadCodecForType

public IntegerCodec loadCodecForType(String type)
                              throws Exception

Throws:

Exception

getPostingOutputStream

public AbstractPostingOutputStream getPostingOutputStream(String filename)

Description copied from class: CompressionFactory.CompressionConfiguration

Write a file of postings to the given location

Specified by:

getPostingOutputStream in class CompressionFactory.CompressionConfiguration

writeProperties

protected void writeProperties(Properties p)

getPostingIteratorClass

public Class<? extends IterablePosting> getPostingIteratorClass()

Description copied from class: CompressionFactory.CompressionConfiguration

What is the posting iterator class for this structure

Specified by:

getPostingIteratorClass in class CompressionFactory.CompressionConfiguration

getStructureClass

public Class<? extends PostingIndex<?>> getStructureClass()

Description copied from class: CompressionFactory.CompressionConfiguration

What is the structure class for this structure

Specified by:

getStructureClass in class CompressionFactory.CompressionConfiguration

getStructureInputStreamClass

public Class<? extends Iterator<IterablePosting>> getStructureInputStreamClass()

Description copied from class: CompressionFactory.CompressionConfiguration

What is the input stream class for this structure

Specified by:

getStructureInputStreamClass in class CompressionFactory.CompressionConfiguration

getStructureFileExtension

public String getStructureFileExtension()

Description copied from class: CompressionFactory.CompressionConfiguration

What is the file extension for this structure. Usually ".bf" for BitFile and ".if" for files containing compressed integers

Specified by:

getStructureFileExtension in class CompressionFactory.CompressionConfiguration

writeIndexProperties

public void writeIndexProperties(Index index,
                                 String pointerSourceStreamStructureName)

Description copied from class: CompressionFactory.CompressionConfiguration

Update the index's properties for this structure

Overrides:

writeIndexProperties in class CompressionFactory.CompressionConfiguration

toString

public String toString()

Overrides:

toString in class Object