SampleIterator (Apache Accumulo Core 3.0.0 API)

java.lang.Object
- org.apache.accumulo.core.iterators.WrappingIterator
- - org.apache.accumulo.core.iterators.Filter
  - - org.apache.accumulo.core.iteratorsImpl.system.SampleIterator

All Implemented Interfaces:

OptionDescriber, SortedKeyValueIterator<Key,Value>, YieldingKeyValueIterator<Key,Value>
```
public class SampleIterator
extends Filter
```

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.accumulo.core.iterators.OptionDescriber
  OptionDescriber.IteratorOptions

Field Summary
- Fields inherited from class org.apache.accumulo.core.iterators.Filter
  NEGATE

Constructor Summary

Constructors
Constructor Description

SampleIterator(SortedKeyValueIterator<Key,Value> iter, Sampler sampler)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`accept(Key k, Value v)`
`SortedKeyValueIterator<Key,Value>`	`deepCopy(IteratorEnvironment env)`	Creates a deep copy of this iterator as though seek had not yet been called.

Methods inherited from class org.apache.accumulo.core.iterators.Filter
describeOptions, findTop, init, next, seek, setNegate, validateOptions

Methods inherited from class org.apache.accumulo.core.iterators.WrappingIterator
getSource, getTopKey, getTopValue, hasTop, isRunningLowOnMemory, setSource

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

Methods inherited from interface org.apache.accumulo.core.iterators.YieldingKeyValueIterator
enableYielding

- Constructor Detail
  - SampleIterator
```
public SampleIterator(SortedKeyValueIterator<Key,Value> iter,
                      Sampler sampler)
```
- Method Detail
  - accept
```
public boolean accept(Key k,
                      Value v)
```
    Specified by:
    
    accept in class Filter
    
    Returns:
    
    true if the key/value pair is accepted by the filter.
  - deepCopy
```
public SortedKeyValueIterator<Key,Value> deepCopy(IteratorEnvironment env)
```
    Description copied from interface: SortedKeyValueIterator
    
    Creates a deep copy of this iterator as though seek had not yet been called. init should be called on an iterator before deepCopy is called. init should not need to be called on the copy that is returned by deepCopy; that is, when necessary init should be called in the deepCopy method on the iterator it returns. The behavior is unspecified if init is called after deepCopy either on the original or the copy. A proper implementation would call deepCopy on the source.
    
    Specified by:
    
    deepCopy in interface SortedKeyValueIterator<Key,Value>
    
    Overrides:
    
    deepCopy in class Filter
    
    Parameters:
    
    env - IteratorEnvironment environment in which iterator is being run, provided by Accumulo itself and is expected to be non-null.
    
    Returns:
    
    SortedKeyValueIterator a copy of this iterator (with the same source and settings).