org.wandora.application.tools.extractors.fng

Class ExtractIconclassKeywords

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.fng.ExtractIconclassKeywords

All Implemented Interfaces:

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

public class ExtractIconclassKeywords
extends AbstractExtractor
implements WandoraTool

Tool is used to convert Iconclass keyword files to topic maps. Iconclass is a subject-specific classification system used to annotate images such as artworks. Classification system contains 28 000 hierarchically ordered definitions divided into ten main divisions.

Iconclass keyword files are simple text files. Keyword file contains term specifications such as

 NOT[34 F 1]
 TXT[animals threatening man]
 FIT[ihminen eläinten uhkaamana]
  
 NOT[34 F 11]
 TXT[man struggling with animals]
 FIT[ihmisen ja eläinten välinen kamppailu]
 
 NOT[34 F 11 1]
 TXT[man struggling with animals as ornamental variant with antithetically placed animals (mostly lions)]
 FIT[]
 
 NOT[34 F 12]
 TXT[man killing animal]
 FIT[ihminen surmaa eläimen]
 

where NOT structure specifies the Iconclass notation (id) of the term. TXT specifies the English description of the term and FIT specifies Finnish description of the term.

Iconclass file extraction generates a topic map with a topic for each found Iconclass term. Topic's variant names are English and Finnish descriptions. Iconclass topics are arranged into a super-subclass tree using the Iconclass notation identifier.

Wandora doesn't include any Iconclass keyword files. This extractor was created for Finnish National Gallery's artwork site at http://kokoelmat.fng.fi

To read more about the Iconclass system see http://www.iconclass.nl.

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CREATE_ICONCLASS_TOPICS

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
ExtractIconclassKeywords() Creates a new instance of ExtractIconclassKeywords

Method Summary

Modifier and Type	Method and Description
boolean	_extractTopicsFrom(java.io.BufferedReader breader, TopicMap topicMap)
boolean	_extractTopicsFrom(java.io.File keywordFile, TopicMap topicMap)
boolean	_extractTopicsFrom(java.lang.String str, TopicMap topicMap)
boolean	_extractTopicsFrom(java.net.URL url, TopicMap topicMap)
void	createIconclassSubSuperRelation(java.lang.String sub, java.lang.String sup, TopicMap topicMap)
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	getGUIText(int textType)
Locator	getLocatorForIconclass(java.lang.String iconclassCode)
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
Topic	getOrCreateIconclassTopic(TopicMap topicmap, Locator si)
Topic	getOrCreateIconclassTopic(TopicMap topicmap, java.lang.String si)
Topic	getOrCreateTopic(TopicMap tm, Locator si)
Topic	getOrCreateTopic(TopicMap tm, java.lang.String si)
boolean	isValidIconclass(java.lang.String iconclass)
java.lang.String	removeBlocks(java.lang.String str)
java.lang.String	removeSpaces(java.lang.String str)
boolean	useTempTopicMap()

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, getContentTypes, getCrawlerMode, getExtractorType, getForceContent, getForceFiles, getForceUrls, getGUIText, getIcon, 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, useURLCrawler

Methods inherited from class org.wandora.application.tools.AbstractWandoraTool

addUndoMarker, addUndoMarker, allowMultipleInvocations, clearAllThreads, clearThreads, clearThreads, clearToolLock, clearToolLock, clearToolLocks, configure, execute, execute, forceStop, forceStop, getContext, getCurrentLogger, getDefaultLogger, getHistory, getLastLogger, getState, getThreads, getThreads, getToolMenuItem, getToolMenuItem, getTopicName, hlog, initialize, interruptAllThreads, interruptThreads, interruptThreads, isConfigurable, isRunning, isRunning, lockLog, log, log, log, log, requiresRefresh, run, 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

Methods inherited from interface org.wandora.application.WandoraTool

configure, execute, execute, execute, getContext, getIcon, getToolMenuItem, getType, hlog, initialize, isConfigurable, isRunning, log, log, log, log, requiresRefresh, setContext, setToolLogger, writeOptions

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

CREATE_ICONCLASS_TOPICS

public static boolean CREATE_ICONCLASS_TOPICS

Constructor Detail

ExtractIconclassKeywords

public ExtractIconclassKeywords()

Creates a new instance of ExtractIconclassKeywords

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.

getGUIText

public java.lang.String getGUIText(int textType)

Overrides:

getGUIText in class AbstractExtractor

_extractTopicsFrom

public boolean _extractTopicsFrom(java.lang.String str,
                                  TopicMap topicMap)
                           throws java.lang.Exception

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

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

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

_extractTopicsFrom

public boolean _extractTopicsFrom(java.io.BufferedReader breader,
                                  TopicMap topicMap)
                           throws java.lang.Exception

Throws:

java.lang.Exception

removeSpaces

public java.lang.String removeSpaces(java.lang.String str)

removeBlocks

public java.lang.String removeBlocks(java.lang.String str)

createIconclassSubSuperRelation

public void createIconclassSubSuperRelation(java.lang.String sub,
                                            java.lang.String sup,
                                            TopicMap topicMap)

getOrCreateIconclassTopic

public Topic getOrCreateIconclassTopic(TopicMap topicmap,
                                       java.lang.String si)

getOrCreateIconclassTopic

public Topic getOrCreateIconclassTopic(TopicMap topicmap,
                                       Locator si)

getOrCreateTopic

public Topic getOrCreateTopic(TopicMap tm,
                              java.lang.String si)

getOrCreateTopic

public Topic getOrCreateTopic(TopicMap tm,
                              Locator si)

getLocatorForIconclass

public Locator getLocatorForIconclass(java.lang.String iconclassCode)

isValidIconclass

public boolean isValidIconclass(java.lang.String iconclass)

useTempTopicMap

public boolean useTempTopicMap()

Overrides:

useTempTopicMap in class AbstractExtractor