org.carrot2.source.lucene

Class SimpleFieldMapper

java.lang.Object

org.carrot2.source.lucene.SimpleFieldMapper

All Implemented Interfaces:

IFieldMapper

@Bindable
public class SimpleFieldMapper
extends Object
implements IFieldMapper

A simple IFieldMapper with one-to-one mapping between the default title, url and summary fields.

Field Summary

Fields

Modifier and Type	Field and Description
String	contentField Document content field name.
int	contextFragments Number of context fragments for the highlighter.
org.apache.lucene.search.highlight.Formatter	formatter Snippet formatter for the highlighter.
String	fragmentJoin A string used to join context fragments when highlighting.
List<String>	searchFields Index search field names.
String	titleField Document title field name.
String	urlField Document URL field name.

Constructor Summary

Constructors

Constructor and Description
SimpleFieldMapper()

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getSearchFields() Return the names of search fields in the index.
void	map(org.apache.lucene.search.Query luceneQuery, org.apache.lucene.analysis.Analyzer analyzer, org.apache.lucene.document.Document luceneDoc, Document doc) Map Lucene index's fields onto Carrot2 Document instance.

Methods inherited from class java.lang.Object

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

Field Detail

titleField

@Input
@Attribute
@Processing
@Internal(configuration=true)
@Label(value="Document title field")
@Level(value=BASIC)
@Group(value="Index field mapping")
public String titleField

Document title field name.

contentField

@Input
@Attribute
@Processing
@Internal(configuration=true)
@Label(value="Document content field")
@Level(value=BASIC)
@Group(value="Index field mapping")
public String contentField

Document content field name.

urlField

@Input
@Attribute
@Processing
@Internal(configuration=true)
@Label(value="Document URL field")
@Level(value=BASIC)
@Group(value="Index field mapping")
public String urlField

Document URL field name.

searchFields

@Input
@Attribute
@Processing
@Internal(configuration=true)
@Label(value="Search fields")
@Level(value=MEDIUM)
@Group(value="Index field mapping")
public List<String> searchFields

Index search field names. If not specified, title and content fields are used.

formatter

@Input
@Attribute
@Processing
@Label(value="Formatter")
@Level(value=ADVANCED)
@Group(value="Highlighter")
public org.apache.lucene.search.highlight.Formatter formatter

Snippet formatter for the highlighter. Highlighter is not used if null.

contextFragments

@Input
@Attribute
@Processing
@IntRange(min=1)
@Label(value="Context fragments")
@Level(value=ADVANCED)
@Group(value="Highlighter")
public int contextFragments

Number of context fragments for the highlighter.

fragmentJoin

@Input
@Attribute
@Processing
@Label(value="Join string")
@Level(value=ADVANCED)
@Group(value="Highlighter")
public String fragmentJoin

A string used to join context fragments when highlighting.

Constructor Detail

SimpleFieldMapper

public SimpleFieldMapper()

Method Detail

getSearchFields

public String[] getSearchFields()

Description copied from interface: IFieldMapper

Return the names of search fields in the index.

Specified by:

getSearchFields in interface IFieldMapper

map

public void map(org.apache.lucene.search.Query luceneQuery,
       org.apache.lucene.analysis.Analyzer analyzer,
       org.apache.lucene.document.Document luceneDoc,
       Document doc)

Description copied from interface: IFieldMapper

Map Lucene index's fields onto Carrot2 Document instance. It is sensible to map at least Document.CONTENT_URL, Document.TITLE and Document.SUMMARY.

Specified by:

map in interface IFieldMapper

Parameters:

luceneQuery - Query used to fetch Lucene document from the index. It is advised to cache any query-related data internally and if this parameter does not change, reuse that data.

analyzer - Analyzer used for creating the index.

luceneDoc - Lucene hit.

doc - Target Carrot2 document.