net.ontopia.topicmaps.utils
Class TopicCharacteristicGrabbers

java.lang.Object
  net.ontopia.topicmaps.utils.TopicCharacteristicGrabbers

public class TopicCharacteristicGrabbers
extends Object

INTERNAL: A convenience class for creating grabbers that grab specific topic characteristics, using various criteria, including scope.

Since:

1.1

Method Summary

static GrabberIF	getDisplayNameGrabber() INTERNAL: Returns a grabber that will grab the name most suitable for display from a topic.
static GrabberIF	getSortNameGrabber() INTERNAL: Returns a grabber that will grab the name most suitable for sorting from a topic.

Methods inherited from class java.lang.Object

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

Method Detail

getDisplayNameGrabber

public static GrabberIF getDisplayNameGrabber()

INTERNAL: Returns a grabber that will grab the name most suitable for display from a topic. If the topic has a display name that name will be chosen. If not, the base name in the least constrained scope will be chosen.

Returns:

A TopicNameIF or VariantNameIF object; null if the topic has no base names.

getSortNameGrabber

public static GrabberIF getSortNameGrabber()

INTERNAL: Returns a grabber that will grab the name most suitable for sorting from a topic. If the topic has a sort name that name will be chosen. If not, the base name in the least constrained scope will be chosen.

Returns:

A TopicNameIF or VariantNameIF object; null if the topic has no base names.