org.wandora.application.tools.extractors.opencalais

Class OpenCalaisClassifier

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.opencalais.OpenCalaisClassifier

All Implemented Interfaces:

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

public class OpenCalaisClassifier
extends AbstractExtractor

Author:

akivela

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OpenCalaisClassifier.OpenCalaisSimpleResultParser

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	apikey
protected static java.lang.String	CALAIS_SI
protected static java.lang.String	CALAIS_TOPIC_SI
private java.lang.String	contentType
private java.lang.String[]	contentTypes
private java.lang.String	defaultEncoding
protected static java.lang.String	DOCUMENT_SI
protected static boolean	EXTRACT_RELEVANCE
protected static boolean	EXTRACT_SCORE
protected static java.lang.String	OPENCALAIS_TAG_CLASSIFICATION_SI
protected static java.lang.String	OPENCALAIS_TOPIC_CLASSIFICATION_SI
private java.lang.String	params
protected static java.lang.String	RELEVANCE_SI
protected static java.lang.String	SCORE_SI
protected static java.lang.String	SOURCE_SI
protected static java.lang.String	TAG_SI
protected static java.lang.String	TOPIC_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
OpenCalaisClassifier() Creates a new instance of OpenCalaisClassifier

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 topicMap)
boolean	_extractTopicsFrom(java.net.URL url, TopicMap topicMap)
boolean	acceptBrowserExtractRequest(BrowserExtractRequest request, Wandora wandora)
void	configure(Wandora admin, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
java.lang.String	doBrowserExtract(BrowserExtractRequest request, Wandora wandora)
void	fillDocumentTopic(Topic textTopic, TopicMap topicMap, java.lang.String content)
void	forgetAuthorization()
java.lang.String	getBrowserExtractorName()
Topic	getCalaisClass(TopicMap tm)
Topic	getCalaisTagClassificationType(TopicMap tm)
Topic	getCalaisTopic(java.lang.String topic, java.lang.String taxonomy, TopicMap tm)
Topic	getCalaisTopicClassificationType(TopicMap tm)
Topic	getCalaisTopicType(TopicMap tm)
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)
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	getRelevanceTopic(java.lang.String relevance, TopicMap tm)
Topic	getRelevanceType(TopicMap tm)
Topic	getScoreTopic(java.lang.String score, TopicMap tm)
Topic	getScoreType(TopicMap tm)
Topic	getSourceType(TopicMap tm)
Topic	getTagTopic(java.lang.String tag, TopicMap tm)
Topic	getTagType(TopicMap tm)
Topic	getTagValue(java.lang.String val, java.lang.String tag, TopicMap tm)
Topic	getTopicType(TopicMap tm)
Topic	getWandoraClass(TopicMap tm)
boolean	isConfigurable() Whether this tool is configurable.
protected void	makeSubclassOf(TopicMap tm, Topic t, Topic superclass)
java.lang.String	solveAPIKey()
java.lang.String	solveAPIKey(Wandora wandora)
java.lang.String	solveTitle(java.lang.String content)
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

addCrawlerUrl, browserExtractorConsumesPlainText, buildSI, buildSL, clearMasterSubject, createAssociation, createAssociation, createTopic, createTopic, createTopic, createTopic, createTopic, createTopic, createTopic, croppedFilename, croppedFilename, croppedUrlString, croppedUrlString, dropExtract, dropExtract, dropExtract, execute, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFromText, 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, useURLCrawler

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

EXTRACT_RELEVANCE

protected static final boolean EXTRACT_RELEVANCE

See Also:

Constant Field Values

EXTRACT_SCORE

protected static final boolean EXTRACT_SCORE

See Also:

Constant Field Values

CALAIS_SI

protected static final java.lang.String CALAIS_SI

See Also:

Constant Field Values

CALAIS_TOPIC_SI

protected static final java.lang.String CALAIS_TOPIC_SI

See Also:

Constant Field Values

TAG_SI

protected static final java.lang.String TAG_SI

See Also:

Constant Field Values

OPENCALAIS_TAG_CLASSIFICATION_SI

protected static final java.lang.String OPENCALAIS_TAG_CLASSIFICATION_SI

See Also:

Constant Field Values

OPENCALAIS_TOPIC_CLASSIFICATION_SI

protected static final java.lang.String OPENCALAIS_TOPIC_CLASSIFICATION_SI

See Also:

Constant Field Values

TOPIC_SI

protected static final java.lang.String TOPIC_SI

See Also:

Constant Field Values

SOURCE_SI

protected static final java.lang.String SOURCE_SI

See Also:

Constant Field Values

DOCUMENT_SI

protected static final java.lang.String DOCUMENT_SI

See Also:

Constant Field Values

RELEVANCE_SI

protected static final java.lang.String RELEVANCE_SI

See Also:

Constant Field Values

SCORE_SI

protected static final java.lang.String SCORE_SI

See Also:

Constant Field Values

contentType

private java.lang.String contentType

defaultEncoding

private java.lang.String defaultEncoding

params

private java.lang.String params

contentTypes

private final java.lang.String[] contentTypes

apikey

private static java.lang.String apikey

Constructor Detail

OpenCalaisClassifier

public OpenCalaisClassifier()

Creates a new instance of OpenCalaisClassifier

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.

_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 topicMap)
                           throws java.lang.Exception

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

doBrowserExtract

public java.lang.String doBrowserExtract(BrowserExtractRequest request,
                                         Wandora wandora)
                                  throws TopicMapException

Specified by:

doBrowserExtract in interface BrowserPluginExtractor

Overrides:

doBrowserExtract in class AbstractExtractor

Throws:

TopicMapException

acceptBrowserExtractRequest

public boolean acceptBrowserExtractRequest(BrowserExtractRequest request,
                                           Wandora wandora)
                                    throws TopicMapException

Specified by:

acceptBrowserExtractRequest in interface BrowserPluginExtractor

Overrides:

acceptBrowserExtractRequest in class AbstractExtractor

Throws:

TopicMapException

getBrowserExtractorName

public java.lang.String getBrowserExtractorName()

Specified by:

getBrowserExtractorName in interface BrowserPluginExtractor

Overrides:

getBrowserExtractorName in class AbstractExtractor

solveTitle

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

fillDocumentTopic

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

getRelevanceTopic

public Topic getRelevanceTopic(java.lang.String relevance,
                               TopicMap tm)
                        throws TopicMapException

Throws:

TopicMapException

getScoreTopic

public Topic getScoreTopic(java.lang.String score,
                           TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

getCalaisTopic

public Topic getCalaisTopic(java.lang.String topic,
                            java.lang.String taxonomy,
                            TopicMap tm)
                     throws TopicMapException

Throws:

TopicMapException

getTagTopic

public Topic getTagTopic(java.lang.String tag,
                         TopicMap tm)
                  throws TopicMapException

Throws:

TopicMapException

getTagValue

public Topic getTagValue(java.lang.String val,
                         java.lang.String tag,
                         TopicMap tm)
                  throws TopicMapException

Throws:

TopicMapException

getCalaisTopicType

public Topic getCalaisTopicType(TopicMap tm)
                         throws TopicMapException

Throws:

TopicMapException

getTagType

public Topic getTagType(TopicMap tm)
                 throws TopicMapException

Throws:

TopicMapException

getRelevanceType

public Topic getRelevanceType(TopicMap tm)
                       throws TopicMapException

Throws:

TopicMapException

getScoreType

public Topic getScoreType(TopicMap tm)
                   throws TopicMapException

Throws:

TopicMapException

getCalaisClass

public Topic getCalaisClass(TopicMap tm)
                     throws TopicMapException

Throws:

TopicMapException

getWandoraClass

public Topic getWandoraClass(TopicMap tm)
                      throws TopicMapException

Throws:

TopicMapException

getCalaisTagClassificationType

public Topic getCalaisTagClassificationType(TopicMap tm)
                                     throws TopicMapException

Throws:

TopicMapException

getCalaisTopicClassificationType

public Topic getCalaisTopicClassificationType(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

solveAPIKey

public java.lang.String solveAPIKey(Wandora wandora)

solveAPIKey

public java.lang.String solveAPIKey()

forgetAuthorization

public void forgetAuthorization()

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