org.craftercms.search.service.impl

Class SolrDocumentBuilderImpl

java.lang.Object

org.craftercms.search.service.impl.SolrDocumentBuilderImpl

All Implemented Interfaces:

SolrDocumentBuilder

public class SolrDocumentBuilderImpl
extends Object
implements SolrDocumentBuilder

Default implementation of SolrDocumentBuilder.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
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	parserService
protected List<SolrDocumentPostProcessor>	postProcessors
protected String	publishingDateAltFieldName
protected String	publishingDateFieldName
protected String	rootIdFieldName
protected String	siteFieldName

Constructor Summary

Constructors

Constructor and Description
SolrDocumentBuilderImpl()

Method Summary

Modifier and Type	Method and Description
org.apache.solr.common.SolrInputDocument	build(String site, String id, Map<String,List<String>> fields) Builds a Solr document from the provided multi value map of fields
org.apache.solr.common.SolrInputDocument	build(String site, String id, String xml, boolean ignoreRootInFieldNames) Builds a Solr document from the input XML.
org.apache.solr.common.params.ModifiableSolrParams	buildParams(String site, String id, String prefix, String suffix, Map<String,List<String>> fields) Builds a set of SolrParams for an update request from the provided multi value map of fields
protected org.dom4j.io.SAXReader	createSAXReader()
protected String	formatAsIso(org.joda.time.DateTime dateTime)
protected void	postProcess(org.apache.solr.common.SolrInputDocument solrDoc)
void	setFieldValueConverter(FieldValueConverter fieldValueConverter)
void	setIdFieldName(String idFieldName)
void	setLocalIdFieldName(String localIdFieldName)
void	setParserService(ElementParserService parserService)
void	setPostProcessors(List<SolrDocumentPostProcessor> 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 parserService

fieldValueConverter

protected FieldValueConverter fieldValueConverter

postProcessors

protected List<SolrDocumentPostProcessor> postProcessors

Constructor Detail

SolrDocumentBuilderImpl

public SolrDocumentBuilderImpl()

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 parserService)

setFieldValueConverter

public void setFieldValueConverter(FieldValueConverter fieldValueConverter)

setPostProcessors

public void setPostProcessors(List<SolrDocumentPostProcessor> postProcessors)

build

public org.apache.solr.common.SolrInputDocument build(String site,
                                                      String id,
                                                      String xml,
                                                      boolean ignoreRootInFieldNames)
                                               throws SolrDocumentBuildException

Description copied from interface: SolrDocumentBuilder

Builds a Solr document from the input XML.

Specified by:

build in interface SolrDocumentBuilder

Parameters:

site - the Crafter site name the content belongs to

id - value for the "localId" field in the Solr 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 Solr document

Throws:

SolrDocumentBuildException

build

public org.apache.solr.common.SolrInputDocument build(String site,
                                                      String id,
                                                      Map<String,List<String>> fields)

Description copied from interface: SolrDocumentBuilder

Builds a Solr document from the provided multi value map of fields

Specified by:

build in interface SolrDocumentBuilder

Parameters:

site - the Crafter site name the content belongs to

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

fields - fields to add to solr document.

Returns:

the Solr document

buildParams

public org.apache.solr.common.params.ModifiableSolrParams buildParams(String site,
                                                                      String id,
                                                                      String prefix,
                                                                      String suffix,
                                                                      Map<String,List<String>> fields)

Description copied from interface: SolrDocumentBuilder

Builds a set of SolrParams for an update request from the provided multi value map of fields

Specified by:

buildParams in interface SolrDocumentBuilder

Parameters:

site - the Crafter site name the content belongs to

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

prefix - the common prefix for the fields (null or empty for no prefix)

suffix - the common suffix for the fields (null or empty for no suffix)

fields - fields to add to solr document.

Returns:

the Solr document

postProcess

protected void postProcess(org.apache.solr.common.SolrInputDocument solrDoc)

createSAXReader

protected org.dom4j.io.SAXReader createSAXReader()

formatAsIso

protected String formatAsIso(org.joda.time.DateTime dateTime)