ivory.bloomir.data

Class BloomConfig

java.lang.Object

ivory.bloomir.data.BloomConfig

All Implemented Interfaces:

Writable

public class BloomConfig
extends Object
implements Writable

A configuration of parameters for an experiment.

Author:

Nima Asadi

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILE Filename where the configuration parameters are stored.

Constructor Summary

Constructors

Constructor and Description
BloomConfig(int nbDocuments, int nbTerms, int nbHash, int bitsPerElement) Creates a new configuration object.

Method Summary

Methods

Modifier and Type	Method and Description
int	getBitsPerElement()
int	getDocumentCount()
int	getHashCount()
int	getIdentityHashThreshold()
int	getTermCount()
void	readFields(DataInput in)
static BloomConfig	readInstance(DataInput in) Reads and returns an instance of the configuration object.
void	write(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_FILE

public static final String CONFIG_FILE

Filename where the configuration parameters are stored.

See Also:

Constant Field Values

Constructor Detail

BloomConfig

public BloomConfig(int nbDocuments,
           int nbTerms,
           int nbHash,
           int bitsPerElement)

Creates a new configuration object.

Parameters:

nbDocuments - Number of documents in the collection

nbTerms - Number of unique terms in the collection

nbHash - Number of Hash functions

bitsPerElement - Number of bit positions per element

Method Detail

getBitsPerElement

public int getBitsPerElement()

Returns:

The number of bit positions per element.

getDocumentCount

public int getDocumentCount()

Returns:

The number of documents in the collection.

getHashCount

public int getHashCount()

Returns:

The number of hash functions.

getIdentityHashThreshold

public int getIdentityHashThreshold()

Returns:

The identity hash function threshold (\theta_I)

getTermCount

public int getTermCount()

Returns:

The number of unique terms in the collection.

readFields

public void readFields(DataInput in)
                throws IOException

Specified by:

readFields in interface Writable

Throws:

IOException

readInstance

public static BloomConfig readInstance(DataInput in)
                                throws IOException

Reads and returns an instance of the configuration object.

Parameters:

in - DataInput stream

Returns:

A BloomConfig object containing all the necessary parameters to run an experiment

Throws:

IOException

write

public void write(DataOutput out)
           throws IOException

Specified by:

write in interface Writable

Throws:

IOException