com.jiowa.template.unificator

Class TemplateUnificator

java.lang.Object

com.jiowa.template.unificator.TemplateUnificator

public class TemplateUnificator
extends java.lang.Object

Unifies a template of a template map, i.e. it inserts all templates into each other where include tags appears. The result is a template map, where all include tags have been replaced by the referenced template content. (similar to the unification algorithm from predicate logic.)

Author:

Robert Mencl

Copyright (C) 2012-2016 JIOWA Business Solutions GmbH, Bettinastr. 30 , 60325 Frankfurt am Main, Germany
Homepage: www.jiowa.de
All rights reserved.

Download: www.jiowa.de/download.html
License: www.jiowa.de/license.html

Field Summary

Fields

Modifier and Type	Field and Description
protected TemplateUnificator	parent
protected TemplateMapUnificator	root
protected Template	template
protected TemplateMap	templateMap
protected java.util.SortedSet<java.lang.String>	visited

Constructor Summary

Constructors

Modifier	Constructor and Description
	TemplateUnificator(Template template, TemplateMapUnificator root) Constructs a unificator for a given template and the underlying template map.
protected	TemplateUnificator(Template template, TemplateUnificator parent) This constructor should only be used from within TemplateUnificator.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	addLeftOffsetToEachLineOfString(int offset, java.lang.String s) Adds an offset (whitespace) string to the front of a string.
protected java.util.List<Tag>	addLeftOffsetToIncludedTemplate(java.util.List<Tag> tagListOfTemplate, int offset) Adjusts the positions of included template according to the given left offset.
protected java.util.List<IncludeTag>	collectAllIncludeTagsRecursively() Collects all include tags of this template.
protected int	computeLeftTextOffset(java.util.LinkedList<Tag> list) Computes the left text offset until the current tag in the given list.
protected boolean	inducesCycle(java.lang.String templateName) Returns true if a template inclusion cycle is induced, and false, otherwise.
protected void	logUniqueErrorMessage(java.lang.String msg)
Template	unify() Returns the internal template as unified template (without containing any include statements any more).
protected TemplateMap	unifyIncludeTags(java.util.List<IncludeTag> list) Unifies all include tags.
protected InlineSubTemplateTag	unifyInlineSubTemplateTag(InlineSubTemplateTag inlineTag, TemplateMap unifiedIncTemplateMap) Unifies an inline subtemplate tag, i.e. it inserts include tags into the subtemplate (recursively if needed).
protected SubTemplateStructureTag	unifySubTemplateStructureTag(SubTemplateStructureTag subStructTag, TemplateMap unifiedIncTemplateMap) Unifies a subtemplate structure tag.
protected Template	unifyTemplate() Unifies a template by considering by processing all its includes.

Methods inherited from class java.lang.Object

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

Field Detail

root

protected TemplateMapUnificator root

parent

protected TemplateUnificator parent

template

protected Template template

templateMap

protected TemplateMap templateMap

visited

protected java.util.SortedSet<java.lang.String> visited

Constructor Detail

TemplateUnificator

public TemplateUnificator(Template template,
                          TemplateMapUnificator root)

Constructs a unificator for a given template and the underlying template map.

Parameters:

template -

root - reference to root TemplateMapUnificator

TemplateUnificator

protected TemplateUnificator(Template template,
                             TemplateUnificator parent)

This constructor should only be used from within TemplateUnificator. Therefore, it is protected.

Method Detail

unify

public Template unify()

Returns the internal template as unified template (without containing any include statements any more).

collectAllIncludeTagsRecursively

protected java.util.List<IncludeTag> collectAllIncludeTagsRecursively()

Collects all include tags of this template.

Returns:

list of IncludeTags

unifyIncludeTags

protected TemplateMap unifyIncludeTags(java.util.List<IncludeTag> list)

Unifies all include tags.

Parameters:

list -

Returns:

TemplateMap

unifyTemplate

protected Template unifyTemplate()

Unifies a template by considering by processing all its includes.

Returns:

unified template with all processed includes

unifySubTemplateStructureTag

protected SubTemplateStructureTag unifySubTemplateStructureTag(SubTemplateStructureTag subStructTag,
                                                               TemplateMap unifiedIncTemplateMap)

Unifies a subtemplate structure tag.

Parameters:

subStructTag -

unifiedIncTemplateMap -

Returns:

tag for the subtemplate structure

unifyInlineSubTemplateTag

protected InlineSubTemplateTag unifyInlineSubTemplateTag(InlineSubTemplateTag inlineTag,
                                                         TemplateMap unifiedIncTemplateMap)

Unifies an inline subtemplate tag, i.e. it inserts include tags into the subtemplate (recursively if needed).

Parameters:

inlineTag -

unifiedIncTemplateMap -

Returns:

tag which holds the inline subtemplate

inducesCycle

protected boolean inducesCycle(java.lang.String templateName)

Returns true if a template inclusion cycle is induced, and false, otherwise.

Parameters:

templateName - template which could induce a cycle.

Returns:

boolean if cycle has been induced.

computeLeftTextOffset

protected int computeLeftTextOffset(java.util.LinkedList<Tag> list)

Computes the left text offset until the current tag in the given list.

Parameters:

list -

Returns:

left text offset value

addLeftOffsetToIncludedTemplate

protected java.util.List<Tag> addLeftOffsetToIncludedTemplate(java.util.List<Tag> tagListOfTemplate,
                                                              int offset)

Adjusts the positions of included template according to the given left offset.

Parameters:

tagListOfTemplate - template as list of tags

offset - number of spaces as offset

Returns:

list of Tags

addLeftOffsetToEachLineOfString

protected java.lang.String addLeftOffsetToEachLineOfString(int offset,
                                                           java.lang.String s)

Adds an offset (whitespace) string to the front of a string.

Parameters:

offset -

s -

Returns:

the string with a whitespace left offset (for each line of the string)

logUniqueErrorMessage

protected void logUniqueErrorMessage(java.lang.String msg)