org.wandora.application.tools.extractors.gedcom

Class GedcomExtractor

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.gedcom.GedcomExtractor

All Implemented Interfaces:

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

public class GedcomExtractor
extends AbstractExtractor
implements WandoraTool

Converts GEDCOM (GEnealogical Data COMmunication) formatted files to topic maps. Extractor is based on Mike Dean's work on GEDCOM to DAML converter. DAML converter is described at http://www.daml.org/2001/01/gedcom/

Author:

akivela

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	ADD_SPACE_BEFORE_CONCATENATION
static boolean	DEBUG
static java.lang.String	DEFAULT_LANG
java.lang.String	SCHEMA_PREFIX
java.lang.String	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
GedcomExtractor() Creates a new instance of GedcomExtractor

Method Summary

Modifier and Type	Method and Description
boolean	_extractTopicsFrom(java.io.BufferedReader breader, TopicMap topicMap)
boolean	_extractTopicsFrom(java.io.File GEDCOMFile, TopicMap topicMap)
boolean	_extractTopicsFrom(java.lang.String str, TopicMap topicMap)
boolean	_extractTopicsFrom(java.net.URL url, TopicMap topicMap)
Association	addAssociation(TopicMap tm, java.lang.String associationType, Topic player1Topic, Topic role1Topic)
Association	addAssociation(TopicMap tm, java.lang.String associationType, Topic player1Topic, Topic role1Topic, java.lang.String player2, java.lang.String role2)
Association	addAssociation(TopicMap tm, java.lang.String associationType, Topic player1Topic, Topic role1Topic, Topic player2Topic, java.lang.String role2)
void	addOccurrence(TopicMap tm, Topic carrier, java.lang.String occurrenceType, java.lang.String occurrenceText)
boolean	associationExists(Topic t1, Topic t2, Topic at)
Topic	createTopicForSchemaTerm(TopicMap tm, java.lang.String schemaTerm)
Association	fillAssociation(TopicMap tm, Association association, java.lang.String player, java.lang.String role)
Association	fillAssociation(TopicMap tm, Association association, Topic playerTopic, java.lang.String role)
private java.lang.String	fixNodeKey(java.lang.String key)
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)
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	getOrCreateFamilyType(TopicMap tm)
Topic	getOrCreateGedcomType(TopicMap tm)
Topic	getOrCreateIndividualType(TopicMap tm)
Topic	getOrCreateNameType(TopicMap tm)
Topic	getOrCreateSourceType(TopicMap tm)
Topic	getOrCreateTopic(TopicMap tm, Locator si, java.lang.String basename)
Topic	getOrCreateTopic(TopicMap topicmap, Locator si, java.lang.String baseName, java.lang.String displayName)
Topic	getOrCreateTopic(TopicMap topicmap, Locator si, java.lang.String baseName, java.lang.String displayName, Topic typeTopic)
Topic	getOrCreateTopic(TopicMap tm, java.lang.String base)
Topic	getOrCreateTopic(TopicMap tm, java.lang.String si, java.lang.String basename)
Topic	getOrCreateTopic(TopicMap topicmap, java.lang.String si, java.lang.String baseName, java.lang.String displayName)
private java.lang.String	getText(Gedcom.Node node)
Topic	getTopic(TopicMap tm, java.lang.String si)
Locator	makeSI(java.lang.String str)
void	makeSubclassOf(TopicMap tm, Topic t, Topic superclass)
private Association	processEvent(Gedcom.Node node, TopicMap tm, java.lang.String eventType, Topic baseTopic, Topic baseTypeTopic)
private void	processFamily(Gedcom.Node node, TopicMap tm)
private void	processIndividual(Gedcom.Node node, TopicMap tm)
private void	processName(Gedcom.Node node, TopicMap tm, Topic nameCarrier, Topic nameCarrierType)
private void	processSource(Gedcom.Node node, TopicMap tm)
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, 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, 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

DEBUG

public static final boolean DEBUG

See Also:

Constant Field Values

ADD_SPACE_BEFORE_CONCATENATION

public static boolean ADD_SPACE_BEFORE_CONCATENATION

DEFAULT_LANG

public static final java.lang.String DEFAULT_LANG

See Also:

Constant Field Values

SI_PREFIX

public java.lang.String SI_PREFIX

SCHEMA_PREFIX

public java.lang.String SCHEMA_PREFIX

Constructor Detail

GedcomExtractor

public GedcomExtractor()

Creates a new instance of GedcomExtractor

Method Detail

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.

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

processIndividual

private void processIndividual(Gedcom.Node node,
                               TopicMap tm)
                        throws TopicMapException

Throws:

TopicMapException

processFamily

private void processFamily(Gedcom.Node node,
                           TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

processEvent

private Association processEvent(Gedcom.Node node,
                                 TopicMap tm,
                                 java.lang.String eventType,
                                 Topic baseTopic,
                                 Topic baseTypeTopic)
                          throws TopicMapException

Throws:

TopicMapException

processSource

private void processSource(Gedcom.Node node,
                           TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

getText

private java.lang.String getText(Gedcom.Node node)

processName

private void processName(Gedcom.Node node,
                         TopicMap tm,
                         Topic nameCarrier,
                         Topic nameCarrierType)
                  throws TopicMapException

Throws:

TopicMapException

fixNodeKey

private java.lang.String fixNodeKey(java.lang.String key)

getOrCreateGedcomType

public Topic getOrCreateGedcomType(TopicMap tm)
                            throws TopicMapException

Throws:

TopicMapException

getOrCreateIndividualType

public Topic getOrCreateIndividualType(TopicMap tm)
                                throws TopicMapException

Throws:

TopicMapException

getOrCreateFamilyType

public Topic getOrCreateFamilyType(TopicMap tm)
                            throws TopicMapException

Throws:

TopicMapException

getOrCreateNameType

public Topic getOrCreateNameType(TopicMap tm)
                          throws TopicMapException

Throws:

TopicMapException

getOrCreateSourceType

public Topic getOrCreateSourceType(TopicMap tm)
                            throws TopicMapException

Throws:

TopicMapException

addOccurrence

public void addOccurrence(TopicMap tm,
                          Topic carrier,
                          java.lang.String occurrenceType,
                          java.lang.String occurrenceText)
                   throws TopicMapException

Throws:

TopicMapException

fillAssociation

public Association fillAssociation(TopicMap tm,
                                   Association association,
                                   Topic playerTopic,
                                   java.lang.String role)
                            throws TopicMapException

Throws:

TopicMapException

fillAssociation

public Association fillAssociation(TopicMap tm,
                                   Association association,
                                   java.lang.String player,
                                   java.lang.String role)
                            throws TopicMapException

Throws:

TopicMapException

addAssociation

public Association addAssociation(TopicMap tm,
                                  java.lang.String associationType,
                                  Topic player1Topic,
                                  Topic role1Topic)
                           throws TopicMapException

Throws:

TopicMapException

addAssociation

public Association addAssociation(TopicMap tm,
                                  java.lang.String associationType,
                                  Topic player1Topic,
                                  Topic role1Topic,
                                  java.lang.String player2,
                                  java.lang.String role2)
                           throws TopicMapException

Throws:

TopicMapException

addAssociation

public Association addAssociation(TopicMap tm,
                                  java.lang.String associationType,
                                  Topic player1Topic,
                                  Topic role1Topic,
                                  Topic player2Topic,
                                  java.lang.String role2)
                           throws TopicMapException

Throws:

TopicMapException

createTopicForSchemaTerm

public Topic createTopicForSchemaTerm(TopicMap tm,
                                      java.lang.String schemaTerm)
                               throws TopicMapException

Throws:

TopicMapException

makeSubclassOf

public void makeSubclassOf(TopicMap tm,
                           Topic t,
                           Topic superclass)
                    throws TopicMapException

Throws:

TopicMapException

associationExists

public boolean associationExists(Topic t1,
                                 Topic t2,
                                 Topic at)

getOrCreateTopic

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

Throws:

TopicMapException

getOrCreateTopic

public Topic getOrCreateTopic(TopicMap tm,
                              java.lang.String base)
                       throws TopicMapException

Throws:

TopicMapException

getOrCreateTopic

public Topic getOrCreateTopic(TopicMap tm,
                              Locator si,
                              java.lang.String basename)
                       throws TopicMapException

Throws:

TopicMapException

getTopic

public Topic getTopic(TopicMap tm,
                      java.lang.String si)
               throws TopicMapException

Throws:

TopicMapException

getOrCreateTopic

public Topic getOrCreateTopic(TopicMap topicmap,
                              java.lang.String si,
                              java.lang.String baseName,
                              java.lang.String displayName)

getOrCreateTopic

public Topic getOrCreateTopic(TopicMap topicmap,
                              Locator si,
                              java.lang.String baseName,
                              java.lang.String displayName)

getOrCreateTopic

public Topic getOrCreateTopic(TopicMap topicmap,
                              Locator si,
                              java.lang.String baseName,
                              java.lang.String displayName,
                              Topic typeTopic)

makeSI

public Locator makeSI(java.lang.String str)

useTempTopicMap

public boolean useTempTopicMap()

Overrides:

useTempTopicMap in class AbstractExtractor