org.craftercms.search.service

Interface ElementParser

All Known Implementing Classes:

DefaultElementParser, SubDocumentElementParser, TokenizedElementParser

public interface ElementParser

Implementations parse the specified element to generate fields for the document.

Author:

avasquez

Method Summary

Modifier and Type	Method and Description
boolean	parse(org.dom4j.Element element, String fieldName, String parentFieldName, org.apache.solr.common.SolrInputDocument solrDoc, ElementParserService parserService) Parses the given element, generating one or more Solr fields and adding them to the given document.

Method Detail

parse

boolean parse(org.dom4j.Element element,
              String fieldName,
              String parentFieldName,
              org.apache.solr.common.SolrInputDocument solrDoc,
              ElementParserService parserService)

Parses the given element, generating one or more Solr fields and adding them to the given document.

Parameters:

element - the element to parse

fieldName - the field name that should be used for the main Solr field (by default will be the path of the element in the tree plus the element name)

parentFieldName - the field name of the parent element

solrDoc - the Solr document to add the generated fields

parserService - the parser service used normally to parse sub elements

Returns:

true if the element was parsed or handled, false otherwise