org.craftercms.search.batch.utils.xml

Class FlatteningDocumentProcessor

java.lang.Object

org.craftercms.search.batch.utils.xml.FlatteningDocumentProcessor

All Implemented Interfaces:

DocumentProcessor

public class FlatteningDocumentProcessor
extends Object
implements DocumentProcessor

DocumentProcessor that parses the document for >include&lt elements and replaces them for the actual referenced XML components.

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
protected String	charEncoding
static String	DEFAULT_CHAR_ENCODING
static String	DEFAULT_DISABLE_FLATTENING_ELEMENT
static String	DEFAULT_INCLUDE_ELEMENT_XPATH_QUERY
protected String	disableFlatteningElement
protected boolean	disableNestedPageFlattening
protected String	includeElementXPathQuery
static String	PAGE_ROOT_ELEMENT_NAME
protected String	pageRootElementName

Constructor Summary

Constructors

Constructor and Description
FlatteningDocumentProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInclude(org.dom4j.Element includeElement, org.dom4j.Document includeSrc)
protected org.dom4j.Document	flattenXml(org.dom4j.Document document, File file, String rootFolder, List<File> flattenedFiles)
protected boolean	isPage(org.dom4j.Document document)
org.dom4j.Document	process(org.dom4j.Document document, File file, String rootFolder) Processes the specified XML DOM.
void	setCharEncoding(String charEncoding)
void	setDisableFlatteningElement(String disableFlatteningElement)
void	setDisableNestedPageFlattening(boolean disableNestedPageFlattening)
void	setIncludeElementXPathQuery(String includeElementXPathQuery)
void	setPageRootElementName(String pageRootElementName)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHAR_ENCODING

public static final String DEFAULT_CHAR_ENCODING

See Also:

Constant Field Values

DEFAULT_INCLUDE_ELEMENT_XPATH_QUERY

public static final String DEFAULT_INCLUDE_ELEMENT_XPATH_QUERY

See Also:

Constant Field Values

DEFAULT_DISABLE_FLATTENING_ELEMENT

public static final String DEFAULT_DISABLE_FLATTENING_ELEMENT

See Also:

Constant Field Values

PAGE_ROOT_ELEMENT_NAME

public static final String PAGE_ROOT_ELEMENT_NAME

See Also:

Constant Field Values

charEncoding

protected String charEncoding

includeElementXPathQuery

protected String includeElementXPathQuery

disableFlatteningElement

protected String disableFlatteningElement

pageRootElementName

protected String pageRootElementName

disableNestedPageFlattening

protected boolean disableNestedPageFlattening

Constructor Detail

FlatteningDocumentProcessor

public FlatteningDocumentProcessor()

Method Detail

setIncludeElementXPathQuery

public void setIncludeElementXPathQuery(String includeElementXPathQuery)

setDisableFlatteningElement

public void setDisableFlatteningElement(String disableFlatteningElement)

setPageRootElementName

public void setPageRootElementName(String pageRootElementName)

setDisableNestedPageFlattening

public void setDisableNestedPageFlattening(boolean disableNestedPageFlattening)

setCharEncoding

public void setCharEncoding(String charEncoding)

process

public org.dom4j.Document process(org.dom4j.Document document,
                         File file,
                         String rootFolder)
                           throws org.dom4j.DocumentException

Description copied from interface: DocumentProcessor

Processes the specified XML DOM.

Specified by:

process in interface DocumentProcessor

Parameters:

document - the DOM

file - the XML file

rootFolder - the root folder where this file is located

Returns:

the processed DOM

Throws:

org.dom4j.DocumentException

flattenXml

protected org.dom4j.Document flattenXml(org.dom4j.Document document,
                            File file,
                            String rootFolder,
                            List<File> flattenedFiles)
                                 throws org.dom4j.DocumentException

Throws:

org.dom4j.DocumentException

doInclude

protected void doInclude(org.dom4j.Element includeElement,
             org.dom4j.Document includeSrc)

isPage

protected boolean isPage(org.dom4j.Document document)