org.wandora.application.tools.subjects

Class FindSubjectLocator

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.subjects.FindSubjectLocator

All Implemented Interfaces:

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

Direct Known Subclasses:

FindSubjectLocatorWithBasename

public class FindSubjectLocator
extends AbstractWandoraTool
implements WandoraTool, Handler, InterruptHandler

FindSubjectLocator crawls URL resources and tries to match each found URL to the search pattern. If URL matches the search pattern topic is given URL as the subject locator.

FindSubjectLocator is used to fix missing subject locators for example.

This tool has NOT been tested.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Wandora	admin
protected int	browseCounter
java.lang.String[]	contentTypes
private int	crawlCounter
private WebCrawler	crawler
protected int	extractionCounter
protected int	foundCounter
private java.lang.String	startUrl
private java.lang.String	subjectLocatorString
private java.util.HashMap<java.lang.String,java.lang.String>	topicPatterns
private java.lang.String	urlPattern

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
FindSubjectLocator() Creates a new instance of FindSubjectLocator
FindSubjectLocator(Context preferredContext)

Method Summary

Modifier and Type	Method and Description
void	execute(Wandora admin, Context context) Runs the tool.
java.lang.String[]	getContentTypes() Returns an array of String containing the content-types this ContentHandler can process.
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
int[]	getInterruptsHandled()
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
void	handle(CrawlerAccess crawler, java.io.InputStream in, int depth, java.net.URL url) Processes the given page.
void	handleInterrupt(CrawlerAccess crawler, int interrupt, java.net.URL url)
Topic	isMyURL(java.net.URL url)
void	setupCrawler(java.lang.String startUrl)
java.lang.String	solveStartURL() solveStartURL returns the URL where crawling is started.
java.lang.String	solveURLPattern(Topic topic) solveURLPattern returns pattern that is compared to each URL.

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

admin

private Wandora admin

crawler

private WebCrawler crawler

crawlCounter

private int crawlCounter

extractionCounter

protected int extractionCounter

foundCounter

protected int foundCounter

browseCounter

protected int browseCounter

urlPattern

private java.lang.String urlPattern

startUrl

private java.lang.String startUrl

subjectLocatorString

private java.lang.String subjectLocatorString

topicPatterns

private java.util.HashMap<java.lang.String,java.lang.String> topicPatterns

contentTypes

public final java.lang.String[] contentTypes

Constructor Detail

FindSubjectLocator

public FindSubjectLocator()

Creates a new instance of FindSubjectLocator

FindSubjectLocator

public FindSubjectLocator(Context preferredContext)

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.

solveStartURL

public java.lang.String solveStartURL()

solveStartURL returns the URL where crawling is started.

solveURLPattern

public java.lang.String solveURLPattern(Topic topic)

solveURLPattern returns pattern that is compared to each URL.

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

setupCrawler

public void setupCrawler(java.lang.String startUrl)

isMyURL

public Topic isMyURL(java.net.URL url)

handle

public void handle(CrawlerAccess crawler,
                   java.io.InputStream in,
                   int depth,
                   java.net.URL url)

Description copied from interface: Handler

Processes the given page. The given InputStream contains the data of an object that is of the content-type this content handler accepts. May use the given CrawlerAccess object to add further pages to the queue of the WebCrawler that asked to process the page.

Specified by:

handle in interface Handler

Parameters:

crawler - The call back object for the handler. Any objects built from the content of the page can be sent to this.

in - The InputStream of the page.

depth - The depth remaining depth. When reporting another page to the queue, the depth of that page should be set to this depth-1.

url - The URL of the page.

getContentTypes

public java.lang.String[] getContentTypes()

Description copied from interface: Handler

Returns an array of String containing the content-types this ContentHandler can process.

Specified by:

getContentTypes in interface Handler

Returns:

String array representing content types.

handleInterrupt

public void handleInterrupt(CrawlerAccess crawler,
                            int interrupt,
                            java.net.URL url)

Specified by:

handleInterrupt in interface InterruptHandler

getInterruptsHandled

public int[] getInterruptsHandled()

Specified by:

getInterruptsHandled in interface InterruptHandler