org.wandora.application.tools.extractors.word

Class AbstractWordExtractor

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.word.AbstractWordExtractor

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, BrowserPluginExtractor, DropExtractor, WandoraTool, WandoraToolLogger, Handler, InterruptHandler, TopicMapLogger

Direct Known Subclasses:

SimilarityMatchingExtractor, SimpleWordMatchingExtractor

abstract class AbstractWordExtractor
extends AbstractExtractor

Author:

Eero Lehtonen

Field Summary

Fields

Modifier and Type	Field and Description
private Topic	baseTopic
private WordConfiguration	config

Fields inherited from class org.wandora.application.tools.extractors.AbstractExtractor

CUSTOM_EXTRACTOR, DONE_FAILED, DONE_MANY, DONE_ONE, EXACTLY_GIVEN_URLS, FILE_EXTRACTOR, FILE_PATTERN, GIVEN_URLS_AND_ALL_CRAWLED_DOCUMENTS, GIVEN_URLS_AND_CRAWLED_DOCUMENTS_IN_URL_DOMAIN, GIVEN_URLS_AND_LINKED_DOCUMENTS, GIVEN_URLS_AND_URL_BELOW, INFO_WAIT_WHILE_WORKING, LOG_TITLE, POINT_START_URL_TEXT, RAW_EXTRACTOR, SELECT_DIALOG_TITLE, STRING_EXTRACTOR_NOT_SUPPORTED_MESSAGE, URL_EXTRACTOR

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Fields inherited from interface org.wandora.application.tools.browserextractors.BrowserPluginExtractor

RETURN_ERROR, RETURN_INFO

Constructor Summary

Constructors

Constructor and Description
AbstractWordExtractor()

Method Summary

Modifier and Type	Method and Description
boolean	_extractTopicsFrom(java.io.File f, TopicMap t)
boolean	_extractTopicsFrom(java.lang.String str, TopicMap t)
boolean	_extractTopicsFrom(java.net.URL u, TopicMap t)
private void	associateWord(Topic w, Topic t, Topic s, TopicMap tm) Associate the Topic word with a Topic t
private Topic	createScoreTopic(java.lang.Float get, TopicMap tm)
private Topic	createWordTopic(java.lang.String word, TopicMap tm) Create a Topic representing word
protected abstract java.lang.Object	formNeedle(java.lang.String s)
protected abstract java.lang.String	getBNSuffix()
(package private) abstract WordConfiguration	getConfig()
protected abstract java.lang.String	getSIBase()
protected boolean	handleWordList(java.util.List<java.lang.String> words, TopicMap tm) Associates each topic in current context with a word if the word is found in the topic instance data.
protected abstract float	isMatch(java.lang.Object needle, java.lang.String haystack)
private java.util.HashMap<Topic,java.lang.Float>	solveTopics(java.lang.String word, TopicMap tm) Find topics with content matching 'word' according to given configuration

Methods inherited from class org.wandora.application.tools.extractors.AbstractExtractor

acceptBrowserExtractRequest, addCrawlerUrl, browserExtractorConsumesPlainText, buildSI, buildSL, clearMasterSubject, createAssociation, createAssociation, createTopic, createTopic, createTopic, createTopic, createTopic, createTopic, createTopic, croppedFilename, croppedFilename, croppedUrlString, croppedUrlString, doBrowserExtract, dropExtract, dropExtract, dropExtract, execute, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFromText, getBrowserExtractorName, getContentTypes, getCrawlerMode, getDescription, getExtractorType, getForceContent, getForceFiles, getForceUrls, getGUIText, getGUIText, getIcon, getInterruptsHandled, getMasterSubject, getName, getType, getWandora, handle, handleContent, handleCustomType, handleFiles, handleForcedContent, handleInterrupt, handleStringContent, handleUrls, initializeCustomType, instantDropHandle, makeSubclassOfWandoraClass, runInOwnThread, setData, setDisplayName, setForceContent, setForceFiles, setForceUrls, setMasterSubject, setMasterSubject, setTopicMap, setupCrawler, setWandora, takeNap, urlEncode, useTempTopicMap, useURLCrawler

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

baseTopic

private Topic baseTopic

config

private WordConfiguration config

Constructor Detail

AbstractWordExtractor

AbstractWordExtractor()

Method Detail

_extractTopicsFrom

public boolean _extractTopicsFrom(java.io.File f,
                                  TopicMap t)
                           throws java.lang.Exception

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

_extractTopicsFrom

public boolean _extractTopicsFrom(java.net.URL u,
                                  TopicMap t)
                           throws java.lang.Exception

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

_extractTopicsFrom

public boolean _extractTopicsFrom(java.lang.String str,
                                  TopicMap t)
                           throws java.lang.Exception

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

getConfig

abstract WordConfiguration getConfig()

handleWordList

protected boolean handleWordList(java.util.List<java.lang.String> words,
                                 TopicMap tm)
                          throws TopicMapException

Associates each topic in current context with a word if the word is found in the topic instance data. First look up topics for each word, then create topics from words and associate words with corresponding existing topics.

Parameters:

words - a list of words to look for in instance data

tm -

Returns:

whether the process succeeded

Throws:

TopicMapException

solveTopics

private java.util.HashMap<Topic,java.lang.Float> solveTopics(java.lang.String word,
                                                             TopicMap tm)

Find topics with content matching 'word' according to given configuration

Parameters:

word -

tm -

Returns:

a set of topics matching word

createWordTopic

private Topic createWordTopic(java.lang.String word,
                              TopicMap tm)
                       throws TopicMapException

Create a Topic representing word

Parameters:

word -

tm -

Returns:

Throws:

TopicMapException - if topic creation fails

createScoreTopic

private Topic createScoreTopic(java.lang.Float get,
                               TopicMap tm)
                        throws TopicMapException

Throws:

TopicMapException

associateWord

private void associateWord(Topic w,
                           Topic t,
                           Topic s,
                           TopicMap tm)
                    throws TopicMapException

Associate the Topic word with a Topic t

Parameters:

w -

t -

tm -

Throws:

TopicMapException - if creating the association fails

formNeedle

protected abstract java.lang.Object formNeedle(java.lang.String s)

getBNSuffix

protected abstract java.lang.String getBNSuffix()

getSIBase

protected abstract java.lang.String getSIBase()

isMatch

protected abstract float isMatch(java.lang.Object needle,
                                 java.lang.String haystack)