org.apache.accumulo.core.iterators.user
public class IndexedDocIterator extends IntersectingIterator
IntersectingIterator.TermSource
Modifier and Type | Field and Description |
---|---|
static org.apache.hadoop.io.Text |
DEFAULT_DOC_COLF |
static org.apache.hadoop.io.Text |
DEFAULT_INDEX_COLF |
SortedKeyValueIterator<Key,Value> |
docSource |
currentDocID, currentPartition, log, nullText, sources, topKey, value
Constructor and Description |
---|
IndexedDocIterator() |
Modifier and Type | Method and Description |
---|---|
protected void |
advanceToIntersection() |
protected Key |
buildDocKey() |
protected Key |
buildKey(org.apache.hadoop.io.Text partition,
org.apache.hadoop.io.Text term) |
protected Key |
buildKey(org.apache.hadoop.io.Text partition,
org.apache.hadoop.io.Text term,
org.apache.hadoop.io.Text docID) |
SortedKeyValueIterator<Key,Value> |
deepCopy(IteratorEnvironment env)
Creates a deep copy of this iterator as though seek had not yet been called.
|
protected org.apache.hadoop.io.Text |
getDocID(Key key) |
protected org.apache.hadoop.io.Text |
getTerm(Key key) |
void |
init(SortedKeyValueIterator<Key,Value> source,
Map<String,String> options,
IteratorEnvironment env)
Initializes the iterator.
|
static org.apache.hadoop.io.Text |
parseDocID(Key key) |
void |
seek(Range range,
Collection<ByteSequence> seekColumnFamilies,
boolean inclusive)
Seeks to the first key in the Range, restricting the resulting K,V pairs to those with the specified columns.
|
static void |
setColfs(IteratorSetting is,
String indexColf,
String docColfPrefix)
A convenience method for setting the index column family and document column family prefix.
|
static void |
setDocColfPrefix(IteratorSetting is,
String docColfPrefix)
A convenience method for setting the document column family prefix.
|
static void |
setIndexColf(IteratorSetting is,
String indexColf)
A convenience method for setting the index column family.
|
addSource, buildFollowingPartitionKey, decodeBooleans, decodeColumns, encodeBooleans, encodeColumns, getPartition, getTopKey, getTopValue, hasTop, next, setColumnFamilies, setColumnFamilies, stringTopKey
public static final org.apache.hadoop.io.Text DEFAULT_INDEX_COLF
public static final org.apache.hadoop.io.Text DEFAULT_DOC_COLF
public SortedKeyValueIterator<Key,Value> docSource
protected Key buildKey(org.apache.hadoop.io.Text partition, org.apache.hadoop.io.Text term, org.apache.hadoop.io.Text docID)
buildKey
in class IntersectingIterator
protected Key buildKey(org.apache.hadoop.io.Text partition, org.apache.hadoop.io.Text term)
buildKey
in class IntersectingIterator
protected org.apache.hadoop.io.Text getDocID(Key key)
getDocID
in class IntersectingIterator
public static org.apache.hadoop.io.Text parseDocID(Key key)
protected org.apache.hadoop.io.Text getTerm(Key key)
getTerm
in class IntersectingIterator
public void init(SortedKeyValueIterator<Key,Value> source, Map<String,String> options, IteratorEnvironment env) throws IOException
SortedKeyValueIterator
init
in interface SortedKeyValueIterator<Key,Value>
init
in class IntersectingIterator
source
- SortedKeyValueIterator source to read data from.options
- Map map of string option names to option values.env
- IteratorEnvironment environment in which iterator is being run.IOException
- unused.public SortedKeyValueIterator<Key,Value> deepCopy(IteratorEnvironment env)
SortedKeyValueIterator
deepCopy
in interface SortedKeyValueIterator<Key,Value>
deepCopy
in class IntersectingIterator
env
- IteratorEnvironment environment in which iterator is being run.public void seek(Range range, Collection<ByteSequence> seekColumnFamilies, boolean inclusive) throws IOException
SortedKeyValueIterator
SortedKeyValueIterator.init(org.apache.accumulo.core.iterators.SortedKeyValueIterator, java.util.Map, org.apache.accumulo.core.iterators.IteratorEnvironment)
is called.
Iterators that examine groups of adjacent key/value pairs (e.g. rows) to determine their top key and value should be sure that they properly handle a seek
to a key in the middle of such a group (e.g. the middle of a row). Even if the client always seeks to a range containing an entire group (a,c), the tablet
server could send back a batch of entries corresponding to (a,b], then reseek the iterator to range (b,c) when the scan is continued.
columnFamilies
is used, at the lowest level, to determine which data blocks inside of an RFile need to be opened for this iterator. This set of data
blocks is also the set of locality groups defined for the given table. If no columnFamilies are provided, the data blocks for all locality groups inside of
the correct RFile will be opened and seeked in an attempt to find the correct start key, regardless of the startKey in the range
.
In an Accumulo instance in which multiple locality groups exist for a table, it is important to ensure that columnFamilies
is properly set to the
minimum required column families to ensure that data from separate locality groups is not inadvertently read.seek
in interface SortedKeyValueIterator<Key,Value>
seek
in class IntersectingIterator
range
- Range of keys to iterate over.seekColumnFamilies
- Collection of column families to include or exclude.inclusive
- boolean that indicates whether to include (true) or exclude (false) column families.IOException
- if an I/O error occurs.protected void advanceToIntersection() throws IOException
advanceToIntersection
in class IntersectingIterator
IOException
protected Key buildDocKey()
public static void setIndexColf(IteratorSetting is, String indexColf)
is
- IteratorSetting object to configure.indexColf
- the index column familypublic static void setDocColfPrefix(IteratorSetting is, String docColfPrefix)
is
- IteratorSetting object to configure.docColfPrefix
- the prefix of the document column family (colf will be of the form docColfPrefix\0doctype)public static void setColfs(IteratorSetting is, String indexColf, String docColfPrefix)
is
- IteratorSetting object to configure.indexColf
- the index column familydocColfPrefix
- the prefix of the document column family (colf will be of the form docColfPrefix\0doctype)Copyright © 2014 Apache Accumulo Project. All Rights Reserved.