org.carrot2.input.lucene
Class LuceneLocalInputComponentFactoryConfig

java.lang.Object
  org.carrot2.input.lucene.LuceneLocalInputComponentFactoryConfig

public final class LuceneLocalInputComponentFactoryConfig
extends Object

All settings required for the lucene input component factory: searched fields, analyzer, summarizer config etc.

Author:

Dawid Weiss, Sairaj Sunil, Stanislaw Osinski

Nested Class Summary

static class

LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig Setting of the Lucene's snippet generator to be used on the summary field.

Field Summary

static LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig	LONG_PLAIN_TEXT_SUMMARY A Lucene summarizer config that enables longer (up to 4 fragments) plain text summaries (no highlighting of query terms).
static LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig	NO_SUMMARIES A Lucene summarizer config that completely switches off the snippet generation.
(package private) String[]	searchFields Lucene fields to be searched
static LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig	SHORT_HTML_SUMMARY A Lucene summarizer config that enables short (one fragment) summaries with HTML tags enclosing query term occurrences.
(package private) LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig	summarizerConfig Config of the summarization to be applied to the summary field
(package private) String	summaryField
(package private) String	titleField Content fields
(package private) String	urlField

Constructor Summary

LuceneLocalInputComponentFactoryConfig(String[] searchFields, String titleField, String summaryField, String urlField)
Creates a default Lucene search config with summarization switched off.

LuceneLocalInputComponentFactoryConfig(String[] searchFields, String titleField, String summaryField, String urlField, LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig summarizerConfig)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

searchFields

final String[] searchFields

Lucene fields to be searched

titleField

final String titleField

Content fields

summaryField

final String summaryField

urlField

final String urlField

summarizerConfig

final LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig summarizerConfig

Config of the summarization to be applied to the summary field

NO_SUMMARIES

public static final LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig NO_SUMMARIES

A Lucene summarizer config that completely switches off the snippet generation. With this config, the full content of the summary field will be passed for clustering.

SHORT_HTML_SUMMARY

public static final LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig SHORT_HTML_SUMMARY

A Lucene summarizer config that enables short (one fragment) summaries with HTML tags enclosing query term occurrences.

LONG_PLAIN_TEXT_SUMMARY

public static final LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig LONG_PLAIN_TEXT_SUMMARY

A Lucene summarizer config that enables longer (up to 4 fragments) plain text summaries (no highlighting of query terms).

Constructor Detail

LuceneLocalInputComponentFactoryConfig

public LuceneLocalInputComponentFactoryConfig(String[] searchFields,
                                              String titleField,
                                              String summaryField,
                                              String urlField)

Creates a default Lucene search config with summarization switched off.

LuceneLocalInputComponentFactoryConfig

public LuceneLocalInputComponentFactoryConfig(String[] searchFields,
                                              String titleField,
                                              String summaryField,
                                              String urlField,
                                              LuceneLocalInputComponentFactoryConfig.LuceneSummarizerConfig summarizerConfig)