org.craftercms.search.commons.service.impl

Class AbstractDocumentBuilder<T>

java.lang.Object

org.craftercms.search.commons.service.impl.AbstractDocumentBuilder<T>

Type Parameters:

T - the type of document for the search engine

All Implemented Interfaces:

DocumentBuilder<T>

Direct Known Subclasses:

ElasticsearchDocumentBuilder, SolrDocumentBuilderImpl

public abstract class AbstractDocumentBuilder<T>
extends Object
implements DocumentBuilder<T>

Base implementation of DocumentBuilder to add commons fields.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	copyFields
static String	DEFAULT_ID_FIELD_NAME
static String	DEFAULT_LOCAL_ID_FIELD_NAME
static String	DEFAULT_PUBLISHING_DATE_ALT_FIELD_NAME
static String	DEFAULT_PUBLISHING_DATE_FIELD_NAME
static String	DEFAULT_ROOT_ID_FIELD_NAME
static String	DEFAULT_SITE_FIELD_NAME
protected FieldValueConverter	fieldValueConverter
protected String	idFieldName
protected String	localIdFieldName
protected ElementParserService<T>	parserService
protected List<DocumentPostProcessor<T>>	postProcessors
protected String	publishingDateAltFieldName
protected String	publishingDateFieldName
protected String	rootIdFieldName
protected String	siteFieldName

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentBuilder()

Method Summary

Modifier and Type	Method and Description
protected void	addCopyFields(org.dom4j.Element element)
protected abstract void	addField(T doc, String fieldName, Object fieldValue)
T	build(String site, String id, Map<String,List<String>> fields) Builds a document from the provided multi value map of fields
T	build(String site, String id, String xml, boolean ignoreRootInFieldNames) Builds a document from the input XML.
protected abstract T	createDoc()
protected org.dom4j.io.SAXReader	createSAXReader()
protected String	formatAsIso(Temporal temporal)
protected void	postProcess(T doc)
void	setCopyFields(Map<String,String> copyFields)
void	setFieldValueConverter(FieldValueConverter fieldValueConverter)
void	setIdFieldName(String idFieldName)
void	setLocalIdFieldName(String localIdFieldName)
void	setParserService(ElementParserService<T> parserService)
void	setPostProcessors(List<DocumentPostProcessor<T>> postProcessors)
void	setPublishingDateAltFieldName(String publishingDateAltFieldName)
void	setPublishingDateFieldName(String publishingDateFieldName)
void	setRootIdFieldName(String rootIdFieldName)
void	setSiteFieldName(String siteFieldName)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ID_FIELD_NAME

public static final String DEFAULT_ID_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_ROOT_ID_FIELD_NAME

public static final String DEFAULT_ROOT_ID_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_SITE_FIELD_NAME

public static final String DEFAULT_SITE_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_LOCAL_ID_FIELD_NAME

public static final String DEFAULT_LOCAL_ID_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_PUBLISHING_DATE_FIELD_NAME

public static final String DEFAULT_PUBLISHING_DATE_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_PUBLISHING_DATE_ALT_FIELD_NAME

public static final String DEFAULT_PUBLISHING_DATE_ALT_FIELD_NAME

See Also:

Constant Field Values

idFieldName

protected String idFieldName

rootIdFieldName

protected String rootIdFieldName

siteFieldName

protected String siteFieldName

localIdFieldName

protected String localIdFieldName

publishingDateFieldName

protected String publishingDateFieldName

publishingDateAltFieldName

protected String publishingDateAltFieldName

parserService

protected ElementParserService<T> parserService

fieldValueConverter

protected FieldValueConverter fieldValueConverter

postProcessors

protected List<DocumentPostProcessor<T>> postProcessors

copyFields

protected Map<String,String> copyFields

Constructor Detail

AbstractDocumentBuilder

public AbstractDocumentBuilder()

Method Detail

setIdFieldName

public void setIdFieldName(String idFieldName)

setRootIdFieldName

public void setRootIdFieldName(String rootIdFieldName)

setSiteFieldName

public void setSiteFieldName(String siteFieldName)

setLocalIdFieldName

public void setLocalIdFieldName(String localIdFieldName)

setPublishingDateFieldName

public void setPublishingDateFieldName(String publishingDateFieldName)

setPublishingDateAltFieldName

public void setPublishingDateAltFieldName(String publishingDateAltFieldName)

setParserService

public void setParserService(ElementParserService<T> parserService)

setFieldValueConverter

public void setFieldValueConverter(FieldValueConverter fieldValueConverter)

setPostProcessors

public void setPostProcessors(List<DocumentPostProcessor<T>> postProcessors)

setCopyFields

public void setCopyFields(Map<String,String> copyFields)

createDoc

protected abstract T createDoc()

addField

protected abstract void addField(T doc,
                                 String fieldName,
                                 Object fieldValue)

build

public T build(String site,
               String id,
               String xml,
               boolean ignoreRootInFieldNames)
        throws DocumentBuildException

Description copied from interface: DocumentBuilder

Builds a document from the input XML.

Specified by:

build in interface DocumentBuilder<T>

Parameters:

site - the Crafter site name the content belongs to

id - value for the "localId" field in the document (final doc id is built as site:localId)

xml - the input XML

ignoreRootInFieldNames - ignore the root element of the input XML in field names

Returns:

the document

Throws:

DocumentBuildException

addCopyFields

protected void addCopyFields(org.dom4j.Element element)

build

public T build(String site,
               String id,
               Map<String,List<String>> fields)

Description copied from interface: DocumentBuilder

Builds a document from the provided multi value map of fields

Specified by:

build in interface DocumentBuilder<T>

Parameters:

site - the Crafter site name the content belongs to

id - value for the "localId" field in the document (final doc id is built as site:localId)

fields - fields to add to solr document.

Returns:

the document

postProcess

protected void postProcess(T doc)

createSAXReader

protected org.dom4j.io.SAXReader createSAXReader()

formatAsIso

protected String formatAsIso(Temporal temporal)