net.ontopia.topicmaps.nav.utils.comparators
Class TopicComparator

java.lang.Object
  extended by net.ontopia.topicmaps.nav.utils.comparators.TopicComparator
All Implemented Interfaces:
Comparator<TopicIF>
Direct Known Subclasses:
OccTypeComparator

public class TopicComparator
extends Object
implements Comparator<TopicIF>

INTERNAL: A Comparator for ordering topics alphabetically. Note that it does not look up the 'sort' topic for you, but that this must be provided explicitly to the constructors.


Field Summary
protected  GrabberIF<TopicIF,NameIF> nameGrabber
           
protected  StringifierIF<NameIF> nameStringifier
           
 
Constructor Summary
TopicComparator()
          Empty constructor, used on application startup to initialise a "fast" comparator which will compare Topics using no context.
TopicComparator(Collection<TopicIF> baseNameContext)
          Constructor used to make a comparator which will compare Topics using the contexts provided.
TopicComparator(Collection<TopicIF> baseNameContext, Collection<TopicIF> variantNameContext)
          Constructor used to make a comparator which will compare Topics using the contexts provided.
 
Method Summary
 int compare(TopicIF o1, TopicIF o2)
          implementing method which is required for Comparator interface.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Comparator
equals
 

Field Detail

nameGrabber

protected GrabberIF<TopicIF,NameIF> nameGrabber

nameStringifier

protected StringifierIF<NameIF> nameStringifier
Constructor Detail

TopicComparator

public TopicComparator()
Empty constructor, used on application startup to initialise a "fast" comparator which will compare Topics using no context.


TopicComparator

public TopicComparator(Collection<TopicIF> baseNameContext)
Constructor used to make a comparator which will compare Topics using the contexts provided.


TopicComparator

public TopicComparator(Collection<TopicIF> baseNameContext,
                       Collection<TopicIF> variantNameContext)
Constructor used to make a comparator which will compare Topics using the contexts provided. The variantNameContext will generally be a Sort topic if is available. This is the default applied by the application.

Method Detail

compare

public int compare(TopicIF o1,
                   TopicIF o2)
implementing method which is required for Comparator interface.

Specified by:
compare in interface Comparator<TopicIF>


Copyright © 2000-2012 Ontopia.