org.zaproxy.zap.extension.help

Class ZapTocMerger

java.lang.Object

javax.help.Merge

javax.help.UniteAppendMerge

org.zaproxy.zap.extension.help.ZapTocMerger

public class ZapTocMerger
extends javax.help.UniteAppendMerge

NOTE: The name (and package) of the class must not be changed lightly! It will break help's TOC merging at runtime. The name and package is hard coded in helpset files and is also referenced in others for documentation purposes. (END NOTE)

An UniteAppendMerge that takes into account the "tocid" attribute of the "tocitem" elements to do the merging. The "tocid" attribute is used to facilitate the merging of the TOC with internationalised helpsets. The node names and targets do not provide enough information to do a safe merging. The name might not be the same (when it is translated) and the target is not present in all nodes. In those cases a "tocid" attribute is set to unambiguously identify those nodes.

The merge depends on the information provided by the "tocitem" elements and if they use or not the "tocid" attribute.

First the nodes are compared to check if they have the same "tocid" and merged if they have.
Otherwise and for backward compatibility with helpsets that still do not use the attribute "tocid" a forced merge is performed if some predefined requirements are met. The requirements are as follow:

1. The master node must have an attribute "tocid";
2. The master node "tocid" must be present in the map of forced merges (TOC_IDS_FORCE_MERGE_MAP);
3. The slave node must have the same name as the one defined in the value (ForceMergeRequirement) of the map of forced merges;
4. The master node level must be the same as the one defined in the value of the map of forced merges (the level is used to prevent matching other nodes with the same name in the tree).

If none of the aforementioned merges are performed the actual merging will be done as defined by UniteAppendMerge.

See Also:

UniteAppendMerge, ZapTocItem, ZapTocView, TOC_IDS_FORCE_MERGE_MAP, ZapTocMerger.ForceMergeRequirement

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ZapTocMerger.ForceMergeRequirement The ForceMergeRequirement class contains the requirements to do a forced merging.

Nested classes/interfaces inherited from class javax.help.Merge

javax.help.Merge.DefaultMergeFactory

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,ZapTocMerger.ForceMergeRequirement>	TOC_IDS_FORCE_MERGE_MAP A map containing the requirements to do forced merging.

Fields inherited from class javax.help.Merge

locale, slaveTopNode

Constructor Summary

Constructors

Constructor and Description
ZapTocMerger(javax.help.NavigatorView master, javax.help.NavigatorView slave)

Method Summary

Modifier and Type	Method and Description
static void	mergeNodeChildren(TreeNode node) Merge Node Children.
static void	mergeNodes(TreeNode master, TreeNode slave) Merge Nodes.
TreeNode	processMerge(TreeNode node) Processes unite-append merge

Methods inherited from class java.lang.Object

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

Field Detail

TOC_IDS_FORCE_MERGE_MAP

public static final Map<String,ZapTocMerger.ForceMergeRequirement> TOC_IDS_FORCE_MERGE_MAP

A map containing the requirements to do forced merging.

The map key corresponds to the attribute "tocid" of the "tocitem" elements as defined in the toc.xml file. The value has the requirements that should be met to actually do the merging.

Constructor Detail

ZapTocMerger

public ZapTocMerger(javax.help.NavigatorView master,
                    javax.help.NavigatorView slave)

Method Detail

processMerge

public TreeNode processMerge(TreeNode node)

Processes unite-append merge

Overrides:

processMerge in class javax.help.UniteAppendMerge

Parameters:

node - The master node

Returns:

Merged master node

mergeNodes

public static void mergeNodes(TreeNode master,
                              TreeNode slave)

Merge Nodes. Merge two nodes according to the merging rules of the masterNode. Each Subclass should override this implementation.

Parameters:

master - The master node to merge with

slave - The node to merge into the master

mergeNodeChildren

public static void mergeNodeChildren(TreeNode node)

Merge Node Children. Merge the children of a node according to the merging rules of the parent. Each subclass must implement this method

Parameters:

node - The parent node from which the children are merged