org.wandora.application.tools.extractors.guardian

Class AbstractGuardianExtractor

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.guardian.AbstractGuardianExtractor

All Implemented Interfaces:

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

Direct Known Subclasses:

GuardianContentSearchExtractor, GuardianTagSearchExtractor

public abstract class AbstractGuardianExtractor
extends AbstractExtractor

Author:

Eero Lehtonen

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	API_URL_SI
static java.lang.String	CONTENT_SI
private java.lang.String[]	contentTypes
static java.lang.String	DATE_SI
static java.lang.String	FIELD_BASE_SI
private static java.util.HashMap<java.lang.String,java.lang.String>	fieldNames
static java.lang.String	GUARDIAN_BASE_SI
static java.lang.String	ID_SI
static java.lang.String	LANG_SI
static java.lang.String	PUBLICATION_TIME_SI
static java.lang.String	SECTION_ID_SI
static java.lang.String	SECTION_NAME_SI
static java.lang.String	TAG_BASE_SI
static java.lang.String	TITLE_SI
static java.lang.String	WEB_URL_SI

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
AbstractGuardianExtractor()

Method Summary

Modifier and Type	Method and Description
static Topic	getContentType(TopicMap tm)
java.lang.String[]	getContentTypes() Returns an array of String containing the content-types this ContentHandler can process.
static Topic	getDateTopic(TopicMap tm, java.lang.String date)
static Topic	getDateType(TopicMap tm)
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
static Topic	getFieldTopic(TopicMap tm, java.lang.String siExt, java.lang.String id)
static Topic	getFieldTopicType(TopicMap tm)
static Topic	getFieldType(TopicMap tm, java.lang.String siExt)
static Topic	getGuardianType(TopicMap tm)
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
static Topic	getIDType(TopicMap tm)
protected static Topic	getLangTopic(TopicMap tm)
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
protected static Topic	getOrCreateTopic(TopicMap tm, java.lang.String si)
protected static Topic	getOrCreateTopic(TopicMap tm, java.lang.String si, java.lang.String bn)
static Topic	getPubTimeType(TopicMap tm)
static Topic	getTagTopic(TopicMap tm, java.lang.String siExt, java.lang.String id)
static Topic	getTagTopicType(TopicMap tm)
static Topic	getTagType(TopicMap tm, java.lang.String siExt)
static Topic	getTitleType(TopicMap tm)
protected static Topic	getWandoraClassTopic(TopicMap tm)
protected static void	makeSubclassOf(TopicMap tm, Topic t, Topic superclass)
boolean	runInOwnThread() Whether or not this tool should fork own thread.
boolean	useURLCrawler()

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

_extractTopicsFrom, _extractTopicsFrom, _extractTopicsFrom, 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, getCrawlerMode, getExtractorType, getForceContent, getForceFiles, getForceUrls, getGUIText, getGUIText, getInterruptsHandled, getMasterSubject, getType, getWandora, handle, handleContent, handleCustomType, handleFiles, handleForcedContent, handleInterrupt, handleStringContent, handleUrls, initializeCustomType, instantDropHandle, makeSubclassOfWandoraClass, setData, setDisplayName, setForceContent, setForceFiles, setForceUrls, setMasterSubject, setMasterSubject, setTopicMap, setupCrawler, setWandora, takeNap, urlEncode, useTempTopicMap

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

contentTypes

private final java.lang.String[] contentTypes

GUARDIAN_BASE_SI

public static final java.lang.String GUARDIAN_BASE_SI

See Also:

Constant Field Values

FIELD_BASE_SI

public static final java.lang.String FIELD_BASE_SI

See Also:

Constant Field Values

TAG_BASE_SI

public static final java.lang.String TAG_BASE_SI

See Also:

Constant Field Values

CONTENT_SI

public static final java.lang.String CONTENT_SI

See Also:

Constant Field Values

DATE_SI

public static final java.lang.String DATE_SI

See Also:

Constant Field Values

ID_SI

public static final java.lang.String ID_SI

See Also:

Constant Field Values

TITLE_SI

public static final java.lang.String TITLE_SI

See Also:

Constant Field Values

PUBLICATION_TIME_SI

public static final java.lang.String PUBLICATION_TIME_SI

See Also:

Constant Field Values

SECTION_ID_SI

public static final java.lang.String SECTION_ID_SI

See Also:

Constant Field Values

SECTION_NAME_SI

public static final java.lang.String SECTION_NAME_SI

See Also:

Constant Field Values

WEB_URL_SI

public static final java.lang.String WEB_URL_SI

See Also:

Constant Field Values

API_URL_SI

public static final java.lang.String API_URL_SI

See Also:

Constant Field Values

LANG_SI

public static final java.lang.String LANG_SI

See Also:

Constant Field Values

fieldNames

private static java.util.HashMap<java.lang.String,java.lang.String> fieldNames

Constructor Detail

AbstractGuardianExtractor

public AbstractGuardianExtractor()

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 AbstractExtractor

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 AbstractExtractor

Returns:

String representing tool's description.

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 AbstractExtractor

Returns:

icon for the tool.

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

Overrides:

getContentTypes in class AbstractExtractor

Returns:

String array representing content types.

useURLCrawler

public boolean useURLCrawler()

Overrides:

useURLCrawler in class AbstractExtractor

runInOwnThread

public boolean runInOwnThread()

Description copied from class: AbstractWandoraTool

Whether or not this tool should fork own thread. If own thread is allowed, the execution of the tool return immediately. If own thread is not allowed the thread entering initial execute method is used. Extending classes should override this method.

Overrides:

runInOwnThread in class AbstractExtractor

Returns:

true if the tool should should be ran in separate thread.

getIDType

public static Topic getIDType(TopicMap tm)
                       throws TopicMapException

Throws:

TopicMapException

getTitleType

public static Topic getTitleType(TopicMap tm)
                          throws TopicMapException

Throws:

TopicMapException

getDateType

public static Topic getDateType(TopicMap tm)
                         throws TopicMapException

Throws:

TopicMapException

getDateTopic

public static Topic getDateTopic(TopicMap tm,
                                 java.lang.String date)
                          throws TopicMapException

Throws:

TopicMapException

getPubTimeType

public static Topic getPubTimeType(TopicMap tm)
                            throws TopicMapException

Throws:

TopicMapException

getContentType

public static Topic getContentType(TopicMap tm)
                            throws TopicMapException

Throws:

TopicMapException

getFieldType

public static Topic getFieldType(TopicMap tm,
                                 java.lang.String siExt)

getFieldTopic

public static Topic getFieldTopic(TopicMap tm,
                                  java.lang.String siExt,
                                  java.lang.String id)

getTagType

public static Topic getTagType(TopicMap tm,
                               java.lang.String siExt)

getTagTopic

public static Topic getTagTopic(TopicMap tm,
                                java.lang.String siExt,
                                java.lang.String id)

getGuardianType

public static Topic getGuardianType(TopicMap tm)
                             throws TopicMapException

Throws:

TopicMapException

getFieldTopicType

public static Topic getFieldTopicType(TopicMap tm)
                               throws TopicMapException

Throws:

TopicMapException

getTagTopicType

public static Topic getTagTopicType(TopicMap tm)
                             throws TopicMapException

Throws:

TopicMapException

getWandoraClassTopic

protected static Topic getWandoraClassTopic(TopicMap tm)
                                     throws TopicMapException

Throws:

TopicMapException

getLangTopic

protected static Topic getLangTopic(TopicMap tm)
                             throws TopicMapException

Throws:

TopicMapException

getOrCreateTopic

protected static Topic getOrCreateTopic(TopicMap tm,
                                        java.lang.String si)
                                 throws TopicMapException

Throws:

TopicMapException

getOrCreateTopic

protected static Topic getOrCreateTopic(TopicMap tm,
                                        java.lang.String si,
                                        java.lang.String bn)
                                 throws TopicMapException

Throws:

TopicMapException

makeSubclassOf

protected static void makeSubclassOf(TopicMap tm,
                                     Topic t,
                                     Topic superclass)
                              throws TopicMapException

Throws:

TopicMapException