org.wandora.application.tools.extractors.rekognition

Class RekognitionFaceDetector

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.rekognition.AbstractRekognitionExtractor

org.wandora.application.tools.extractors.rekognition.RekognitionFaceDetector

All Implemented Interfaces:

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

public class RekognitionFaceDetector
extends AbstractRekognitionExtractor

Author:

Eero Lehtonen

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.wandora.application.tools.extractors.rekognition.AbstractRekognitionExtractor

AbstractRekognitionExtractor.AbstractValueHandler, AbstractRekognitionExtractor.BoundingBoxHandler, AbstractRekognitionExtractor.CoordinateHandler, AbstractRekognitionExtractor.JSON, AbstractRekognitionExtractor.MatchHandler, AbstractRekognitionExtractor.NumericValueHandler, AbstractRekognitionExtractor.NumericValuesHandler, AbstractRekognitionExtractor.PoseHandler, AbstractRekognitionExtractor.ValueHandler

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String[]	contentTypes

Fields inherited from class org.wandora.application.tools.extractors.rekognition.AbstractRekognitionExtractor

API_ROOT, conf, DETECTION_SI, FACE_SI_ROOT, FEATURE_SI_ROOT, FLATTENING_DELIMETER, IMAGE_SI, SCENE_SI_ROOT, SI_ROOT

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

Method Summary

Modifier and Type	Method and Description
boolean	_extractTopicsFrom(java.lang.String imageUrl, TopicMap tm) The method used for actual extraction.
boolean	_extractTopicsFrom(java.net.URL u, TopicMap tm) Parse the URL as a string and pass it to _extractTopicsFrom(String ...)
void	configure(Wandora wandora, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
protected java.util.HashMap<java.lang.String,AbstractRekognitionExtractor.ValueHandler>	createHandlerMap()
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	getExtractorType()
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
private java.lang.String	getJobsString(java.util.ArrayList<java.lang.String> jobs)
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	logUsage(org.wandora.dep.json.JSONObject respNode)
boolean	useURLCrawler()
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.rekognition.AbstractRekognitionExtractor

_extractTopicsFrom, addFeatureToDetection, associateImageWithDetection, getBestMatch, getConfiguration, getDetectionClass, getDetectionTopic, getFeatureClass, getFeatureTypeTopic, getImageClass, getImageTopic, getLangTopic, getOrCreateTopic, getOrCreateTopic, getRekognitionClass, getWandoraClassTopic, makeSubclassOf, setConfiguration

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, execute, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFromText, getBrowserExtractorName, getCrawlerMode, 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, 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

contentTypes

private static final java.lang.String[] contentTypes

Constructor Detail

RekognitionFaceDetector

public RekognitionFaceDetector()

Method Detail

getExtractorType

public int getExtractorType()

Overrides:

getExtractorType in class AbstractExtractor

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

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.

createHandlerMap

protected java.util.HashMap<java.lang.String,AbstractRekognitionExtractor.ValueHandler> createHandlerMap()

Specified by:

createHandlerMap in class AbstractRekognitionExtractor

_extractTopicsFrom

public boolean _extractTopicsFrom(java.net.URL u,
                                  TopicMap tm)
                           throws java.lang.Exception

Parse the URL as a string and pass it to _extractTopicsFrom(String ...)

Overrides:

_extractTopicsFrom in class AbstractRekognitionExtractor

Parameters:

u - the image URL to extract

tm - the current TopicMap

Returns:

whether the extraction was a success.

Throws:

java.lang.Exception - propagated from _extracTopicsFrom(String ...)

_extractTopicsFrom

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

The method used for actual extraction.

Overrides:

_extractTopicsFrom in class AbstractRekognitionExtractor

Parameters:

imageUrl - the image URL for extraction

tm - the current TopicMap

Returns:

true if the extraction was successful, false otherwise

Throws:

java.lang.Exception - if the supplied URL is invalid or Topic Map manipulation fails

getJobsString

private java.lang.String getJobsString(java.util.ArrayList<java.lang.String> jobs)

logUsage

private void logUsage(org.wandora.dep.json.JSONObject respNode)
               throws org.wandora.dep.json.JSONException

Throws:

org.wandora.dep.json.JSONException

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