BloomFilterRedis (bloom-filter 1.0 API)

java.lang.Object
- orestes.bloomfilter.redis.BloomFilterRedis<T>

Type Parameters:

T -

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, BloomFilter<T>
```
public class BloomFilterRedis<T>
extends java.lang.Object
implements BloomFilter<T>
```
A persistent bloom filter backed by the Redis key value store. Internally it operates on the setbit and getbit operations of Redis. If you need to remove elements from the bloom filter, please use a counting bloom filter, e.g. CountingBloomFilterRedis. The performance of this data structure is very good, as operations are grouped into fast transactions, minimizing the network overhead of all bloom filter operations to one round trip to Redis.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

BloomFilterRedis(FilterBuilder builder)

Constructors
Constructor and Description
`BloomFilterRedis(FilterBuilder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(byte[] element)` Adds the passed value to the filter.
`java.util.List<java.lang.Boolean>`	`addAll(java.util.Collection<T> elements)` Performs a bulk add operation for a collection of elements.
`void`	`clear()` Removes all elements from the filter (i.e. resets all bits to zero).
`BloomFilter<T>`	`clone()` Constructs a deep copy of the Bloom filter
`FilterBuilder`	`config()` Returns the configuration/builder of the Bloom filter.
`boolean`	`contains(byte[] element)` Tests whether an element is present in the filter (subject to the specified false positive rate).
`java.util.List<java.lang.Boolean>`	`contains(java.util.Collection<T> elements)` Bulk-tests elements for existence in the filter.
`boolean`	`equals(java.lang.Object o)`
`java.util.BitSet`	`getBitSet()` Return the underyling bit vector of the Bloom filter.
`java.lang.Double`	`getEstimatedPopulation()` Estimates the current population of the Bloom filter (see: http://en.wikipedia.org/wiki/Bloom_filter#Approximating_the_number_of_items_in_a_Bloom_filter )
`boolean`	`intersect(BloomFilter<T> other)` Performs the intersection operation on two compatible bloom filters.
`boolean`	`isEmpty()` Returns `true` if the Bloom filter does not contain any elements
`void`	`remove()` Destroys the Bloom filter by deleting its contents and metadata
`boolean`	`union(BloomFilter<T> other)` Performs the union operation on two compatible bloom filters.

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface orestes.bloomfilter.BloomFilter
add, asString, compatible, contains, containsAll, getBitsPerElement, getBitZeroProbability, getEstimatedFalsePositiveProbability, getExpectedElements, getFalsePositiveProbability, getFalsePositiveProbability, getHashes, getSize, hash, hash, population, toBytes

- Constructor Detail
  - BloomFilterRedis
```
public BloomFilterRedis(FilterBuilder builder)
```
- Method Detail
  - config
```
public FilterBuilder config()
```
    Description copied from interface: BloomFilter
    
    Returns the configuration/builder of the Bloom filter.
    
    Specified by:
    
    config in interface BloomFilter<T>
    
    Returns:
    
    the configuration/builder of the Bloom filter.
  - add
```
public boolean add(byte[] element)
```
    Description copied from interface: BloomFilter
    
    Adds the passed value to the filter.
    
    Specified by:
    
    add in interface BloomFilter<T>
    
    Parameters:
    
    element - value to add
    
    Returns:
    
    true if the value did not previously exist in the filter. Note, that a false positive may occur, thus the value may not have already been in the filter, but it hashed to a set of bits already in the filter.
  - addAll
```
public java.util.List<java.lang.Boolean> addAll(java.util.Collection<T> elements)
```
    Description copied from interface: BloomFilter
    
    Performs a bulk add operation for a collection of elements.
    
    Specified by:
    
    addAll in interface BloomFilter<T>
    
    Returns:
    
    a list of booleans indicating for each element, whether it was previously present in the filter
  - contains
```
public java.util.List<java.lang.Boolean> contains(java.util.Collection<T> elements)
```
    Description copied from interface: BloomFilter
    
    Bulk-tests elements for existence in the filter.
    
    Specified by:
    
    contains in interface BloomFilter<T>
    
    Parameters:
    
    elements - a collection of elements to test
    
    Returns:
    
    a list of booleans indicating for each element, whether it is present in the filter
  - contains
```
public boolean contains(byte[] element)
```
    Description copied from interface: BloomFilter
    
    Tests whether an element is present in the filter (subject to the specified false positive rate).
    
    Specified by:
    
    contains in interface BloomFilter<T>
    
    Returns:
    
    true if the element is contained
  - clear
```
public void clear()
```
    Description copied from interface: BloomFilter
    
    Removes all elements from the filter (i.e. resets all bits to zero).
    
    Specified by:
    
    clear in interface BloomFilter<T>
  - remove
```
public void remove()
```
    Description copied from interface: BloomFilter
    
    Destroys the Bloom filter by deleting its contents and metadata
    
    Specified by:
    
    remove in interface BloomFilter<T>
  - getBitSet
```
public java.util.BitSet getBitSet()
```
    Description copied from interface: BloomFilter
    
    Return the underyling bit vector of the Bloom filter.
    
    Specified by:
    
    getBitSet in interface BloomFilter<T>
    
    Returns:
    
    the underyling bit vector of the Bloom filter.
  - clone
```
public BloomFilter<T> clone()
```
    Description copied from interface: BloomFilter
    
    Constructs a deep copy of the Bloom filter
    
    Specified by:
    
    clone in interface BloomFilter<T>
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    a cloned Bloom filter
  - union
```
public boolean union(BloomFilter<T> other)
```
    Description copied from interface: BloomFilter
    
    Performs the union operation on two compatible bloom filters. This is achieved through a bitwise OR operation on their bit vectors. This operations is lossless, i.e. no elements are lost and the bloom filter is the same that would have resulted if all elements wer directly inserted in just one bloom filter.
    
    Specified by:
    
    union in interface BloomFilter<T>
    
    Parameters:
    
    other - the other bloom filter
    
    Returns:
    
    true if this bloom filter could successfully be updated through the union with the provided bloom filter
  - intersect
```
public boolean intersect(BloomFilter<T> other)
```
    Description copied from interface: BloomFilter
    
    Performs the intersection operation on two compatible bloom filters. This is achieved through a bitwise AND operation on their bit vectors. The operations doesn't introduce any false negatives but it does raise the false positive probability. The the false positive probability in the resulting Bloom filter is at most the false-positive probability in one of the constituent bloom filters
    
    Specified by:
    
    intersect in interface BloomFilter<T>
    
    Parameters:
    
    other - the other bloom filter
    
    Returns:
    
    true if this bloom filter could successfully be updated through the intersection with the provided bloom filter
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: BloomFilter
    
    Returns true if the Bloom filter does not contain any elements
    
    Specified by:
    
    isEmpty in interface BloomFilter<T>
    
    Returns:
    
    true if the Bloom filter does not contain any elements
  - getEstimatedPopulation
```
public java.lang.Double getEstimatedPopulation()
```
    Description copied from interface: BloomFilter
    
    Estimates the current population of the Bloom filter (see: http://en.wikipedia.org/wiki/Bloom_filter#Approximating_the_number_of_items_in_a_Bloom_filter )
    
    Specified by:
    
    getEstimatedPopulation in interface BloomFilter<T>
    
    Returns:
    
    the estimated amount of elements in the filter
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Class BloomFilterRedis<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface orestes.bloomfilter.BloomFilter

Constructor Detail

BloomFilterRedis

Method Detail

config

add

addAll

contains

contains

clear

remove

getBitSet

clone

union

intersect

isEmpty

getEstimatedPopulation

equals