org.wandora.application.gui.topicstringify

Class TopicStringifierToVariant

java.lang.Object

org.wandora.application.gui.topicstringify.TopicStringifierToVariant

All Implemented Interfaces:

TopicStringifier

public class TopicStringifierToVariant
extends java.lang.Object
implements TopicStringifier

Author:

akivela

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set	scope

Constructor Summary

Constructors

Constructor and Description
TopicStringifierToVariant()
TopicStringifierToVariant(java.util.Set s)

Method Summary

Modifier and Type	Method and Description
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.
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

scope

private java.util.Set scope

Constructor Detail

TopicStringifierToVariant

public TopicStringifierToVariant()

TopicStringifierToVariant

public TopicStringifierToVariant(java.util.Set s)

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

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