javax.help
Class Merge

java.lang.Object
  extended byjavax.help.Merge
Direct Known Subclasses:
AppendMerge, NoMerge, SortMerge, UniteAppendMerge

public abstract class Merge
extends java.lang.Object

Common superclass for all merge types


Nested Class Summary
static class Merge.DefaultMergeFactory
          Default Merge factory which creates concrete Merge objects
 
Field Summary
protected  java.util.Locale locale
          HelpSet's locale which is used in sorting
protected  javax.swing.tree.DefaultMutableTreeNode slaveTopNode
          Slave node
 
Constructor Summary
protected Merge(NavigatorView master, NavigatorView slave)
          Constructs Merge for master and slave NavigatorViews
 
Method Summary
static void mergeNodeChildren(javax.swing.tree.TreeNode node)
          Merge Node Children.
static void mergeNodes(javax.swing.tree.TreeNode master, javax.swing.tree.TreeNode slave)
          Merge Nodes.
abstract  javax.swing.tree.TreeNode processMerge(javax.swing.tree.TreeNode node)
          Processes merge.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

slaveTopNode

protected javax.swing.tree.DefaultMutableTreeNode slaveTopNode
Slave node


locale

protected java.util.Locale locale
HelpSet's locale which is used in sorting

Constructor Detail

Merge

protected Merge(NavigatorView master,
                NavigatorView slave)
Constructs Merge for master and slave NavigatorViews

Parameters:
master - The master NavigatorView
slave - The slave NavigatorView
Method Detail

processMerge

public abstract javax.swing.tree.TreeNode processMerge(javax.swing.tree.TreeNode node)
Processes merge. Changes master node according merge rules using slave node.

Parameters:
node - The master node
Returns:
The changed master node

mergeNodes

public static void mergeNodes(javax.swing.tree.TreeNode master,
                              javax.swing.tree.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(javax.swing.tree.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