org.wandora.application.tools.extractors.flickr

Class FlickrExtractor

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.flickr.FlickrExtractor

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, WandoraTool, WandoraToolLogger, TopicMapLogger

Direct Known Subclasses:

GroupInfoExtractor, PersonInfoExtractor, PhotoInfoExtractor

public abstract class FlickrExtractor
extends AbstractWandoraTool

Author:

anttirt

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	FlickrExtractor.ExtractionFailure
protected static class	FlickrExtractor.RequestFailure
static class	FlickrExtractor.UserCancellation

Field Summary

Fields

Modifier and Type	Field and Description
protected TopicMap	currentMap
private static FlickrState	staticState

Fields inherited from interface org.wandora.application.WandoraToolLogger

CLOSE, EXECUTE, INVISIBLE, VISIBLE, WAIT

Constructor Summary

Constructors

Constructor and Description
FlickrExtractor()

Method Summary

Modifier and Type	Method and Description
void	configure(Wandora admin, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
protected static java.lang.String	createSignature(java.util.SortedMap<java.lang.String,java.lang.String> arguments)
void	execute(Wandora admin, Context context) Runs the tool.
protected abstract boolean	extract(Wandora admin, Context context)
Topic	getAssociation(FlickrAssoc assocClass)
TopicMap	getCurrentMap()
Topic	getFlickrClass()
protected FlickrState	getFlickrState()
protected static java.lang.String	getFrob()
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
Topic	getLanguage(java.lang.String id)
Topic	getLicenseTopic(int licenseID)
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
Topic	getOccurrence(FlickrOccur occurrenceClass)
Topic	getTopic(FlickrTopic topicClass)
WandoraToolType	getType() Tool type is used to categorize tools.
Topic	getWandoraClass()
java.util.Collection<Topic>	getWithType(Context context, Topic type)
boolean	isConfigurable() Whether this tool is configurable.
static void	main(java.lang.String[] args)
protected static void	throwOnAPIError(org.json.JSONObject obj)
protected static java.lang.String	url(java.lang.String str)

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, getDescription, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isRunning, isRunning, lockLog, log, log, log, log, requiresRefresh, run, runInOwnThread, 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

Field Detail

currentMap

protected TopicMap currentMap

staticState

private static FlickrState staticState

Constructor Detail

FlickrExtractor

public FlickrExtractor()

Method Detail

getType

public WandoraToolType getType()

Description copied from class: AbstractWandoraTool

Tool type is used to categorize tools. Tool type has no real effect today, it is merely an informative property of a tool.

Specified by:

getType in interface WandoraTool

Overrides:

getType in class AbstractWandoraTool

Returns:

Tool's type object.

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 AbstractWandoraTool

Returns:

String representing tool's name.

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 AbstractWandoraTool

Returns:

icon for the tool.

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)

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

execute

public void execute(Wandora admin,
                    Context context)

Description copied from interface: WandoraTool

Runs the tool. This is the main entry to the tool. Here the context

main

public static void main(java.lang.String[] args)

url

protected static java.lang.String url(java.lang.String str)

getCurrentMap

public TopicMap getCurrentMap()

createSignature

protected static java.lang.String createSignature(java.util.SortedMap<java.lang.String,java.lang.String> arguments)
                                           throws FlickrExtractor.RequestFailure

Throws:

FlickrExtractor.RequestFailure

getFrob

protected static java.lang.String getFrob()
                                   throws FlickrExtractor.RequestFailure

Throws:

FlickrExtractor.RequestFailure

getLanguage

public Topic getLanguage(java.lang.String id)
                  throws TopicMapException

Throws:

TopicMapException

getFlickrClass

public Topic getFlickrClass()
                     throws TopicMapException

Throws:

TopicMapException

getWandoraClass

public Topic getWandoraClass()
                      throws TopicMapException

Throws:

TopicMapException

getLicenseTopic

public Topic getLicenseTopic(int licenseID)
                      throws TopicMapException

Throws:

TopicMapException

getTopic

public Topic getTopic(FlickrTopic topicClass)
               throws TopicMapException

Throws:

TopicMapException

getOccurrence

public Topic getOccurrence(FlickrOccur occurrenceClass)
                    throws TopicMapException

Throws:

TopicMapException

getAssociation

public Topic getAssociation(FlickrAssoc assocClass)
                     throws TopicMapException

Throws:

TopicMapException

throwOnAPIError

protected static void throwOnAPIError(org.json.JSONObject obj)
                               throws FlickrExtractor.RequestFailure

Throws:

FlickrExtractor.RequestFailure

getFlickrState

protected FlickrState getFlickrState()

extract

protected abstract boolean extract(Wandora admin,
                                   Context context)
                            throws FlickrExtractor.ExtractionFailure

Throws:

FlickrExtractor.ExtractionFailure

getWithType

public final java.util.Collection<Topic> getWithType(Context context,
                                                     Topic type)