Package org.craftercms.search.commons.service

Interface ElementParser<T>

All Known Implementing Classes:

AbstractElementParser, ItemListElementParser, OpenSearchElementParserImpl, TokenizedElementParser

public interface ElementParser<T>

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

Author:

avasquez

Method Summary

Modifier and Type	Method	Description
boolean	parse(org.dom4j.Element element, String fieldName, String parentFieldName, T doc, ElementParserService<T> parserService)	Parses the given element, generating one or more fields and adding them to the given document.

Method Details

parse

boolean parse(org.dom4j.Element element,
 String fieldName,
 String parentFieldName,
 T doc,
 ElementParserService<T> parserService)

Parses the given element, generating one or more 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 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

doc - the 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