org.apache.maven.doxia.site.decoration.inheritance

Class DefaultDecorationModelInheritanceAssembler

java.lang.Object

org.apache.maven.doxia.site.decoration.inheritance.DefaultDecorationModelInheritanceAssembler

All Implemented Interfaces:

DecorationModelInheritanceAssembler

@Component(role=DecorationModelInheritanceAssembler.class)
public class DefaultDecorationModelInheritanceAssembler
extends java.lang.Object
implements DecorationModelInheritanceAssembler

Manage inheritance of the decoration model.

Version:

$Id: DefaultDecorationModelInheritanceAssembler.java 1736757 2016-03-27 15:11:59Z hboutemy $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	DefaultDecorationModelInheritanceAssembler.URLRebaser URL rebaser: based on an old and a new path, can rebase a link based on old path to a value based on the new path.

Field Summary

Fields inherited from interface org.apache.maven.doxia.site.decoration.inheritance.DecorationModelInheritanceAssembler

ROLE

Constructor Summary

Constructors

Constructor and Description
DefaultDecorationModelInheritanceAssembler()

Method Summary

Modifier and Type	Method and Description
private void	assembleBodyInheritance(java.lang.String name, DecorationModel child, DecorationModel parent, DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)
private void	assembleCustomInheritance(DecorationModel child, DecorationModel parent)
void	assembleModelInheritance(java.lang.String name, DecorationModel child, DecorationModel parent, java.lang.String childBaseUrl, java.lang.String parentBaseUrl) Manage inheritance of the decoration model between a parent and child.
private java.util.List<LinkItem>	mergeLinkItemLists(java.util.List<LinkItem> childList, java.util.List<LinkItem> parentList, DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer, boolean cutParentAfterDuplicate)
private java.util.List<Menu>	mergeMenus(java.util.List<Menu> childMenus, java.util.List<Menu> parentMenus, DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)
private java.util.List<Logo>	mergePoweredByLists(java.util.List<Logo> childList, java.util.List<Logo> parentList, DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)
private void	rebaseBannerPaths(Banner banner, DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)
private void	rebaseLinkItemPaths(LinkItem item, DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)
private void	rebaseLogoPaths(Logo logo, DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)
private void	rebaseMenuPaths(java.util.List<MenuItem> items, DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)
private void	relativizeBannerPaths(Banner banner, java.lang.String baseUrl) Resolves all relative paths between the elements in a banner.
private java.lang.String	relativizeLink(java.lang.String link, java.lang.String baseUri)
private void	relativizeLinkItemPaths(LinkItem item, java.lang.String baseUrl)
private void	relativizeLogoPaths(Logo logo, java.lang.String baseUrl)
private void	relativizeMenuPaths(java.util.List<MenuItem> items, java.lang.String baseUrl)
void	resolvePaths(DecorationModel decoration, java.lang.String baseUrl) Resolve relative paths for a DecorationModel given a base URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDecorationModelInheritanceAssembler

public DefaultDecorationModelInheritanceAssembler()

Method Detail

assembleModelInheritance

public void assembleModelInheritance(java.lang.String name,
                                     DecorationModel child,
                                     DecorationModel parent,
                                     java.lang.String childBaseUrl,
                                     java.lang.String parentBaseUrl)

Manage inheritance of the decoration model between a parent and child. Any relative links in the parent model will be re-based to work from the merged child model, otherwise no content from either the parent or child model should be modified.

Specified by:

assembleModelInheritance in interface DecorationModelInheritanceAssembler

Parameters:

name - a name, used for breadcrumb. If the parent model contains breadcrumbs and the child doesn't, a child breadcrumb will be added to the merged model with this name. Not null.

child - the child DecorationModel to be merged with parent. Not null. If parent == null, the child is unchanged, otherwise child will contain the merged model upon exit.

parent - the parent DecorationModel. Unchanged upon exit. May be null in which case the child is not changed.

childBaseUrl - the child base URL. May be null, in which case relative links inherited from the parent will not be resolved in the merged child.

parentBaseUrl - the parent base URL. May be null, in which case relative links inherited from the parent will not be resolved in the merged child.

resolvePaths

public void resolvePaths(DecorationModel decoration,
                         java.lang.String baseUrl)

Resolve relative paths for a DecorationModel given a base URL. Note that 'resolve' here means 'relativize' in the sense of URI.relativize(java.net.URI), ie if any link in the decoration model has a base URL that is equal to the given baseUrl, it is replaced by a relative link with respect to that base.

Specified by:

resolvePaths in interface DecorationModelInheritanceAssembler

Parameters:

decoration - the DecorationModel. Not null.

baseUrl - the base URL. May be null in which case the decoration model is unchanged.

relativizeBannerPaths

private void relativizeBannerPaths(Banner banner,
                                   java.lang.String baseUrl)

Resolves all relative paths between the elements in a banner. The banner element might contain relative paths to the oldBaseUrl, these are changed to the newBannerUrl.

Parameters:

banner -

baseUrl -

rebaseBannerPaths

private void rebaseBannerPaths(Banner banner,
                               DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)

assembleCustomInheritance

private void assembleCustomInheritance(DecorationModel child,
                                       DecorationModel parent)

assembleBodyInheritance

private void assembleBodyInheritance(java.lang.String name,
                                     DecorationModel child,
                                     DecorationModel parent,
                                     DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)

mergeMenus

private java.util.List<Menu> mergeMenus(java.util.List<Menu> childMenus,
                                        java.util.List<Menu> parentMenus,
                                        DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)

relativizeMenuPaths

private void relativizeMenuPaths(java.util.List<MenuItem> items,
                                 java.lang.String baseUrl)

rebaseMenuPaths

private void rebaseMenuPaths(java.util.List<MenuItem> items,
                             DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)

relativizeLinkItemPaths

private void relativizeLinkItemPaths(LinkItem item,
                                     java.lang.String baseUrl)

rebaseLinkItemPaths

private void rebaseLinkItemPaths(LinkItem item,
                                 DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)

relativizeLogoPaths

private void relativizeLogoPaths(Logo logo,
                                 java.lang.String baseUrl)

rebaseLogoPaths

private void rebaseLogoPaths(Logo logo,
                             DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)

mergeLinkItemLists

private java.util.List<LinkItem> mergeLinkItemLists(java.util.List<LinkItem> childList,
                                                    java.util.List<LinkItem> parentList,
                                                    DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer,
                                                    boolean cutParentAfterDuplicate)

mergePoweredByLists

private java.util.List<Logo> mergePoweredByLists(java.util.List<Logo> childList,
                                                 java.util.List<Logo> parentList,
                                                 DefaultDecorationModelInheritanceAssembler.URLRebaser urlContainer)

relativizeLink

private java.lang.String relativizeLink(java.lang.String link,
                                        java.lang.String baseUri)