org.wandora.application.gui.topicstringify

Class DefaultTopicStringifier

java.lang.Object

org.wandora.application.gui.topicstringify.DefaultTopicStringifier

All Implemented Interfaces:

TopicStringifier

public class DefaultTopicStringifier
extends java.lang.Object
implements TopicStringifier

Author:

akivela

Field Summary

Fields

Modifier and Type	Field and Description
private int	stringType
static int	TOPIC_RENDERS_BASENAME
static int	TOPIC_RENDERS_BASENAME_WITH_INFO
static int	TOPIC_RENDERS_BASENAME_WITH_SL_ICON
static int	TOPIC_RENDERS_ENGLISH_DISPLAY_NAME
static int	TOPIC_RENDERS_SI
static int	TOPIC_RENDERS_SI_WITHOUT_DOMAIN
static int	TOPIC_RENDERS_SL
private Wandora	wandora

Constructor Summary

Constructors

Constructor and Description
DefaultTopicStringifier()
DefaultTopicStringifier(int type)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	_toString(Topic t, int stringType)
java.lang.String	getDescription() Description is a text that describes the TopicStringifier.
javax.swing.Icon	getIcon() Method returns an icon shown in Wandora UI as a mark of the TopicStringifier.
static java.lang.String	getTopicInfo(Topic t)
boolean	initialize(Wandora wandora, Context context) Initialization method is called before a TopicStringifier is actually used.
void	stringIntoTopic(java.lang.String oldString, java.lang.String newString, Topic t) Sometimes topic viewer may support string editing feature.
boolean	supportsStringIntoTopic() If topic viewer supports string editing feature and Wandora can push the string back into the topic, this method should return true.
java.lang.String	toString(Topic t) toString method is the actual endpoint used to create a string out of a topic.

Methods inherited from class java.lang.Object

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

Field Detail

TOPIC_RENDERS_SL

public static final int TOPIC_RENDERS_SL

See Also:

Constant Field Values

TOPIC_RENDERS_SI

public static final int TOPIC_RENDERS_SI

See Also:

Constant Field Values

TOPIC_RENDERS_SI_WITHOUT_DOMAIN

public static final int TOPIC_RENDERS_SI_WITHOUT_DOMAIN

See Also:

Constant Field Values

TOPIC_RENDERS_BASENAME

public static final int TOPIC_RENDERS_BASENAME

See Also:

Constant Field Values

TOPIC_RENDERS_BASENAME_WITH_SL_ICON

public static final int TOPIC_RENDERS_BASENAME_WITH_SL_ICON

See Also:

Constant Field Values

TOPIC_RENDERS_BASENAME_WITH_INFO

public static final int TOPIC_RENDERS_BASENAME_WITH_INFO

See Also:

Constant Field Values

TOPIC_RENDERS_ENGLISH_DISPLAY_NAME

public static final int TOPIC_RENDERS_ENGLISH_DISPLAY_NAME

See Also:

Constant Field Values

stringType

private int stringType

wandora

private Wandora wandora

Constructor Detail

DefaultTopicStringifier

public DefaultTopicStringifier()

DefaultTopicStringifier

public DefaultTopicStringifier(int type)

Method Detail

initialize

public boolean initialize(Wandora wandora,
                          Context context)

Description copied from interface: TopicStringifier

Initialization method is called before a TopicStringifier is actually used. If initialization returns false, the TopicStringifier should not be used.

Specified by:

initialize in interface TopicStringifier

getDescription

public java.lang.String getDescription()

Description copied from interface: TopicStringifier

Description is a text that describes the TopicStringifier. Text is shown in Wandora's UI whenever user wants more information about the TopicStringifier, for example, as a tooltip text.

Specified by:

getDescription in interface TopicStringifier

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: TopicStringifier

Method returns an icon shown in Wandora UI as a mark of the TopicStringifier. Current Wandora views the icon in the infobar near topic's name.

Specified by:

getIcon in interface TopicStringifier

toString

public java.lang.String toString(Topic t)

Description copied from interface: TopicStringifier

toString method is the actual endpoint used to create a string out of a topic.

Specified by:

toString in interface TopicStringifier

_toString

public static java.lang.String _toString(Topic t,
                                         int stringType)

getTopicInfo

public static java.lang.String getTopicInfo(Topic t)

supportsStringIntoTopic

public boolean supportsStringIntoTopic()

Description copied from interface: TopicStringifier

If topic viewer supports string editing feature and Wandora can push the string back into the topic, this method should return true. If TopicStringifier can't push a string back into the topic, method should return false. The push is implemented in method stringIntoTopic.

Specified by:

supportsStringIntoTopic in interface TopicStringifier

stringIntoTopic

public void stringIntoTopic(java.lang.String oldString,
                            java.lang.String newString,
                            Topic t)
                     throws TopicMapException

Description copied from interface: TopicStringifier

Sometimes topic viewer may support string editing feature. This method is used to push string back into a topic. String is stored into the topic.

Specified by:

stringIntoTopic in interface TopicStringifier

Throws:

TopicMapException