org.craftercms.search.service.impl

Class SolrDocumentBuilder

java.lang.Object

org.craftercms.search.service.impl.SolrDocumentBuilder

public class SolrDocumentBuilder
extends Object

The purpose of this class is to convert a generic XML document:

     <page>
      <file-name>index.xml</file-name>
      <showAboutAuthor>false</showAboutAuthor>
      <showSearchBox>true</showSearchBox>
     </page>
 

into a Solr Document:

     <add>
      <doc>
          <field name="file-name">index.xml</field>
          <field name="showAboutAuthor">false</field>
          <field name="showSearchBox">true</field>
      </doc>
     </add>
 

The Solr document is represent in Java as a SolrInputDocument object, which then can be sent to the server with SolrServer.add(org.apache.solr.common.SolrInputDocument)

Author:

Michael Chen, Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dateTimeFieldPattern
protected String	dateTimeFieldSuffix
protected String	htmlFieldSuffix
protected String	localIdFieldName
protected String	siteFieldName

Constructor Summary

Constructors

Constructor and Description
SolrDocumentBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	build(org.apache.solr.common.SolrInputDocument solrDoc, String branchName, org.dom4j.Element element)
org.apache.solr.common.SolrInputDocument	build(String site, String id, String xml, boolean ignoreRootInFieldNames) Build the Solr document from the input XML.
protected String	convertToISODateTimeString(String dateTimeStr)
protected org.dom4j.io.SAXReader	createSAXReader()
void	init()
void	setDateTimeFieldPattern(String dateTimeFieldPattern) Sets the pattern string for datetime fields tha come in the input XML.
void	setDateTimeFieldSuffix(String dateTimeFieldSuffix) Sets the suffix of datetime fields (commonly _dt).
void	setHtmlFieldSuffix(String htmlFieldSuffix) Sets the suffix of fields with HTML content (commonly _html).
void	setLocalIdFieldName(String localIdFieldName) Sets the local ID field name, which is the ID of the document within the site.
void	setSiteFieldName(String siteFieldName) Sets the site field name, which is used to indicate to which site the document belongs to.
protected String	stripHtml(String element, String value)

Methods inherited from class java.lang.Object

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

Field Detail

siteFieldName

protected String siteFieldName

localIdFieldName

protected String localIdFieldName

dateTimeFieldPattern

protected String dateTimeFieldPattern

dateTimeFieldSuffix

protected String dateTimeFieldSuffix

htmlFieldSuffix

protected String htmlFieldSuffix

Constructor Detail

SolrDocumentBuilder

public SolrDocumentBuilder()

Method Detail

setSiteFieldName

public void setSiteFieldName(String siteFieldName)

Sets the site field name, which is used to indicate to which site the document belongs to.

setLocalIdFieldName

public void setLocalIdFieldName(String localIdFieldName)

Sets the local ID field name, which is the ID of the document within the site.

setDateTimeFieldPattern

public void setDateTimeFieldPattern(String dateTimeFieldPattern)

Sets the pattern string for datetime fields tha come in the input XML.

setDateTimeFieldSuffix

public void setDateTimeFieldSuffix(String dateTimeFieldSuffix)

Sets the suffix of datetime fields (commonly _dt).

setHtmlFieldSuffix

public void setHtmlFieldSuffix(String htmlFieldSuffix)

Sets the suffix of fields with HTML content (commonly _html).

init

@PostConstruct
public void init()

build

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

Build the Solr document from the input XML.

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

protected void build(org.apache.solr.common.SolrInputDocument solrDoc,
         String branchName,
         org.dom4j.Element element)

createSAXReader

protected org.dom4j.io.SAXReader createSAXReader()

stripHtml

protected String stripHtml(String element,
               String value)
                    throws SolrDocumentBuildException

Throws:

SolrDocumentBuildException

convertToISODateTimeString

protected String convertToISODateTimeString(String dateTimeStr)