org.wandora.application.tools.extractors.gate

Class AnnieExtractor

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.gate.AbstractGate

org.wandora.application.tools.extractors.gate.AnnieExtractor

All Implemented Interfaces:

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

public class AnnieExtractor
extends AbstractGate

See: http://gate.ac.uk/wiki/code-repository/src/sheffield/examples/StandAloneAnnie.java

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static gate.CorpusController	annieController
private AnnieConfiguration	configuration
private static java.lang.String[]	contentTypes
static java.lang.String	DOCUMENT_SI
static java.lang.String	ENTITY_SI
static java.lang.String	ENTITY_TYPE_SI
static java.lang.String	GATE_ANNIE_SI
static java.lang.String	SOURCE_SI
static java.lang.String	TOPIC_SI

Fields inherited from class org.wandora.application.tools.extractors.gate.AbstractGate

CONFIG_FILE, GATE_HOME, GATE_PLUGIN_HOME

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

Method Summary

Modifier and Type	Method and Description
boolean	_extractTopicsFrom(java.io.File file, TopicMap topicMap)
boolean	_extractTopicsFrom(java.io.InputStream in, TopicMap topicMap)
boolean	_extractTopicsFrom(java.lang.String in, TopicMap tm)
boolean	_extractTopicsFrom(java.net.URL url, TopicMap topicMap)
boolean	acceptAnnotationType(java.lang.String annotationType)
void	configure(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
void	doAnnie(java.lang.String in, TopicMap topicMap)
void	doAnnieAnnotation(java.lang.String word, java.lang.String annotationType, Topic masterTopic, TopicMap tm)
void	execute(Wandora wandora, Context context) Runs the tool.
void	fillDocumentTopic(Topic textTopic, TopicMap topicMap, java.lang.String content)
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.
Topic	getDocumentType(TopicMap tm)
Topic	getEntityMetaType(TopicMap tm)
Topic	getEntityTopic(java.lang.String entity, java.lang.String type, TopicMap tm)
Topic	getEntityType(TopicMap tm)
Topic	getEntityTypeTopic(java.lang.String type, TopicMap tm)
Topic	getGATEAnnieClass(TopicMap tm)
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.
protected Topic	getOrCreateTopic(TopicMap tm, java.lang.String si)
protected Topic	getOrCreateTopic(TopicMap tm, java.lang.String si, java.lang.String bn)
Topic	getSourceType(TopicMap tm)
Topic	getTopicType(TopicMap tm)
Topic	getWandoraClass(TopicMap tm)
void	initializeAnnie()
boolean	isConfigurable() Whether this tool is configurable.
void	log(java.lang.String msg) Shortcut to access tool's logger.
protected void	makeSubclassOf(TopicMap tm, Topic t, Topic superclass)
java.lang.String	solveTitle(java.lang.String content)
boolean	useURLCrawler()
void	writeOptions(Wandora admin, Options options, java.lang.String prefix) If the tool is configurable, saves all current tool options.

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, 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, runInOwnThread, 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, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isRunning, isRunning, lockLog, log, log, log, requiresRefresh, run, setContext, setDefaultLogger, setLogTitle, setProgress, setProgressMax, setState, setToolLogger, singleLog, singleLog, singleLog, solveContextTopicMap, solveNameForTopicMap

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

execute, execute, getContext, getToolMenuItem, hlog, initialize, isRunning, log, log, log, requiresRefresh, setContext, setToolLogger

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

SOURCE_SI

public static final java.lang.String SOURCE_SI

See Also:

Constant Field Values

DOCUMENT_SI

public static final java.lang.String DOCUMENT_SI

See Also:

Constant Field Values

TOPIC_SI

public static final java.lang.String TOPIC_SI

See Also:

Constant Field Values

ENTITY_SI

public static final java.lang.String ENTITY_SI

See Also:

Constant Field Values

ENTITY_TYPE_SI

public static final java.lang.String ENTITY_TYPE_SI

See Also:

Constant Field Values

GATE_ANNIE_SI

public static final java.lang.String GATE_ANNIE_SI

See Also:

Constant Field Values

configuration

private AnnieConfiguration configuration

annieController

private static gate.CorpusController annieController

contentTypes

private static final java.lang.String[] contentTypes

Constructor Detail

AnnieExtractor

public AnnieExtractor()

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

isConfigurable

public boolean isConfigurable()

Description copied from class: AbstractWandoraTool

Whether this tool is configurable. Configurable tools will provide an interface to configure themselves. To make a configurable tool you will need to:

• Implement isConfigurable method and return true there.
• Implement initialize method to initialize the tool with saved options.
• Implement configure method to provide the user interface for configuration and then save the new options.
• Implement writeOptions method to save the current options.

Specified by:

isConfigurable in interface WandoraTool

Overrides:

isConfigurable in class AbstractWandoraTool

Returns:

true if the tool is configurable.

configure

public void configure(Wandora wandora,
                      Options options,
                      java.lang.String prefix)
               throws TopicMapException

Description copied from class: AbstractWandoraTool

If the tool is configurable, shows an user interface to configure the tool. The user may edit tool options which this method also need to save. Options specific to this tool should be saved with keys starting with the given prefix.

Specified by:

configure in interface WandoraTool

Overrides:

configure in class AbstractWandoraTool

Throws:

TopicMapException

writeOptions

public void writeOptions(Wandora admin,
                         Options options,
                         java.lang.String prefix)

Description copied from class: AbstractWandoraTool

If the tool is configurable, saves all current tool options. Options specific to this tool should be saved with keys starting with the given prefix.

Specified by:

writeOptions in interface WandoraTool

Overrides:

writeOptions in class AbstractWandoraTool

execute

public void execute(Wandora wandora,
                    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

Overrides:

execute in class AbstractExtractor

_extractTopicsFrom

public boolean _extractTopicsFrom(java.net.URL url,
                                  TopicMap topicMap)
                           throws java.lang.Exception

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

_extractTopicsFrom

public boolean _extractTopicsFrom(java.io.File file,
                                  TopicMap topicMap)
                           throws java.lang.Exception

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

_extractTopicsFrom

public boolean _extractTopicsFrom(java.io.InputStream in,
                                  TopicMap topicMap)
                           throws java.lang.Exception

Throws:

java.lang.Exception

_extractTopicsFrom

public boolean _extractTopicsFrom(java.lang.String in,
                                  TopicMap tm)
                           throws java.lang.Exception

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

initializeAnnie

public void initializeAnnie()
                     throws gate.util.GateException,
                            java.net.MalformedURLException,
                            java.io.IOException

Throws:

gate.util.GateException

java.net.MalformedURLException

java.io.IOException

doAnnie

public void doAnnie(java.lang.String in,
                    TopicMap topicMap)
             throws gate.util.GateException,
                    java.net.MalformedURLException,
                    java.io.IOException,
                    TopicMapException

Throws:

gate.util.GateException

java.net.MalformedURLException

java.io.IOException

TopicMapException

doAnnieAnnotation

public void doAnnieAnnotation(java.lang.String word,
                              java.lang.String annotationType,
                              Topic masterTopic,
                              TopicMap tm)
                       throws TopicMapException

Throws:

TopicMapException

acceptAnnotationType

public boolean acceptAnnotationType(java.lang.String annotationType)

getEntityMetaType

public Topic getEntityMetaType(TopicMap tm)
                        throws TopicMapException

Throws:

TopicMapException

getEntityTypeTopic

public Topic getEntityTypeTopic(java.lang.String type,
                                TopicMap tm)
                         throws TopicMapException

Throws:

TopicMapException

getEntityType

public Topic getEntityType(TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

getEntityTopic

public Topic getEntityTopic(java.lang.String entity,
                            java.lang.String type,
                            TopicMap tm)
                     throws TopicMapException

Throws:

TopicMapException

getGATEAnnieClass

public Topic getGATEAnnieClass(TopicMap tm)
                        throws TopicMapException

Throws:

TopicMapException

getWandoraClass

public Topic getWandoraClass(TopicMap tm)
                      throws TopicMapException

Throws:

TopicMapException

getTopicType

public Topic getTopicType(TopicMap tm)
                   throws TopicMapException

Throws:

TopicMapException

getSourceType

public Topic getSourceType(TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

getDocumentType

public Topic getDocumentType(TopicMap tm)
                      throws TopicMapException

Throws:

TopicMapException

getOrCreateTopic

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

Throws:

TopicMapException

getOrCreateTopic

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

Throws:

TopicMapException

makeSubclassOf

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

Throws:

TopicMapException

solveTitle

public java.lang.String solveTitle(java.lang.String content)

fillDocumentTopic

public void fillDocumentTopic(Topic textTopic,
                              TopicMap topicMap,
                              java.lang.String content)

log

public void log(java.lang.String msg)

Description copied from interface: WandoraTool

Shortcut to access tool's logger.

Specified by:

log in interface WandoraTool

Specified by:

log in interface WandoraToolLogger

Specified by:

log in interface TopicMapLogger

Overrides:

log in class AbstractWandoraTool

Parameters:

msg - to be logged.