org.wandora.application.tools.exporters

Class SimilarityMatrixExport

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.exporters.AbstractExportTool

org.wandora.application.tools.exporters.SimilarityMatrixExport

All Implemented Interfaces:

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

public class SimilarityMatrixExport
extends AbstractExportTool
implements WandoraTool

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private TopicSimilarity	currentSimilarityMeasure
private boolean	exportSelectionInsteadOfTopicMap
private double	filterBelow
static java.lang.String	HTML_FORMAT
private boolean	labelMatrix
private double	maximizeAbove
private int	numberOfDecimals
private java.lang.String	outputFormat
private boolean	outputZeros
private SimilarityMatrixExportDialog	similarityDialog
private boolean	sortColumns
static java.lang.String	TAB_FORMAT

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
SimilarityMatrixExport()
SimilarityMatrixExport(boolean exportSelection)

Method Summary

Modifier and Type	Method and Description
double	calculateSimilarity(Topic t1, Topic t2)
void	execute(Wandora admin, Context context) Runs the tool.
void	exportMatrix(java.io.OutputStream out, java.util.Iterator<Topic> topicIterator, WandoraToolLogger logger)
void	exportMatrixAsHTMLTable(java.io.PrintWriter writer, java.util.ArrayList<Topic> topics, WandoraToolLogger logger)
void	exportMatrixAsTabText(java.io.PrintWriter writer, java.util.ArrayList<Topic> topics, WandoraToolLogger logger)
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
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.
protected java.lang.String	makeString(Topic t)
protected void	print(java.io.PrintWriter writer, java.lang.String str)
protected void	println(java.io.PrintWriter writer, java.lang.String str)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
protected double	roundSimilarity(double s, int n)

Methods inherited from class org.wandora.application.tools.exporters.AbstractExportTool

getType, makeTopicMapWith, makeTopicMapWith

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, 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

TAB_FORMAT

public static final java.lang.String TAB_FORMAT

See Also:

Constant Field Values

HTML_FORMAT

public static final java.lang.String HTML_FORMAT

See Also:

Constant Field Values

similarityDialog

private SimilarityMatrixExportDialog similarityDialog

labelMatrix

private boolean labelMatrix

outputFormat

private java.lang.String outputFormat

sortColumns

private boolean sortColumns

numberOfDecimals

private int numberOfDecimals

filterBelow

private double filterBelow

maximizeAbove

private double maximizeAbove

outputZeros

private boolean outputZeros

exportSelectionInsteadOfTopicMap

private boolean exportSelectionInsteadOfTopicMap

currentSimilarityMeasure

private TopicSimilarity currentSimilarityMeasure

Constructor Detail

SimilarityMatrixExport

public SimilarityMatrixExport()

SimilarityMatrixExport

public SimilarityMatrixExport(boolean exportSelection)

Method Detail

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 AbstractExportTool

Returns:

icon for the tool.

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.

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

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.

exportMatrix

public void exportMatrix(java.io.OutputStream out,
                         java.util.Iterator<Topic> topicIterator,
                         WandoraToolLogger logger)
                  throws TopicMapException

Throws:

TopicMapException

exportMatrixAsTabText

public void exportMatrixAsTabText(java.io.PrintWriter writer,
                                  java.util.ArrayList<Topic> topics,
                                  WandoraToolLogger logger)
                           throws TopicMapException

Throws:

TopicMapException

exportMatrixAsHTMLTable

public void exportMatrixAsHTMLTable(java.io.PrintWriter writer,
                                    java.util.ArrayList<Topic> topics,
                                    WandoraToolLogger logger)
                             throws TopicMapException

Throws:

TopicMapException

calculateSimilarity

public double calculateSimilarity(Topic t1,
                                  Topic t2)

roundSimilarity

protected double roundSimilarity(double s,
                                 int n)

makeString

protected java.lang.String makeString(Topic t)
                               throws TopicMapException

Throws:

TopicMapException

print

protected void print(java.io.PrintWriter writer,
                     java.lang.String str)

println

protected void println(java.io.PrintWriter writer,
                       java.lang.String str)