Package org.craftercms.core.xml.mergers.impl.strategies

Class ContentBundleMergeStrategy

java.lang.Object

org.craftercms.core.xml.mergers.impl.strategies.ContentBundleMergeStrategy

All Implemented Interfaces:

DescriptorMergeStrategy

public class ContentBundleMergeStrategy
extends Object
implements DescriptorMergeStrategy

DescriptorMergeStrategy that returns the level descriptors in the hierarchy and the base descriptors when some of the parent folders are part of a content bundle (which is similar to a resource bundle, but instead of simple properties, a content bundle is formed by XML content (descriptors)). E.g., for a descriptor path folder1/folder2_es/file.xml, the descriptor folder1/folder2/file.xml is returned for the merge.

Author:

Sumer Jabri, Alfonso Vásquez

Constructor Summary

Constructors

Constructor	Description
ContentBundleMergeStrategy()

Method Summary

Modifier and Type	Method	Description
protected org.dom4j.Document	getDescriptorDom(Context context, CachingOptions cachingOptions, String url)
List<MergeableDescriptor>	getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom)	Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.
List<MergeableDescriptor>	getDescriptors(Context context, CachingOptions cachingOptions, String mainDescriptorUrl, org.dom4j.Document mainDescriptorDom, boolean mainDescriptorOptional)	Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.
void	setBaseDelimiter(String baseDelimiter)
void	setBaseMergeStrategyResolver(DescriptorMergeStrategyResolver baseMergeStrategyResolver)
void	setRegularMergeStrategy(DescriptorMergeStrategy regularMergeStrategy)
void	setUrlParser(ContentBundleUrlParser urlParser)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentBundleMergeStrategy

public ContentBundleMergeStrategy()

Method Detail

setUrlParser

public void setUrlParser(ContentBundleUrlParser urlParser)

setBaseDelimiter

public void setBaseDelimiter(String baseDelimiter)

setBaseMergeStrategyResolver

public void setBaseMergeStrategyResolver(DescriptorMergeStrategyResolver baseMergeStrategyResolver)

setRegularMergeStrategy

public void setRegularMergeStrategy(DescriptorMergeStrategy regularMergeStrategy)

getDescriptors

public List<MergeableDescriptor> getDescriptors(Context context,
                                                CachingOptions cachingOptions,
                                                String mainDescriptorUrl,
                                                org.dom4j.Document mainDescriptorDom)
                                         throws XmlMergeException

Description copied from interface: DescriptorMergeStrategy

Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.

Specified by:

getDescriptors in interface DescriptorMergeStrategy

Parameters:

context - the current context

cachingOptions - caching options in case you need access to items

mainDescriptorUrl - the URL of the main descriptor

mainDescriptorDom - the DOM of the main descriptor

Returns:

a list of MergeableDescriptors representing the descriptors to merge

Throws:

XmlMergeException

getDescriptors

public List<MergeableDescriptor> getDescriptors(Context context,
                                                CachingOptions cachingOptions,
                                                String mainDescriptorUrl,
                                                org.dom4j.Document mainDescriptorDom,
                                                boolean mainDescriptorOptional)
                                         throws XmlMergeException

Description copied from interface: DescriptorMergeStrategy

Returns the list of descriptors in the order they should be merged, given the URI of the primary descriptor.

Specified by:

getDescriptors in interface DescriptorMergeStrategy

Parameters:

context - the current context

cachingOptions - caching options in case you need access to items

mainDescriptorUrl - the URL of the primary descriptor

mainDescriptorDom - the DOM of the main descriptor

mainDescriptorOptional - if the primary descriptor should be marked as optional

Returns:

a list of MergeableDescriptors representing the descriptors to merge

Throws:

XmlMergeException

getDescriptorDom

protected org.dom4j.Document getDescriptorDom(Context context,
                                              CachingOptions cachingOptions,
                                              String url)