org.wandora.application.tools.extractors.excel

Class AbstractExcelExtractor

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ExcelAdjacencyListExtractor, ExcelAdjacencyMatrixExtractor, ExcelTopicExtractor, ExcelTopicNameExtractor, ExcelTopicOccurrenceExtractor, ExcelTopicTreeExtractor

public abstract class AbstractExcelExtractor
extends AbstractExtractor
implements WandoraTool

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CELL_HASH
static int	CELL_LOCATION
static int	CELL_SHEET_AND_LOCATION
static int	CELL_TOPIC_IS_BASED_ON
static int	CELL_VALUE
private java.text.DateFormat	dateFormat
static java.lang.String	DEFAULT_ASSOCIATION_TYPE_SI
static java.lang.String	DEFAULT_LANG
static java.lang.String	DEFAULT_LOWER_ROLE_SI
static java.lang.String	DEFAULT_OCCURRENCE_TYPE_SI
static java.lang.String	DEFAULT_ROLE_TYPE_SI
static java.lang.String	DEFAULT_UPPER_ROLE_SI
static java.lang.String	EXCEL_CELL_LOCATION_SI_PREFIX
static java.lang.String	EXCEL_CELL_SI_PREFIX
static java.lang.String	EXCEL_CELL_TYPE_SI_PREFIX
static java.lang.String	EXCEL_CELL_VALUE_SI
static java.lang.String	EXCEL_COLOR_SI_PREFIX
static java.lang.String	EXCEL_COLUMN_SI_PREFIX
static java.lang.String	EXCEL_COMMENT_SI_PREFIX
static java.lang.String	EXCEL_FORMULA_SI_PREFIX
static java.lang.String	EXCEL_ROW_SI_PREFIX
static java.lang.String	EXCEL_SHEET_SI_PREFIX
static java.lang.String	EXCEL_SI_PREFIX
private org.apache.poi.ss.usermodel.DataFormatter	formatter

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

Method Summary

Modifier and Type	Method and Description
boolean	_extractTopicsFrom(java.io.File f, TopicMap topicMap)
boolean	_extractTopicsFrom(java.lang.String str, TopicMap t)
boolean	_extractTopicsFrom(java.net.URL u, TopicMap topicMap)
void	associateToColors(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
void	associateToComment(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
void	associateToFormula(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
void	associateToLocation(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
void	associateToSheet(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
void	associateToType(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
Topic	getBackgroundColorTypeTopic(TopicMap tm)
Topic	getCellLocationTypeTopic(TopicMap tm)
Topic	getCellTopic(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
Topic	getCellTypeTopic(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
Topic	getCellTypeTopic(TopicMap tm)
Topic	getCellTypeTypeTopic(TopicMap tm)
protected java.lang.String	getCellValueAsString(org.apache.poi.ss.usermodel.Cell cell)
protected java.lang.String	getCellValueAsString(org.apache.poi.ss.usermodel.Cell cell, int type)
Topic	getCellValueTypeTopic(TopicMap tm)
Topic	getColorTopic(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
Topic	getColorTypeTopic(TopicMap tm)
Topic	getColumnTopic(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
Topic	getColumnTypeTopic(TopicMap tm)
Topic	getCommentTopic(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
Topic	getCommentTypeTopic(TopicMap tm)
Topic	getDefaultAssociationTypeTopic(TopicMap tm)
Topic	getDefaultLowerRoleTopic(TopicMap tm)
Topic	getDefaultUpperRoleTopic(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.
Topic	getExcelTypeTopic(TopicMap tm)
int	getExtractorType()
Topic	getForegroundColorTypeTopic(TopicMap tm)
Topic	getFormulaTopic(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
Topic	getFormulaTypeTopic(TopicMap tm)
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
Topic	getOrCreateTopic(TopicMap map, java.lang.String si, java.lang.String basename)
Topic	getRowTopic(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
Topic	getRowTypeTopic(TopicMap tm)
Topic	getSheetTopic(org.apache.poi.ss.usermodel.Cell cell, TopicMap tm)
Topic	getSheetTypeTopic(TopicMap tm)
WandoraToolType	getType() Tool type is used to categorize tools.
abstract void	processSheet(org.apache.poi.hssf.usermodel.HSSFSheet sheet, TopicMap topicMap)
abstract void	processSheet(org.apache.poi.xssf.usermodel.XSSFSheet sheet, TopicMap topicMap)
abstract void	processWorkbook(org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, TopicMap topicMap)
abstract void	processWorkbook(org.apache.poi.xssf.usermodel.XSSFWorkbook workbook, TopicMap topicMap)
boolean	runInOwnThread() Whether or not this tool should fork own thread.
boolean	useTempTopicMap()
boolean	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, 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, getToolMenuItem, 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

DEFAULT_LANG

public static java.lang.String DEFAULT_LANG

formatter

private org.apache.poi.ss.usermodel.DataFormatter formatter

dateFormat

private java.text.DateFormat dateFormat

CELL_VALUE

public static final int CELL_VALUE

See Also:

Constant Field Values

CELL_LOCATION

public static final int CELL_LOCATION

See Also:

Constant Field Values

CELL_SHEET_AND_LOCATION

public static final int CELL_SHEET_AND_LOCATION

See Also:

Constant Field Values

CELL_HASH

public static final int CELL_HASH

See Also:

Constant Field Values

CELL_TOPIC_IS_BASED_ON

public static int CELL_TOPIC_IS_BASED_ON

EXCEL_SI_PREFIX

public static java.lang.String EXCEL_SI_PREFIX

EXCEL_COLUMN_SI_PREFIX

public static java.lang.String EXCEL_COLUMN_SI_PREFIX

EXCEL_ROW_SI_PREFIX

public static java.lang.String EXCEL_ROW_SI_PREFIX

EXCEL_SHEET_SI_PREFIX

public static java.lang.String EXCEL_SHEET_SI_PREFIX

EXCEL_CELL_SI_PREFIX

public static java.lang.String EXCEL_CELL_SI_PREFIX

EXCEL_COLOR_SI_PREFIX

public static java.lang.String EXCEL_COLOR_SI_PREFIX

EXCEL_FORMULA_SI_PREFIX

public static java.lang.String EXCEL_FORMULA_SI_PREFIX

EXCEL_COMMENT_SI_PREFIX

public static java.lang.String EXCEL_COMMENT_SI_PREFIX

EXCEL_CELL_TYPE_SI_PREFIX

public static java.lang.String EXCEL_CELL_TYPE_SI_PREFIX

EXCEL_CELL_LOCATION_SI_PREFIX

public static java.lang.String EXCEL_CELL_LOCATION_SI_PREFIX

DEFAULT_ASSOCIATION_TYPE_SI

public static java.lang.String DEFAULT_ASSOCIATION_TYPE_SI

DEFAULT_ROLE_TYPE_SI

public static java.lang.String DEFAULT_ROLE_TYPE_SI

DEFAULT_UPPER_ROLE_SI

public static java.lang.String DEFAULT_UPPER_ROLE_SI

DEFAULT_LOWER_ROLE_SI

public static java.lang.String DEFAULT_LOWER_ROLE_SI

DEFAULT_OCCURRENCE_TYPE_SI

public static java.lang.String DEFAULT_OCCURRENCE_TYPE_SI

EXCEL_CELL_VALUE_SI

public static java.lang.String EXCEL_CELL_VALUE_SI

Constructor Detail

AbstractExcelExtractor

public AbstractExcelExtractor()

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.

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 AbstractExtractor

Returns:

Tool's type object.

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.

runInOwnThread

public boolean runInOwnThread()

Description copied from class: AbstractWandoraTool

Whether or not this tool should fork own thread. If own thread is allowed, the execution of the tool return immediately. If own thread is not allowed the thread entering initial execute method is used. Extending classes should override this method.

Overrides:

runInOwnThread in class AbstractExtractor

Returns:

true if the tool should should be ran in separate thread.

useTempTopicMap

public boolean useTempTopicMap()

Overrides:

useTempTopicMap in class AbstractExtractor

useURLCrawler

public boolean useURLCrawler()

Overrides:

useURLCrawler in class AbstractExtractor

getExtractorType

public int getExtractorType()

Overrides:

getExtractorType in class AbstractExtractor

_extractTopicsFrom

public boolean _extractTopicsFrom(java.io.File f,
                                  TopicMap topicMap)
                           throws java.lang.Exception

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

_extractTopicsFrom

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

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

_extractTopicsFrom

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

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

processWorkbook

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

processWorkbook

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

processSheet

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

processSheet

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

getCellValueAsString

protected java.lang.String getCellValueAsString(org.apache.poi.ss.usermodel.Cell cell)

getCellValueAsString

protected java.lang.String getCellValueAsString(org.apache.poi.ss.usermodel.Cell cell,
                                                int type)

associateToSheet

public void associateToSheet(org.apache.poi.ss.usermodel.Cell cell,
                             TopicMap tm)
                      throws TopicMapException

Throws:

TopicMapException

associateToLocation

public void associateToLocation(org.apache.poi.ss.usermodel.Cell cell,
                                TopicMap tm)
                         throws TopicMapException

Throws:

TopicMapException

associateToColors

public void associateToColors(org.apache.poi.ss.usermodel.Cell cell,
                              TopicMap tm)
                       throws TopicMapException

Throws:

TopicMapException

associateToType

public void associateToType(org.apache.poi.ss.usermodel.Cell cell,
                            TopicMap tm)
                     throws TopicMapException

Throws:

TopicMapException

associateToComment

public void associateToComment(org.apache.poi.ss.usermodel.Cell cell,
                               TopicMap tm)
                        throws TopicMapException

Throws:

TopicMapException

associateToFormula

public void associateToFormula(org.apache.poi.ss.usermodel.Cell cell,
                               TopicMap tm)
                        throws TopicMapException

Throws:

TopicMapException

getExcelTypeTopic

public Topic getExcelTypeTopic(TopicMap tm)

getCellTopic

public Topic getCellTopic(org.apache.poi.ss.usermodel.Cell cell,
                          TopicMap tm)
                   throws TopicMapException

Throws:

TopicMapException

getCellTypeTopic

public Topic getCellTypeTopic(TopicMap tm)
                       throws TopicMapException

Throws:

TopicMapException

getCellValueTypeTopic

public Topic getCellValueTypeTopic(TopicMap tm)
                            throws TopicMapException

Throws:

TopicMapException

getCellTypeTopic

public Topic getCellTypeTopic(org.apache.poi.ss.usermodel.Cell cell,
                              TopicMap tm)
                       throws TopicMapException

Throws:

TopicMapException

getCellTypeTypeTopic

public Topic getCellTypeTypeTopic(TopicMap tm)
                           throws TopicMapException

Throws:

TopicMapException

getColorTopic

public Topic getColorTopic(org.apache.poi.ss.usermodel.Cell cell,
                           TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

getColorTypeTopic

public Topic getColorTypeTopic(TopicMap tm)
                        throws TopicMapException

Throws:

TopicMapException

getBackgroundColorTypeTopic

public Topic getBackgroundColorTypeTopic(TopicMap tm)
                                  throws TopicMapException

Throws:

TopicMapException

getForegroundColorTypeTopic

public Topic getForegroundColorTypeTopic(TopicMap tm)
                                  throws TopicMapException

Throws:

TopicMapException

getDefaultAssociationTypeTopic

public Topic getDefaultAssociationTypeTopic(TopicMap tm)
                                     throws TopicMapException

Throws:

TopicMapException

getDefaultUpperRoleTopic

public Topic getDefaultUpperRoleTopic(TopicMap tm)
                               throws TopicMapException

Throws:

TopicMapException

getDefaultLowerRoleTopic

public Topic getDefaultLowerRoleTopic(TopicMap tm)
                               throws TopicMapException

Throws:

TopicMapException

getRowTopic

public Topic getRowTopic(org.apache.poi.ss.usermodel.Cell cell,
                         TopicMap tm)
                  throws TopicMapException

Throws:

TopicMapException

getRowTypeTopic

public Topic getRowTypeTopic(TopicMap tm)
                      throws TopicMapException

Throws:

TopicMapException

getColumnTopic

public Topic getColumnTopic(org.apache.poi.ss.usermodel.Cell cell,
                            TopicMap tm)
                     throws TopicMapException

Throws:

TopicMapException

getColumnTypeTopic

public Topic getColumnTypeTopic(TopicMap tm)
                         throws TopicMapException

Throws:

TopicMapException

getCommentTopic

public Topic getCommentTopic(org.apache.poi.ss.usermodel.Cell cell,
                             TopicMap tm)
                      throws TopicMapException

Throws:

TopicMapException

getCommentTypeTopic

public Topic getCommentTypeTopic(TopicMap tm)
                          throws TopicMapException

Throws:

TopicMapException

getFormulaTopic

public Topic getFormulaTopic(org.apache.poi.ss.usermodel.Cell cell,
                             TopicMap tm)
                      throws TopicMapException

Throws:

TopicMapException

getFormulaTypeTopic

public Topic getFormulaTypeTopic(TopicMap tm)
                          throws TopicMapException

Throws:

TopicMapException

getCellLocationTypeTopic

public Topic getCellLocationTypeTopic(TopicMap tm)
                               throws TopicMapException

Throws:

TopicMapException

getSheetTopic

public Topic getSheetTopic(org.apache.poi.ss.usermodel.Cell cell,
                           TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

getSheetTypeTopic

public Topic getSheetTypeTopic(TopicMap tm)
                        throws TopicMapException

Throws:

TopicMapException

getOrCreateTopic

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