net.ontopia.topicmaps.utils

Class DisplayNameGrabber

java.lang.Object

net.ontopia.topicmaps.utils.DisplayNameGrabber

All Implemented Interfaces:

Function<TopicIF,NameIF>, GrabberIF<TopicIF,NameIF>

Deprecated.

Since 1.1. Use TopicCharacteristicGrabbers instead.

@Deprecated
public class DisplayNameGrabber
extends Object
implements GrabberIF<TopicIF,NameIF>

PUBLIC: Grabber that grabs the name most suitable for display from a topic. If the topic has a display name that will be chosen. If not, the base name in the least constrained scope will be chosen.

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<? super TopicIF,NameIF>	subGrabber Deprecated. PROTECTED: The NameGrabber used to implement the grabbing.

Constructor Summary

Constructors

Constructor and Description
DisplayNameGrabber() Deprecated. PUBLIC: Creates the grabber and sets the comparator to be a ScopedIFComparator using the least constrained scope.

Method Summary

Modifier and Type	Method and Description
NameIF	grab(TopicIF object) Deprecated. PUBLIC: Grabs the name for display.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ontopia.utils.GrabberIF

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

subGrabber

protected Function<? super TopicIF,NameIF> subGrabber

Deprecated.

PROTECTED: The NameGrabber used to implement the grabbing.

Constructor Detail

DisplayNameGrabber

public DisplayNameGrabber()

Deprecated.

PUBLIC: Creates the grabber and sets the comparator to be a ScopedIFComparator using the least constrained scope.

Method Detail

grab

public NameIF grab(TopicIF object)

Deprecated.

PUBLIC: Grabs the name for display. The name returned is the first display (variant) name found, when the basenames of the give topic have been sorted using the comparator. If there is no display name, then the last base name found is returned, corresponding to the least constrained scope.

Specified by:

grab in interface GrabberIF<TopicIF,NameIF>

Parameters:

object - The topic whose name is being grabbed; formally an object.

Returns:

A name to display; an object implementing TopicNameIF or VariantNameIF, null if the topic has no basenames.

Throws:

Throws - OntopiaRuntimeException if object is not a topic.