org.craftercms.search.service.impl

Class SubDocumentElementParser

java.lang.Object

org.craftercms.search.service.impl.SubDocumentElementParser

All Implemented Interfaces:

ElementParser

public class SubDocumentElementParser
extends Object
implements ElementParser

ElementParser implementation that parses elements that ara tagged with an attribute that indicates that it's sub-elements should be treated as sub-documents or child documents.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
protected String	containsSubDocumentsAttributeName
protected String	contentTypeFieldName
static String	DEFAULT_CONTAINS_SUB_DOCUMENTS_ATTRIBUTE_NAME
static String	DEFAULT_CONTENT_TYPE_FIELD_NAME
static String	DEFAULT_PARENT_ID_FIELD_NAME
static String	DEFAULT_SUB_DOCUMENT_ELEMENT_NAME
protected String	idFieldName
protected String	localIdFieldName
protected String	parentIdFieldName
protected String	publishingDateAltFieldName
protected String	publishingDateFieldName
protected String	rootIdFieldName
protected String	siteFieldName
protected String	subDocumentElementName

Constructor Summary

Constructors

Constructor and Description
SubDocumentElementParser()

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.
void	setContainsSubDocumentsAttributeName(String containsSubDocumentsAttributeName)
void	setContentTypeFieldName(String contentTypeFieldName)
void	setIdFieldName(String idFieldName)
void	setLocalIdFieldName(String localIdFieldName)
void	setParentIdFieldName(String parentIdFieldName)
void	setPublishingDateAltFieldName(String publishingDateAltFieldName)
void	setPublishingDateFieldName(String publishingDateFieldName)
void	setRootIdFieldName(String rootIdFieldName)
void	setSiteFieldName(String siteFieldName)
void	setSubDocumentElementName(String subDocumentElementName)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_TYPE_FIELD_NAME

public static final String DEFAULT_CONTENT_TYPE_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_PARENT_ID_FIELD_NAME

public static final String DEFAULT_PARENT_ID_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_CONTAINS_SUB_DOCUMENTS_ATTRIBUTE_NAME

public static final String DEFAULT_CONTAINS_SUB_DOCUMENTS_ATTRIBUTE_NAME

See Also:

Constant Field Values

DEFAULT_SUB_DOCUMENT_ELEMENT_NAME

public static final String DEFAULT_SUB_DOCUMENT_ELEMENT_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

parentIdFieldName

protected String parentIdFieldName

contentTypeFieldName

protected String contentTypeFieldName

containsSubDocumentsAttributeName

protected String containsSubDocumentsAttributeName

subDocumentElementName

protected String subDocumentElementName

Constructor Detail

SubDocumentElementParser

public SubDocumentElementParser()

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)

setContentTypeFieldName

public void setContentTypeFieldName(String contentTypeFieldName)

setParentIdFieldName

public void setParentIdFieldName(String parentIdFieldName)

setContainsSubDocumentsAttributeName

public void setContainsSubDocumentsAttributeName(String containsSubDocumentsAttributeName)

setSubDocumentElementName

public void setSubDocumentElementName(String subDocumentElementName)

parse

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

Description copied from interface: ElementParser

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

Specified by:

parse in interface ElementParser

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