org.carrot2.source.lucene

Class SimpleFieldMapperDescriptor.AttributeBuilder

java.lang.Object

org.carrot2.source.lucene.SimpleFieldMapperDescriptor.AttributeBuilder

Enclosing class:

SimpleFieldMapperDescriptor

public static class SimpleFieldMapperDescriptor.AttributeBuilder
extends Object

Attribute map builder for the SimpleFieldMapper component. You can use this builder as a type-safe alternative to populating the attribute map using attribute keys.

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Object>	map The attribute map populated by this builder.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleFieldMapperDescriptor.AttributeBuilder(Map<String,Object> map) Creates a builder backed by the provided map.

Method Summary

Methods

Modifier and Type	Method and Description
SimpleFieldMapperDescriptor.AttributeBuilder	contentField(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Document content field name.
SimpleFieldMapperDescriptor.AttributeBuilder	contentField(String value) Document content field name.
SimpleFieldMapperDescriptor.AttributeBuilder	contextFragments(int value) Number of context fragments for the highlighter.
SimpleFieldMapperDescriptor.AttributeBuilder	contextFragments(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value) Number of context fragments for the highlighter.
SimpleFieldMapperDescriptor.AttributeBuilder	formatter(Class<?> clazz) Snippet formatter for the highlighter.
SimpleFieldMapperDescriptor.AttributeBuilder	formatter(org.apache.lucene.search.highlight.Formatter value) Snippet formatter for the highlighter.
SimpleFieldMapperDescriptor.AttributeBuilder	formatter(org.carrot2.util.attribute.IObjectFactory<? extends org.apache.lucene.search.highlight.Formatter> value) Snippet formatter for the highlighter.
SimpleFieldMapperDescriptor.AttributeBuilder	fragmentJoin(org.carrot2.util.attribute.IObjectFactory<? extends String> value) A string used to join context fragments when highlighting.
SimpleFieldMapperDescriptor.AttributeBuilder	fragmentJoin(String value) A string used to join context fragments when highlighting.
SimpleFieldMapperDescriptor.AttributeBuilder	searchFields(org.carrot2.util.attribute.IObjectFactory<? extends List<String>> value) Index search field names.
SimpleFieldMapperDescriptor.AttributeBuilder	searchFields(List<String> value) Index search field names.
SimpleFieldMapperDescriptor.AttributeBuilder	titleField(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Document title field name.
SimpleFieldMapperDescriptor.AttributeBuilder	titleField(String value) Document title field name.
SimpleFieldMapperDescriptor.AttributeBuilder	urlField(org.carrot2.util.attribute.IObjectFactory<? extends String> value) Document URL field name.
SimpleFieldMapperDescriptor.AttributeBuilder	urlField(String value) Document URL field name.

Methods inherited from class java.lang.Object

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

Field Detail

map

public final Map<String,Object> map

The attribute map populated by this builder.

Constructor Detail

SimpleFieldMapperDescriptor.AttributeBuilder

protected SimpleFieldMapperDescriptor.AttributeBuilder(Map<String,Object> map)

Creates a builder backed by the provided map.

Method Detail

titleField

public SimpleFieldMapperDescriptor.AttributeBuilder titleField(String value)

Document title field name.

See Also:

SimpleFieldMapper.titleField

titleField

public SimpleFieldMapperDescriptor.AttributeBuilder titleField(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Document title field name.

See Also:

SimpleFieldMapper.titleField

contentField

public SimpleFieldMapperDescriptor.AttributeBuilder contentField(String value)

Document content field name.

See Also:

SimpleFieldMapper.contentField

contentField

public SimpleFieldMapperDescriptor.AttributeBuilder contentField(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Document content field name.

See Also:

SimpleFieldMapper.contentField

urlField

public SimpleFieldMapperDescriptor.AttributeBuilder urlField(String value)

Document URL field name.

See Also:

SimpleFieldMapper.urlField

urlField

public SimpleFieldMapperDescriptor.AttributeBuilder urlField(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

Document URL field name.

See Also:

SimpleFieldMapper.urlField

searchFields

public SimpleFieldMapperDescriptor.AttributeBuilder searchFields(List<String> value)

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

See Also:

SimpleFieldMapper.searchFields

searchFields

public SimpleFieldMapperDescriptor.AttributeBuilder searchFields(org.carrot2.util.attribute.IObjectFactory<? extends List<String>> value)

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

See Also:

SimpleFieldMapper.searchFields

formatter

public SimpleFieldMapperDescriptor.AttributeBuilder formatter(org.apache.lucene.search.highlight.Formatter value)

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

See Also:

SimpleFieldMapper.formatter

formatter

public SimpleFieldMapperDescriptor.AttributeBuilder formatter(Class<?> clazz)

Snippet formatter for the highlighter. Highlighter is not used if null. A class that extends org.apache.lucene.search.highlight.Formatter or appropriate IObjectFactory.

See Also:

SimpleFieldMapper.formatter

formatter

public SimpleFieldMapperDescriptor.AttributeBuilder formatter(org.carrot2.util.attribute.IObjectFactory<? extends org.apache.lucene.search.highlight.Formatter> value)

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

See Also:

SimpleFieldMapper.formatter

contextFragments

public SimpleFieldMapperDescriptor.AttributeBuilder contextFragments(int value)

Number of context fragments for the highlighter.

See Also:

SimpleFieldMapper.contextFragments

contextFragments

public SimpleFieldMapperDescriptor.AttributeBuilder contextFragments(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)

Number of context fragments for the highlighter.

See Also:

SimpleFieldMapper.contextFragments

fragmentJoin

public SimpleFieldMapperDescriptor.AttributeBuilder fragmentJoin(String value)

A string used to join context fragments when highlighting.

See Also:

SimpleFieldMapper.fragmentJoin

fragmentJoin

public SimpleFieldMapperDescriptor.AttributeBuilder fragmentJoin(org.carrot2.util.attribute.IObjectFactory<? extends String> value)

A string used to join context fragments when highlighting.

See Also:

SimpleFieldMapper.fragmentJoin