LuceneDocumentSourceDescriptor.AttributeBuilder (Carrot2 v3.8.0 API Documentation (JavaDoc))

java.lang.Object
- org.carrot2.source.lucene.LuceneDocumentSourceDescriptor.AttributeBuilder

Enclosing class:

LuceneDocumentSourceDescriptor
```
public static class LuceneDocumentSourceDescriptor.AttributeBuilder
extends Object
```
Attribute map builder for the LuceneDocumentSource 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.

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 LuceneDocumentSourceDescriptor.AttributeBuilder(Map<String,Object> map)
Creates a builder backed by the provided map.

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

Method Summary

Methods
Modifier and Type	Method and Description
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`analyzer(org.apache.lucene.analysis.Analyzer value)` `Analyzer` used at indexing time.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`analyzer(Class<?> clazz)` `Analyzer` used at indexing time.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`analyzer(org.carrot2.util.attribute.IObjectFactory<? extends org.apache.lucene.analysis.Analyzer> value)` `Analyzer` used at indexing time.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`directory(Class<?> clazz)` Search index `Directory`.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`directory(org.apache.lucene.store.Directory value)` Search index `Directory`.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`directory(org.carrot2.util.attribute.IObjectFactory<? extends org.apache.lucene.store.Directory> value)` Search index `Directory`.
`Collection<Document>`	`documents()`
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`fieldMapper(Class<?> clazz)` `IFieldMapper` provides the link between Carrot2 `Document` fields and Lucene index fields.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`fieldMapper(IFieldMapper value)` `IFieldMapper` provides the link between Carrot2 `Document` fields and Lucene index fields.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`fieldMapper(org.carrot2.util.attribute.IObjectFactory<? extends IFieldMapper> value)` `IFieldMapper` provides the link between Carrot2 `Document` fields and Lucene index fields.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`keepLuceneDocuments(boolean value)` Keeps references to Lucene document instances in Carrot2 documents.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`keepLuceneDocuments(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value)` Keeps references to Lucene document instances in Carrot2 documents.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`query(org.carrot2.util.attribute.IObjectFactory<? extends Object> value)` A pre-parsed `Query` object or a `String` parsed using the built-in classic QueryParser over a set of search fields returned from the `LuceneDocumentSource.fieldMapper`.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`query(Object value)` A pre-parsed `Query` object or a `String` parsed using the built-in classic QueryParser over a set of search fields returned from the `LuceneDocumentSource.fieldMapper`.
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`results(int value)`
`LuceneDocumentSourceDescriptor.AttributeBuilder`	`results(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)`
`long`	`resultsTotal()`

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
  - LuceneDocumentSourceDescriptor.AttributeBuilder
```
protected LuceneDocumentSourceDescriptor.AttributeBuilder(Map<String,Object> map)
```
    Creates a builder backed by the provided map.
- Method Detail
  - results
```
public LuceneDocumentSourceDescriptor.AttributeBuilder results(int value)
```
    See Also:
    LuceneDocumentSource.results
  - results
```
public LuceneDocumentSourceDescriptor.AttributeBuilder results(org.carrot2.util.attribute.IObjectFactory<? extends Integer> value)
```
    See Also:
    LuceneDocumentSource.results
  - resultsTotal
```
public long resultsTotal()
```
    See Also:
    LuceneDocumentSource.resultsTotal
  - documents
```
public Collection<Document> documents()
```
    See Also:
    LuceneDocumentSource.documents
  - directory
```
public LuceneDocumentSourceDescriptor.AttributeBuilder directory(org.apache.lucene.store.Directory value)
```
    Search index Directory. Must be unlocked for reading.
    
    See Also:
    LuceneDocumentSource.directory
  - directory
```
public LuceneDocumentSourceDescriptor.AttributeBuilder directory(Class<?> clazz)
```
    Search index Directory. Must be unlocked for reading. A class that extends org.apache.lucene.store.Directory or appropriate IObjectFactory.
    
    See Also:
    LuceneDocumentSource.directory
  - directory
```
public LuceneDocumentSourceDescriptor.AttributeBuilder directory(org.carrot2.util.attribute.IObjectFactory<? extends org.apache.lucene.store.Directory> value)
```
    Search index Directory. Must be unlocked for reading.
    
    See Also:
    LuceneDocumentSource.directory
  - analyzer
```
public LuceneDocumentSourceDescriptor.AttributeBuilder analyzer(org.apache.lucene.analysis.Analyzer value)
```
    Analyzer used at indexing time. The same analyzer should be used for querying.
    
    See Also:
    LuceneDocumentSource.analyzer
  - analyzer
```
public LuceneDocumentSourceDescriptor.AttributeBuilder analyzer(Class<?> clazz)
```
    Analyzer used at indexing time. The same analyzer should be used for querying. A class that extends org.apache.lucene.analysis.Analyzer or appropriate IObjectFactory.
    
    See Also:
    LuceneDocumentSource.analyzer
  - analyzer
```
public LuceneDocumentSourceDescriptor.AttributeBuilder analyzer(org.carrot2.util.attribute.IObjectFactory<? extends org.apache.lucene.analysis.Analyzer> value)
```
    Analyzer used at indexing time. The same analyzer should be used for querying.
    
    See Also:
    LuceneDocumentSource.analyzer
  - fieldMapper
```
public LuceneDocumentSourceDescriptor.AttributeBuilder fieldMapper(IFieldMapper value)
```
    IFieldMapper provides the link between Carrot2 Document fields and Lucene index fields.
    
    See Also:
    LuceneDocumentSource.fieldMapper
  - fieldMapper
```
public LuceneDocumentSourceDescriptor.AttributeBuilder fieldMapper(Class<?> clazz)
```
    IFieldMapper provides the link between Carrot2 Document fields and Lucene index fields. A class that extends org.carrot2.source.lucene.IFieldMapper or appropriate IObjectFactory.
    
    See Also:
    LuceneDocumentSource.fieldMapper
  - fieldMapper
```
public LuceneDocumentSourceDescriptor.AttributeBuilder fieldMapper(org.carrot2.util.attribute.IObjectFactory<? extends IFieldMapper> value)
```
    IFieldMapper provides the link between Carrot2 Document fields and Lucene index fields.
    
    See Also:
    LuceneDocumentSource.fieldMapper
  - query
```
public LuceneDocumentSourceDescriptor.AttributeBuilder query(Object value)
```
    A pre-parsed Query object or a String parsed using the built-in classic QueryParser over a set of search fields returned from the LuceneDocumentSource.fieldMapper.
    
    See Also:
    LuceneDocumentSource.query
  - query
```
public LuceneDocumentSourceDescriptor.AttributeBuilder query(org.carrot2.util.attribute.IObjectFactory<? extends Object> value)
```
    A pre-parsed Query object or a String parsed using the built-in classic QueryParser over a set of search fields returned from the LuceneDocumentSource.fieldMapper.
    
    See Also:
    LuceneDocumentSource.query
  - keepLuceneDocuments
```
public LuceneDocumentSourceDescriptor.AttributeBuilder keepLuceneDocuments(boolean value)
```
    Keeps references to Lucene document instances in Carrot2 documents. Please bear in mind two limitations:
    - Lucene documents will not be serialized to XML/JSON. Therefore, they can only be accessed when invoking clustering through Carrot2 Java API. To pass some of the fields of Lucene documents to Carrot2 XML/JSON output, implement a custom IFieldMapper that will store those fields as regular Carrot2 fields.
    - Increased memory usage when using a Controller configured to cache the output from LuceneDocumentSource.
    See Also:
    LuceneDocumentSource.keepLuceneDocuments
  - keepLuceneDocuments
```
public LuceneDocumentSourceDescriptor.AttributeBuilder keepLuceneDocuments(org.carrot2.util.attribute.IObjectFactory<? extends Boolean> value)
```
    Keeps references to Lucene document instances in Carrot2 documents. Please bear in mind two limitations:
    - Lucene documents will not be serialized to XML/JSON. Therefore, they can only be accessed when invoking clustering through Carrot2 Java API. To pass some of the fields of Lucene documents to Carrot2 XML/JSON output, implement a custom IFieldMapper that will store those fields as regular Carrot2 fields.
    - Increased memory usage when using a Controller configured to cache the output from LuceneDocumentSource.
    See Also:
    LuceneDocumentSource.keepLuceneDocuments

Class LuceneDocumentSourceDescriptor.AttributeBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

map

Constructor Detail

LuceneDocumentSourceDescriptor.AttributeBuilder

Method Detail

results

results

resultsTotal

documents

directory

directory

directory

analyzer

analyzer

analyzer

fieldMapper

fieldMapper

fieldMapper

query

query

keepLuceneDocuments

keepLuceneDocuments