org.terrier.structures.indexing

Class CompressionFactory.CompressionConfiguration

java.lang.Object

org.terrier.structures.indexing.CompressionFactory.CompressionConfiguration

Direct Known Subclasses:

CompressionFactory.BitCompressionConfiguration, CompressionFactory.BitIdOnlyCompressionConfiguration, IntegerCodecCompressionConfiguration

Enclosing class:

CompressionFactory

public abstract static class CompressionFactory.CompressionConfiguration
extends Object

A configuration object used by the disk indexers for configuring the compression for direct and inverted files.

Since:

4.0

Author:

Craig Macdonald

Field Summary

Fields

Modifier and Type	Field and Description
protected int	fieldCount number of fields
protected String[]	fieldNames name of fields
protected int	hasBlocks is there blocks: 0 (no), 1 (yes: 1 block per token), more than 1 (blocks are for more than one token)
protected int	maxBlocks maximum number of blocks
protected String	structureName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract Class<? extends IterablePosting>	getPostingIteratorClass() What is the posting iterator class for this structure
abstract AbstractPostingOutputStream	getPostingOutputStream(String filename) Write a file of postings to the given location
abstract Class<? extends PostingIndex<?>>	getStructureClass() What is the structure class for this structure
abstract String	getStructureFileExtension() What is the file extension for this structure.
abstract Class<? extends Iterator<IterablePosting>>	getStructureInputStreamClass() What is the input stream class for this structure
void	writeIndexProperties(Index index, String pointerSourceStream) Update the index's properties for this structure

Methods inherited from class java.lang.Object

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

Field Detail

fieldCount

protected int fieldCount

number of fields

fieldNames

protected String[] fieldNames

name of fields

hasBlocks

protected int hasBlocks

is there blocks: 0 (no), 1 (yes: 1 block per token), more than 1 (blocks are for more than one token)

maxBlocks

protected int maxBlocks

maximum number of blocks

structureName

protected String structureName

Constructor Detail

CompressionConfiguration

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

Method Detail

getPostingOutputStream

public abstract AbstractPostingOutputStream getPostingOutputStream(String filename)

Write a file of postings to the given location

getPostingIteratorClass

public abstract Class<? extends IterablePosting> getPostingIteratorClass()

What is the posting iterator class for this structure

getStructureClass

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

What is the structure class for this structure

getStructureInputStreamClass

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

What is the input stream class for this structure

getStructureFileExtension

public abstract String getStructureFileExtension()

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

writeIndexProperties

public void writeIndexProperties(Index index,
                                 String pointerSourceStream)

Update the index's properties for this structure