com.atlassian.bonnie.search
Class BaseDocumentBuilder

java.lang.Object
  com.atlassian.bonnie.search.BaseDocumentBuilder

All Implemented Interfaces:

DocumentBuilder

public class BaseDocumentBuilder

extends java.lang.Object

implements DocumentBuilder

Nested Class Summary

static class

BaseDocumentBuilder.FieldName This may change, don't consider this part of a public API

Field Summary

static java.lang.String	TYPE_FIELD
static java.lang.String	URL_PATH_FIELD

Constructor Summary

BaseDocumentBuilder(HandleResolver handleResolver, java.util.List extractors, java.util.List postProcessors)

Method Summary

org.apache.lucene.document.Document	getDocument(Searchable searchable) Generates a Lucene document using the extractors defined by construction of BaseDocumentBuilder.
Handle	getHandle(java.lang.Object obj)
protected org.apache.lucene.document.Document	getInitialDocument(Searchable searchable) Get the initial document that will be passed through the chain of extractors

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_FIELD

public static final java.lang.String TYPE_FIELD

See Also:

Constant Field Values

URL_PATH_FIELD

public static final java.lang.String URL_PATH_FIELD

See Also:

Constant Field Values

Constructor Detail

BaseDocumentBuilder

public BaseDocumentBuilder(HandleResolver handleResolver,
                           java.util.List extractors,
                           java.util.List postProcessors)

Method Detail

getDocument

public org.apache.lucene.document.Document getDocument(Searchable searchable)

Generates a Lucene document using the extractors defined by construction of BaseDocumentBuilder. Note: The 'contentBody' field will only be used if the data is below the value defined by system property 'atlassian.indexing.contentbody.maxsize'. If this property is not defined, threshold will default to 1 MiB.

Specified by:

getDocument in interface DocumentBuilder

Parameters:

searchable - The object to be processed

Returns:

a Lucene Document with extracted data from searchable object

getInitialDocument

protected org.apache.lucene.document.Document getInitialDocument(Searchable searchable)

Get the initial document that will be passed through the chain of extractors

Parameters:

searchable - the object the document is being created for

Returns:

a new Document pre-filled with the absolute minimum necessary data for it to be added.

getHandle

public Handle getHandle(java.lang.Object obj)

Specified by:

getHandle in interface DocumentBuilder

Returns:

A Handle by which the AnyTypeObjectDao (for example) can resolve any persistent object

See Also:

Handle