org.wandora.application.tools.extractors.uclassify

Class UClassifier

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.uclassify.AbstractUClassifier

org.wandora.application.tools.extractors.uclassify.UClassifier

All Implemented Interfaces:

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

Direct Known Subclasses:

SentimentUClassifier, TextLanguageUClassifier, TopicsUClassifier

public class UClassifier
extends AbstractUClassifier

Author:

akivela

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.wandora.application.tools.extractors.uclassify.AbstractUClassifier

AbstractUClassifier.UClassifyParser

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	defaultClassifiers
private java.lang.String	forceClassifier
private java.lang.String	forceOwner
private double	forceProbability
protected static java.lang.String	OPTIONS_KEY
private UClassifierDialog	uClassifierDialog

Fields inherited from class org.wandora.application.tools.extractors.uclassify.AbstractUClassifier

API_URL, defaultEncoding, DOCUMENT_SI, SOURCE_SI, TOPIC_SI, UCLASSIFY_CLASS_SI, UCLASSIFY_CLASS_TYPE_SI, UCLASSIFY_CLASSIFIER_SI, UCLASSIFY_CLASSIFIER_TYPE_SI, UCLASSIFY_PROBABILITY_SI, UCLASSIFY_PROBABILITY_TYPE_SI, UCLASSIFY_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
UClassifier()
UClassifier(java.lang.String classifier, java.lang.String owner, double probability)

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 data, TopicMap tm)
boolean	_extractTopicsFrom(java.net.URL url, TopicMap topicMap)
void	configure(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
void	execute(Wandora wandora, Context context) Runs the tool.
java.lang.String	getDescription() AdminToolManager views tool descriptions while user browses available tools and build user customizable GUI elements such as Tools menu.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
boolean	isConfigurable() Whether this tool is configurable.
private void	readOptions(Options options)
void	writeOptions(Wandora wandora, 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.uclassify.AbstractUClassifier

doBrowserExtract, encode, fillDocumentTopic, forgetAuthorization, getContentTypes, getDocumentType, getFileContents, getIcon, getOrCreateTopic, getOrCreateTopic, getSourceType, getStringFromDocument, getTopicType, getType, getUClassifierTopic, getUClassifierType, getUClassifyClass, getUClassTopic, getUClassType, getUProbabilityTopic, getUProbabilityType, getWandoraClass, makeSubclassOf, sendRequest, solveAPIKey, solveAPIKey, solveTitle, uClassify, useURLCrawler

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, dropExtract, dropExtract, dropExtract, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFromText, getBrowserExtractorName, getCrawlerMode, getExtractorType, getForceContent, getForceFiles, getForceUrls, getGUIText, getGUIText, getInterruptsHandled, getMasterSubject, 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, 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

OPTIONS_KEY

protected static final java.lang.String OPTIONS_KEY

See Also:

Constant Field Values

defaultClassifiers

private static java.lang.String[] defaultClassifiers

uClassifierDialog

private UClassifierDialog uClassifierDialog

forceClassifier

private java.lang.String forceClassifier

forceOwner

private java.lang.String forceOwner

forceProbability

private double forceProbability

Constructor Detail

UClassifier

public UClassifier()

UClassifier

public UClassifier(java.lang.String classifier,
                   java.lang.String owner,
                   double probability)

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.

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 AbstractUClassifier

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

readOptions

private void readOptions(Options options)

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

Specified by:

_extractTopicsFrom in class AbstractUClassifier

Throws:

java.lang.Exception

_extractTopicsFrom

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

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception