org.wandora.application.tools

Class CopyTopics

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.CopyTopics

All Implemented Interfaces:

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

Direct Known Subclasses:

CopyTopicAssociationTypes, CopyTopicClasses, CopyTopicInstances, CopyTopicPlayers, CopyTopicRoles

public class CopyTopics
extends AbstractWandoraTool
implements WandoraTool

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.ArrayList<Topic>	allOccurrenceTypes
(package private) Topic	associationType
static int	COPY_BASENAMES
static int	COPY_SIS
int	copyOrders
static int	INCLUDE_ALL_OCCURRENCES
static int	INCLUDE_ASSOCIATION_COUNT
static int	INCLUDE_ASSOCIATION_TYPES
static int	INCLUDE_CLASS_COUNT
static int	INCLUDE_CLASSES
static int	INCLUDE_CLUSTER_COEFFICIENT
static int	INCLUDE_INSTANCE_COUNT
static int	INCLUDE_INSTANCES
static int	INCLUDE_LAYER_DISTRIBUTION
static int	INCLUDE_NAMES
static int	INCLUDE_NAMES_AND_SCOPES
static int	INCLUDE_NOTHING
static int	INCLUDE_OCCURRENCE_COUNT
static int	INCLUDE_OCCURRENCE_TYPES
static int	INCLUDE_OCCURRENCES
static int	INCLUDE_PLAYED_ROLES
static int	INCLUDE_PLAYERS
static int	INCLUDE_SI_COUNT
static int	INCLUDE_SIS
static int	INCLUDE_SLS
static int	INCLUDE_TYPED_ASSOCIATION_COUNT
int	includeOrders
static java.lang.String	NEW_LINE_SUBSTITUTE_STRING
static java.lang.String	NO_BASENAME_STRING
(package private) Topic	occurrenceType
static boolean	OUTPUT_LOG
(package private) Topic	role
(package private) java.util.LinkedHashSet<Topic>	scopeMemory
static java.lang.String	TAB_SUBSTITUTE_STRING
(package private) java.util.Iterator	topics
(package private) Wandora	wandora

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
CopyTopics()
CopyTopics(java.util.Collection topics, int includeOrders)
CopyTopics(java.util.Collection topics, int copyOrders, int includeOrders)
CopyTopics(Context context, int includeOrders)
CopyTopics(Context context, int copyOrders, int includeOrders)
CopyTopics(int includeOrders)
CopyTopics(int copyOrders, int includeOrders)
CopyTopics(Wandora admin, java.util.Collection topics)
CopyTopics(Wandora admin, java.util.Collection topics, int includeOrders)
CopyTopics(Wandora admin, java.util.Collection topics, int copyOrders, int includeOrders)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora wandora, 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.
private java.lang.String	getDisplayName(Topic t, java.lang.String lang)
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
private java.util.ArrayList<Topic>	getOccurrenceTypes(TopicMap tm)
private java.lang.String	getTextData(Topic t, Topic type, java.lang.String versions)
java.lang.String	getTopicTypeName()
protected void	initialize(int copyOrders, int includeOrders)
private java.lang.String	makeDistributionVector(LayeredTopic topic, ContainerTopicMap tm)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
void	setTopics(java.util.Collection topics)
void	setTopics(Topic[] topicArray)
private java.lang.String	stringSerialize(java.util.ArrayList<java.lang.String> lines)
void	work()

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, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, getType, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, 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, getToolMenuItem, getType, hlog, initialize, isConfigurable, isRunning, log, log, log, log, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

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

Field Detail

OUTPUT_LOG

public static final boolean OUTPUT_LOG

See Also:

Constant Field Values

NEW_LINE_SUBSTITUTE_STRING

public static java.lang.String NEW_LINE_SUBSTITUTE_STRING

TAB_SUBSTITUTE_STRING

public static java.lang.String TAB_SUBSTITUTE_STRING

NO_BASENAME_STRING

public static java.lang.String NO_BASENAME_STRING

COPY_BASENAMES

public static final int COPY_BASENAMES

See Also:

Constant Field Values

COPY_SIS

public static final int COPY_SIS

See Also:

Constant Field Values

INCLUDE_NOTHING

public static final int INCLUDE_NOTHING

See Also:

Constant Field Values

INCLUDE_NAMES

public static final int INCLUDE_NAMES

See Also:

Constant Field Values

INCLUDE_NAMES_AND_SCOPES

public static final int INCLUDE_NAMES_AND_SCOPES

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_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_PLAYERS

public static final int INCLUDE_PLAYERS

See Also:

Constant Field Values

INCLUDE_PLAYED_ROLES

public static final int INCLUDE_PLAYED_ROLES

See Also:

Constant Field Values

INCLUDE_OCCURRENCES

public static final int INCLUDE_OCCURRENCES

See Also:

Constant Field Values

INCLUDE_ALL_OCCURRENCES

public static final int INCLUDE_ALL_OCCURRENCES

See Also:

Constant Field Values

INCLUDE_OCCURRENCE_TYPES

public static final int INCLUDE_OCCURRENCE_TYPES

See Also:

Constant Field Values

INCLUDE_ASSOCIATION_TYPES

public static final int INCLUDE_ASSOCIATION_TYPES

See Also:

Constant Field Values

INCLUDE_SI_COUNT

public static final int INCLUDE_SI_COUNT

See Also:

Constant Field Values

INCLUDE_CLASS_COUNT

public static final int INCLUDE_CLASS_COUNT

See Also:

Constant Field Values

INCLUDE_INSTANCE_COUNT

public static final int INCLUDE_INSTANCE_COUNT

See Also:

Constant Field Values

INCLUDE_ASSOCIATION_COUNT

public static final int INCLUDE_ASSOCIATION_COUNT

See Also:

Constant Field Values

INCLUDE_TYPED_ASSOCIATION_COUNT

public static final int INCLUDE_TYPED_ASSOCIATION_COUNT

See Also:

Constant Field Values

INCLUDE_OCCURRENCE_COUNT

public static final int INCLUDE_OCCURRENCE_COUNT

See Also:

Constant Field Values

INCLUDE_LAYER_DISTRIBUTION

public static final int INCLUDE_LAYER_DISTRIBUTION

See Also:

Constant Field Values

INCLUDE_CLUSTER_COEFFICIENT

public static final int INCLUDE_CLUSTER_COEFFICIENT

See Also:

Constant Field Values

copyOrders

public int copyOrders

includeOrders

public int includeOrders

associationType

Topic associationType

role

Topic role

occurrenceType

Topic occurrenceType

allOccurrenceTypes

java.util.ArrayList<Topic> allOccurrenceTypes

scopeMemory

java.util.LinkedHashSet<Topic> scopeMemory

wandora

Wandora wandora

topics

java.util.Iterator topics

Constructor Detail

CopyTopics

public CopyTopics()
           throws TopicMapException

Throws:

TopicMapException

CopyTopics

public CopyTopics(Wandora admin,
                  java.util.Collection topics)
           throws TopicMapException

Throws:

TopicMapException

CopyTopics

public CopyTopics(Wandora admin,
                  java.util.Collection topics,
                  int includeOrders)
           throws TopicMapException

Throws:

TopicMapException

CopyTopics

public CopyTopics(Wandora admin,
                  java.util.Collection topics,
                  int copyOrders,
                  int includeOrders)
           throws TopicMapException

Throws:

TopicMapException

CopyTopics

public CopyTopics(java.util.Collection topics,
                  int includeOrders)

CopyTopics

public CopyTopics(java.util.Collection topics,
                  int copyOrders,
                  int includeOrders)

CopyTopics

public CopyTopics(int copyOrders,
                  int includeOrders)

CopyTopics

public CopyTopics(int includeOrders)

CopyTopics

public CopyTopics(Context context,
                  int copyOrders,
                  int includeOrders)

CopyTopics

public CopyTopics(Context context,
                  int includeOrders)

Method Detail

initialize

protected void initialize(int copyOrders,
                          int includeOrders)

getIcon

public javax.swing.Icon getIcon()

Description copied from class: AbstractWandoraTool

All tools may have identifying graphic icon used within tool GUI elements. getIcon should return Icon object of the tool.

Specified by:

getIcon in interface WandoraTool

Overrides:

getIcon in class AbstractWandoraTool

Returns:

icon for the tool.

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.

getTopicTypeName

public java.lang.String getTopicTypeName()

requiresRefresh

public boolean requiresRefresh()

Description copied from class: AbstractWandoraTool

If any visible topic has been changed during tool execution GUI is automatically refreshed. If tool doesn't change topics but GUI still requires refresh, tool should override this method and return true.

For example tools that alter the GUI but change no topics should return true.

Specified by:

requiresRefresh in interface WandoraTool

Overrides:

requiresRefresh in class AbstractWandoraTool

Returns:

true if Wandora application should refresh user interface.

setTopics

public void setTopics(java.util.Collection topics)

setTopics

public void setTopics(Topic[] topicArray)

execute

public void execute(Wandora wandora,
                    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

work

public void work()

stringSerialize

private java.lang.String stringSerialize(java.util.ArrayList<java.lang.String> lines)

makeDistributionVector

private java.lang.String makeDistributionVector(LayeredTopic topic,
                                                ContainerTopicMap tm)
                                         throws TopicMapException

Throws:

TopicMapException

getDisplayName

private java.lang.String getDisplayName(Topic t,
                                        java.lang.String lang)
                                 throws TopicMapException

Throws:

TopicMapException

getTextData

private java.lang.String getTextData(Topic t,
                                     Topic type,
                                     java.lang.String versions)
                              throws TopicMapException

Throws:

TopicMapException

getOccurrenceTypes

private java.util.ArrayList<Topic> getOccurrenceTypes(TopicMap tm)
                                               throws TopicMapException

Throws:

TopicMapException