org.freehep.jas.plugin.tree
Interface FTreeNodeSorter

All Known Implementing Classes:
SorterAlphabetical, SorterAlphaNumerical, SorterCreationOrder, SorterFolderFirst

public interface FTreeNodeSorter

An interface for sorting FTreeNodes in the FTree.

Author:
The FreeHEP team @ SLAC.

Method Summary
 String algorithmName()
          The name of the sorting algorithm.
 String description()
          The description of what the algorithm does.
 int sort(FTreeNode node1, FTreeNode node2)
          Sort two FTreeNodes.
 

Method Detail

sort

int sort(FTreeNode node1,
         FTreeNode node2)
Sort two FTreeNodes.

Parameters:
node1 - The first node.
node2 - The second node.
Returns:
-1 if node1 comes before node2 0 if their position is interchengable +1 if node1 comes after node2

algorithmName

String algorithmName()
The name of the sorting algorithm.

Returns:
The name of the algorithm.

description

String description()
The description of what the algorithm does.

Returns:
The description.


Copyright © 2013. All Rights Reserved.