org.wandora.application.tools.mediawiki

Class MediawikiOccurrenceUploader

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.mediawiki.MediawikiHandler

org.wandora.application.tools.mediawiki.MediawikiOccurrenceUploader

All Implemented Interfaces:

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

public class MediawikiOccurrenceUploader
extends MediawikiHandler
implements WandoraTool

Author:

nlaitine

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	cancelled
private static MediawikiUploaderConfiguration	config
private static MediawikiUploaderConfigurationUI	configurationUI
private boolean	isConfigured
private boolean	requiresRefresh
private boolean	uploadAll

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
MediawikiOccurrenceUploader()
MediawikiOccurrenceUploader(boolean upAll)
MediawikiOccurrenceUploader(Context proposedContext)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora wandora, Context context) Runs the tool.
private java.lang.String	filenameFromUrl(java.net.URL url, java.lang.String extension)
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.
private boolean	loginToWiki()
private boolean	logoutOfWiki()
boolean	mediaWikiUpload(java.lang.String o)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
MediawikiUploaderConfiguration	setupUI(Wandora wandora, java.util.HashSet dataTypes, java.lang.String o, Topic carrier, Topic lang, boolean batch)
private java.net.URL	stringToUrl(java.lang.String fileString)

Methods inherited from class org.wandora.application.tools.mediawiki.MediawikiHandler

callWiki, isValidResourceReference, login, logout, uploadStreamToWiki, uploadToWiki

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, 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, setContext, setToolLogger, writeOptions

Methods inherited from interface org.wandora.application.WandoraToolLogger

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

Field Detail

configurationUI

private static MediawikiUploaderConfigurationUI configurationUI

config

private static MediawikiUploaderConfiguration config

requiresRefresh

private boolean requiresRefresh

isConfigured

private boolean isConfigured

cancelled

private boolean cancelled

uploadAll

private boolean uploadAll

Constructor Detail

MediawikiOccurrenceUploader

public MediawikiOccurrenceUploader()

MediawikiOccurrenceUploader

public MediawikiOccurrenceUploader(boolean upAll)

MediawikiOccurrenceUploader

public MediawikiOccurrenceUploader(Context proposedContext)

Method Detail

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.

execute

public void execute(Wandora wandora,
                    Context context)
             throws TopicMapException

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

Throws:

TopicMapException

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.

setupUI

public MediawikiUploaderConfiguration setupUI(Wandora wandora,
                                              java.util.HashSet dataTypes,
                                              java.lang.String o,
                                              Topic carrier,
                                              Topic lang,
                                              boolean batch)
                                       throws TopicMapException

Throws:

TopicMapException

loginToWiki

private boolean loginToWiki()

logoutOfWiki

private boolean logoutOfWiki()

mediaWikiUpload

public boolean mediaWikiUpload(java.lang.String o)
                        throws TopicMapException

Throws:

TopicMapException

stringToUrl

private java.net.URL stringToUrl(java.lang.String fileString)

filenameFromUrl

private java.lang.String filenameFromUrl(java.net.URL url,
                                         java.lang.String extension)