org.wandora.application.tools

Class PasteTopics

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.PasteTopics

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, WandoraTool, WandoraToolLogger, TopicMapLogger

Direct Known Subclasses:

PasteClasses, PasteInstances

public class PasteTopics
extends AbstractWandoraTool
implements WandoraTool

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	ACCEPT_UNKNOWN_TOPICS
boolean	ASK_TOPIC_CREATION
java.util.Iterator	contextTopics
Topic	currentTopic
boolean	forceStop
static int	INCLUDE_CLASSES
static int	INCLUDE_INSTANCES
static int	INCLUDE_NAMES
static int	INCLUDE_NOTHING
static int	INCLUDE_PLAYERS
static int	INCLUDE_SIS
static int	INCLUDE_SLS
static int	INCLUDE_TEXTDATAS
int	includeOrders
static int	PASTE_BASENAMES
static int	PASTE_SIS
int	pasteOrders
boolean	PLAYER_SHOULD_NOT_BE_EQUAL_TO_INSTANCE
TopicMap	topicMap
boolean	USER_HAS_BEEN_ASKED

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
PasteTopics()
PasteTopics(Context context)
PasteTopics(Context context, int includeOrders)
PasteTopics(Context context, int includeOrders, int pasteOrders)
PasteTopics(int includeOrders)
PasteTopics(int includeOrders, int pasteOrders)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora admin, Context context) Runs the tool.
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
Topic	getTopic(Wandora admin, TopicMap topicMap, java.lang.String identifier, boolean isBasename)
void	initialize(Wandora wandora)
boolean	isKnownTopic(Topic topic, Context context)
void	setDisplayName(Topic t, java.lang.String lang, java.lang.String name)
void	setPasteOrders(int pasteOrders)
void	setTextdata(Topic t, Topic type, java.lang.String version, java.lang.String data)
void	topicEpilogue(Topic topic)
void	topicPrologue(Topic topic)

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, configure, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getIcon, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, getType, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, requiresRefresh, run, runInOwnThread, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap, writeOptions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wandora.application.WandoraTool

configure, execute, execute, getContext, getIcon, getToolMenuItem, getType, hlog, initialize, isConfigurable, isRunning, log, log, log, log, requiresRefresh, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

forceStop, getHistory, getState, lockLog, setLogTitle, setProgress, setProgressMax, setState

Field Detail

PASTE_SIS

public static final int PASTE_SIS

See Also:

Constant Field Values

PASTE_BASENAMES

public static final int PASTE_BASENAMES

See Also:

Constant Field Values

INCLUDE_NAMES

public static final int INCLUDE_NAMES

See Also:

Constant Field Values

INCLUDE_CLASSES

public static final int INCLUDE_CLASSES

See Also:

Constant Field Values

INCLUDE_INSTANCES

public static final int INCLUDE_INSTANCES

See Also:

Constant Field Values

INCLUDE_SLS

public static final int INCLUDE_SLS

See Also:

Constant Field Values

INCLUDE_SIS

public static final int INCLUDE_SIS

See Also:

Constant Field Values

INCLUDE_PLAYERS

public static final int INCLUDE_PLAYERS

See Also:

Constant Field Values

INCLUDE_TEXTDATAS

public static final int INCLUDE_TEXTDATAS

See Also:

Constant Field Values

INCLUDE_NOTHING

public static final int INCLUDE_NOTHING

See Also:

Constant Field Values

includeOrders

public int includeOrders

pasteOrders

public int pasteOrders

forceStop

public boolean forceStop

PLAYER_SHOULD_NOT_BE_EQUAL_TO_INSTANCE

public boolean PLAYER_SHOULD_NOT_BE_EQUAL_TO_INSTANCE

ASK_TOPIC_CREATION

public boolean ASK_TOPIC_CREATION

ACCEPT_UNKNOWN_TOPICS

public boolean ACCEPT_UNKNOWN_TOPICS

USER_HAS_BEEN_ASKED

public boolean USER_HAS_BEEN_ASKED

contextTopics

public java.util.Iterator contextTopics

currentTopic

public Topic currentTopic

topicMap

public TopicMap topicMap

Constructor Detail

PasteTopics

public PasteTopics()

PasteTopics

public PasteTopics(int includeOrders)

PasteTopics

public PasteTopics(int includeOrders,
                   int pasteOrders)

PasteTopics

public PasteTopics(Context context)

PasteTopics

public PasteTopics(Context context,
                   int includeOrders)

PasteTopics

public PasteTopics(Context context,
                   int includeOrders,
                   int pasteOrders)

Method Detail

initialize

public void initialize(Wandora wandora)

execute

public void execute(Wandora admin,
                    Context context)

Description copied from interface: WandoraTool

Runs the tool. This is the main entry to the tool. Here the context

Specified by:

execute in interface WandoraTool

topicPrologue

public void topicPrologue(Topic topic)

topicEpilogue

public void topicEpilogue(Topic topic)

getName

public java.lang.String getName()

Description copied from class: AbstractWandoraTool

Tools name represent the tool in UI unless the tool has been given explicitly another GUI name. All tools should override this method and return a valid string representing name of the tool.

Specified by:

getName in interface WandoraTool

Overrides:

getName in class AbstractWandoraTool

Returns:

String representing tool's name.

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractWandoraTool

AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu. By default description equals the tool name. All tools should override this method.

Specified by:

getDescription in interface WandoraTool

Overrides:

getDescription in class AbstractWandoraTool

Returns:

String representing tool's description.

setPasteOrders

public void setPasteOrders(int pasteOrders)

getTopic

public Topic getTopic(Wandora admin,
                      TopicMap topicMap,
                      java.lang.String identifier,
                      boolean isBasename)
               throws TopicMapException

Throws:

TopicMapException

isKnownTopic

public boolean isKnownTopic(Topic topic,
                            Context context)
                     throws TopicMapException

Throws:

TopicMapException

setDisplayName

public void setDisplayName(Topic t,
                           java.lang.String lang,
                           java.lang.String name)
                    throws TopicMapException

Throws:

TopicMapException

setTextdata

public void setTextdata(Topic t,
                        Topic type,
                        java.lang.String version,
                        java.lang.String data)
                 throws TopicMapException

Throws:

TopicMapException