org.wandora.application.tools.extractors.datum

Class ExtractTool

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.datum.ExtractTool

All Implemented Interfaces:

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

public class ExtractTool
extends AbstractWandoraTool
implements WandoraTool

Author:

olli, akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	abort
protected DataSource	dataSource
protected DatumExtractor	datumExtractor
protected DatumProcessor	datumProcessor
protected boolean	error
protected boolean	extracting
boolean	guiless
protected ExtractProgressDialog	progressDialog
protected ProgressMonitor	progressMonitor
protected java.util.Map	sourceExtractorMap
protected ExtractToolDialog	toolDialog
protected Wandora	wandoraAdmin

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
ExtractTool() Creates a new instance of ExtractTool
ExtractTool(java.util.Map sourceExtractorMap, DatumProcessor processor)

Method Summary

Modifier and Type	Method and Description
void	abortExtraction()
void	doExtract(TopicMap tm, Logger logger)
void	execute(Wandora admin, Context context) Runs the tool.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
Wandora	getWandora()
void	guiCancel()
void	guilessStart()
void	guiStart(DataSource dataSource)
void	setDataSource(DataSource dataSource)
void	setDatumExtractor(DatumExtractor datumExtractor)
void	setDatumProcessor(DatumProcessor datumProcessor)
void	setProgressMonitor(ProgressMonitor progressMonitor)
protected void	updateProgress(double d)

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

guiless

public boolean guiless

dataSource

protected DataSource dataSource

datumExtractor

protected DatumExtractor datumExtractor

datumProcessor

protected DatumProcessor datumProcessor

progressMonitor

protected ProgressMonitor progressMonitor

toolDialog

protected ExtractToolDialog toolDialog

sourceExtractorMap

protected java.util.Map sourceExtractorMap

progressDialog

protected ExtractProgressDialog progressDialog

wandoraAdmin

protected Wandora wandoraAdmin

abort

protected boolean abort

error

protected boolean error

extracting

protected boolean extracting

Constructor Detail

ExtractTool

public ExtractTool()

Creates a new instance of ExtractTool

ExtractTool

public ExtractTool(java.util.Map sourceExtractorMap,
                   DatumProcessor processor)

Method Detail

updateProgress

protected void updateProgress(double d)

setProgressMonitor

public void setProgressMonitor(ProgressMonitor progressMonitor)

setDataSource

public void setDataSource(DataSource dataSource)

setDatumExtractor

public void setDatumExtractor(DatumExtractor datumExtractor)

setDatumProcessor

public void setDatumProcessor(DatumProcessor datumProcessor)

guilessStart

public void guilessStart()

guiStart

public void guiStart(DataSource dataSource)

guiCancel

public void guiCancel()

abortExtraction

public void abortExtraction()

doExtract

public void doExtract(TopicMap tm,
                      Logger logger)
               throws ExtractionException

Throws:

ExtractionException

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

getWandora

public Wandora getWandora()

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.