org.wandora.application.tools.extractors.excel

Class ExcelTopicOccurrenceExtractor

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.excel.AbstractExcelExtractor

org.wandora.application.tools.extractors.excel.ExcelTopicOccurrenceExtractor

All Implemented Interfaces:

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

public class ExcelTopicOccurrenceExtractor
extends AbstractExcelExtractor

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	FIRST_ROW_CONTAINS_OCCURRENCE_TYPES
private java.util.HashMap<java.lang.String,java.lang.String>	occurrenceTypes

Fields inherited from class org.wandora.application.tools.extractors.excel.AbstractExcelExtractor

CELL_HASH, CELL_LOCATION, CELL_SHEET_AND_LOCATION, CELL_TOPIC_IS_BASED_ON, CELL_VALUE, DEFAULT_ASSOCIATION_TYPE_SI, DEFAULT_LANG, DEFAULT_LOWER_ROLE_SI, DEFAULT_OCCURRENCE_TYPE_SI, DEFAULT_ROLE_TYPE_SI, DEFAULT_UPPER_ROLE_SI, EXCEL_CELL_LOCATION_SI_PREFIX, EXCEL_CELL_SI_PREFIX, EXCEL_CELL_TYPE_SI_PREFIX, EXCEL_CELL_VALUE_SI, EXCEL_COLOR_SI_PREFIX, EXCEL_COLUMN_SI_PREFIX, EXCEL_COMMENT_SI_PREFIX, EXCEL_FORMULA_SI_PREFIX, EXCEL_ROW_SI_PREFIX, EXCEL_SHEET_SI_PREFIX, EXCEL_SI_PREFIX

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

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.
Topic	getDefaultOccurrenceTypeTopic(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
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.
void	processRow(org.apache.poi.ss.usermodel.Row row, TopicMap tm)
void	processRowAsOccurrenceTypes(org.apache.poi.ss.usermodel.Row row, TopicMap topicMap)
void	processSheet(org.apache.poi.hssf.usermodel.HSSFSheet sheet, TopicMap tm)
void	processSheet(org.apache.poi.xssf.usermodel.XSSFSheet sheet, TopicMap tm)
void	processWorkbook(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, TopicMap topicMap)
void	processWorkbook(org.apache.poi.xssf.usermodel.XSSFWorkbook workbook, TopicMap topicMap)

Methods inherited from class org.wandora.application.tools.extractors.excel.AbstractExcelExtractor

_extractTopicsFrom, _extractTopicsFrom, _extractTopicsFrom, associateToColors, associateToComment, associateToFormula, associateToLocation, associateToSheet, associateToType, getBackgroundColorTypeTopic, getCellLocationTypeTopic, getCellTopic, getCellTypeTopic, getCellTypeTopic, getCellTypeTypeTopic, getCellValueAsString, getCellValueAsString, getCellValueTypeTopic, getColorTopic, getColorTypeTopic, getColumnTopic, getColumnTypeTopic, getCommentTopic, getCommentTypeTopic, getDefaultAssociationTypeTopic, getDefaultLowerRoleTopic, getDefaultUpperRoleTopic, getExcelTypeTopic, getExtractorType, getForegroundColorTypeTopic, getFormulaTopic, getFormulaTypeTopic, getIcon, getOrCreateTopic, getRowTopic, getRowTypeTopic, getSheetTopic, getSheetTypeTopic, getType, runInOwnThread, useTempTopicMap, 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, doBrowserExtract, dropExtract, dropExtract, dropExtract, execute, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFrom, extractTopicsFromText, getBrowserExtractorName, getContentTypes, getCrawlerMode, getForceContent, getForceFiles, getForceUrls, getGUIText, getGUIText, getInterruptsHandled, getMasterSubject, getWandora, handle, handleContent, handleCustomType, handleFiles, handleForcedContent, handleInterrupt, handleStringContent, handleUrls, initializeCustomType, instantDropHandle, makeSubclassOfWandoraClass, setData, setDisplayName, setForceContent, setForceFiles, setForceUrls, setMasterSubject, setMasterSubject, setTopicMap, setupCrawler, setWandora, takeNap, urlEncode

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

execute, execute, execute, getContext, getToolMenuItem, hlog, initialize, 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

FIRST_ROW_CONTAINS_OCCURRENCE_TYPES

public static boolean FIRST_ROW_CONTAINS_OCCURRENCE_TYPES

occurrenceTypes

private java.util.HashMap<java.lang.String,java.lang.String> occurrenceTypes

Constructor Detail

ExcelTopicOccurrenceExtractor

public ExcelTopicOccurrenceExtractor()

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 AbstractExcelExtractor

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 AbstractExcelExtractor

Returns:

String representing tool's description.

processWorkbook

public void processWorkbook(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook,
                            TopicMap topicMap)

Specified by:

processWorkbook in class AbstractExcelExtractor

processWorkbook

public void processWorkbook(org.apache.poi.xssf.usermodel.XSSFWorkbook workbook,
                            TopicMap topicMap)

Specified by:

processWorkbook in class AbstractExcelExtractor

processSheet

public void processSheet(org.apache.poi.hssf.usermodel.HSSFSheet sheet,
                         TopicMap tm)

Specified by:

processSheet in class AbstractExcelExtractor

processSheet

public void processSheet(org.apache.poi.xssf.usermodel.XSSFSheet sheet,
                         TopicMap tm)

Specified by:

processSheet in class AbstractExcelExtractor

processRow

public void processRow(org.apache.poi.ss.usermodel.Row row,
                       TopicMap tm)

processRowAsOccurrenceTypes

public void processRowAsOccurrenceTypes(org.apache.poi.ss.usermodel.Row row,
                                        TopicMap topicMap)

getDefaultOccurrenceTypeTopic

public Topic getDefaultOccurrenceTypeTopic(org.apache.poi.ss.usermodel.Cell cell,
                                           TopicMap tm)

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