InvertedIndex.DocumentMapper (thomasjungblut-common 2.0.0 API)

Type Parameters:

DOCUMENT_TYPE - the type of the documents to index.

KEY_TYPE - the type of the key that will be returned (usually a smaller abstraction fragment of the document).

All Known Implementing Classes:

SparseVectorDocumentMapper

Enclosing class:

InvertedIndex<DOCUMENT_TYPE,KEY_TYPE>
```
public static interface InvertedIndex.DocumentMapper<DOCUMENT_TYPE,KEY_TYPE>
```
Mapper that maps a document to its keys.

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  java.util.Set<KEY_TYPE> mapDocument(DOCUMENT_TYPE doc)
  Maps the document into its smaller parts.

- Method Detail
  - mapDocument
```
java.util.Set<KEY_TYPE> mapDocument(DOCUMENT_TYPE doc)
```
    Maps the document into its smaller parts.
    
    Parameters:
    
    doc - the document to map.
    
    Returns:
    
    a set of keys that this document consists of.