org.wandora.application.tools.exporters

Class ExportSite

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.exporters.AbstractExportTool

org.wandora.application.tools.exporters.ExportSite

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Runnable, java.util.EventListener, WandoraTool, WandoraToolLogger, TopicMapLogger

public class ExportSite
extends AbstractExportTool
implements WandoraTool, java.awt.event.ActionListener

ExportSite is a tool to export all topics to separate files, using a velocity template. Normally velocity templates generate HTML resulting interlinked HTML pages.

Author:

pasi, ak

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	authPassword
private java.lang.String	authUser
private javax.swing.JButton	button
(package private) java.lang.Object	codec
(package private) java.io.File	currentDirectory
(package private) Topic	currentTopic
boolean	EXPORT_SELECTION_INSTEAD_TOPIC_MAP
(package private) ExportSiteDialog	exportDialog
private boolean	fetchUrls
(package private) java.lang.String	filesDirectory
private boolean	forceStop
(package private) boolean	forgetAuth
(package private) java.util.Locale	locale
(package private) java.io.PrintWriter	log
(package private) java.lang.String	logName
private long	napAfterFetch
(package private) java.lang.String	outputdir
(package private) java.lang.String	pageindextemplatefile
private javax.swing.JPanel	panel
(package private) Wandora	parent
(package private) int	resizeHeight
(package private) boolean	resizeImages
(package private) int	resizeQuality
(package private) int	resizeWidth
(package private) java.lang.String	secondaryUrlSource
(package private) java.lang.String	siurl
(package private) java.lang.String	templateEncoding
(package private) java.lang.String	templatefile
(package private) TopicMap	topicMap
(package private) java.lang.String	topicmapfile
(package private) boolean	useScondaryUrlSource

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
ExportSite() Creates a new instance of ExportSite
ExportSite(boolean exportSite)
ExportSite(java.util.Map map)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent actionEvent)
private void	collectParams(java.util.HashMap localParams, Topic currentTopic, TopicMap topicMap, java.util.Locale loc)
void	execute(Wandora admin, Context context) Runs the tool.
private void	fetchSubjectLocator(Topic t, java.lang.String directoryToStore, java.lang.String filesDir, java.util.HashMap urlmap)
private java.lang.String	fetchURL(java.lang.String surl, java.lang.String directoryStore, java.lang.String filesDir)
void	generateFilesFromTopicMap(java.lang.Object topicmap, java.lang.String templatefilename, java.lang.String templateEncoding, java.lang.String indextemplatefilename, Topic currentTopic, java.lang.String outputdir, java.util.Locale loc, java.lang.Object codec)
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.
private TopicMap	initTM(java.lang.String uri)
boolean	requiresRefresh() If any visible topic has been changed during tool execution GUI is automatically refreshed.
private void	takeNap(long napTime)
private TopicMap	topicMapFromFile(java.lang.String topicMapFileName)
private void	webPageIndexBuild(java.util.Map index, Topic t, java.lang.String webfilename, java.util.Locale loc)
void	work()

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

EXPORT_SELECTION_INSTEAD_TOPIC_MAP

public boolean EXPORT_SELECTION_INSTEAD_TOPIC_MAP

templateEncoding

java.lang.String templateEncoding

topicmapfile

java.lang.String topicmapfile

outputdir

java.lang.String outputdir

siurl

java.lang.String siurl

templatefile

java.lang.String templatefile

pageindextemplatefile

java.lang.String pageindextemplatefile

parent

Wandora parent

currentDirectory

java.io.File currentDirectory

codec

java.lang.Object codec

locale

java.util.Locale locale

topicMap

TopicMap topicMap

resizeImages

boolean resizeImages

resizeWidth

int resizeWidth

resizeHeight

int resizeHeight

resizeQuality

int resizeQuality

log

java.io.PrintWriter log

button

private javax.swing.JButton button

panel

private javax.swing.JPanel panel

forceStop

private boolean forceStop

fetchUrls

private boolean fetchUrls

napAfterFetch

private long napAfterFetch

authUser

private java.lang.String authUser

authPassword

private java.lang.String authPassword

forgetAuth

boolean forgetAuth

useScondaryUrlSource

boolean useScondaryUrlSource

secondaryUrlSource

java.lang.String secondaryUrlSource

logName

java.lang.String logName

filesDirectory

java.lang.String filesDirectory

currentTopic

Topic currentTopic

exportDialog

ExportSiteDialog exportDialog

Constructor Detail

ExportSite

public ExportSite()

Creates a new instance of ExportSite

ExportSite

public ExportSite(boolean exportSite)

ExportSite

public ExportSite(java.util.Map map)

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.

work

public void work()

takeNap

private void takeNap(long napTime)

topicMapFromFile

private TopicMap topicMapFromFile(java.lang.String topicMapFileName)

initTM

private TopicMap initTM(java.lang.String uri)

collectParams

private void collectParams(java.util.HashMap localParams,
                           Topic currentTopic,
                           TopicMap topicMap,
                           java.util.Locale loc)

fetchSubjectLocator

private void fetchSubjectLocator(Topic t,
                                 java.lang.String directoryToStore,
                                 java.lang.String filesDir,
                                 java.util.HashMap urlmap)
                          throws TopicMapException

Throws:

TopicMapException

fetchURL

private java.lang.String fetchURL(java.lang.String surl,
                                  java.lang.String directoryStore,
                                  java.lang.String filesDir)

generateFilesFromTopicMap

public void generateFilesFromTopicMap(java.lang.Object topicmap,
                                      java.lang.String templatefilename,
                                      java.lang.String templateEncoding,
                                      java.lang.String indextemplatefilename,
                                      Topic currentTopic,
                                      java.lang.String outputdir,
                                      java.util.Locale loc,
                                      java.lang.Object codec)

webPageIndexBuild

private void webPageIndexBuild(java.util.Map index,
                               Topic t,
                               java.lang.String webfilename,
                               java.util.Locale loc)
                        throws TopicMapException

Throws:

TopicMapException

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent actionEvent)

Specified by:

actionPerformed in interface java.awt.event.ActionListener