org.wandora.application.tools.extractors.marcxml

Class MarcXMLExtractor

java.lang.Object

org.wandora.application.tools.AbstractWandoraTool

org.wandora.application.tools.extractors.AbstractExtractor

org.wandora.application.tools.extractors.marcxml.MarcXMLExtractor

All Implemented Interfaces:

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

public class MarcXMLExtractor
extends AbstractExtractor

Author:

akivela

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	MarcXMLExtractor.MarcXMLParser

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String[]	authorCodes
static java.lang.String	BASENAME_PATTERN
private java.util.ArrayList<java.lang.String>	basenamePatterns
private java.lang.String[]	contentTypes
static boolean	CONVERT_LEADERS
protected static java.lang.String	DATA_SI
private static java.lang.String	defaultEncoding
private static java.lang.String	defaultLang
static java.lang.String	EXCLUDE_FIELDS
static java.lang.String	EXCLUDE_SUBFIELDS
private java.util.HashMap	excludeFields
private java.util.HashMap	excludeSubfields
protected static java.lang.String	FIELD_SI
protected static java.lang.String	FIELD_SI_TEMPLATE
static java.lang.String	INCLUDE_FIELDS
static boolean	INCLUDE_INDX_IN_ASSOCIATIONS
static java.lang.String	INCLUDE_SUBFIELDS
private java.util.HashMap	includeFields
private java.util.HashMap	includeSubfields
protected static java.lang.String	IND_SI
protected static java.lang.String	LEADER_SI
protected static java.lang.String	MARC_SI
protected static java.lang.String	RECORD_SI
static java.lang.String	RECORD_SI_PATTERN
private java.util.ArrayList<java.lang.String>	recordSIPatterns
static boolean	SOLVE_FIELD_NAMES
static boolean	SOLVE_SUBFIELD_NAMES
protected static java.lang.String	SUBFIELDCODE_SI
private java.lang.String[]	titleCodes
static boolean	TRIM_DATAS

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

Method Summary

Modifier and Type	Method and Description
boolean	_extractTopicsFrom(java.io.File file, TopicMap topicMap)
boolean	_extractTopicsFrom(org.xml.sax.InputSource in, TopicMap topicMap)
boolean	_extractTopicsFrom(java.io.InputStream in, TopicMap topicMap)
boolean	_extractTopicsFrom(java.lang.String str, TopicMap topicMap)
boolean	_extractTopicsFrom(java.net.URL url, TopicMap topicMap)
void	configure(Wandora admin, Options options, java.lang.String prefix) If the tool is configurable, shows an user interface to configure the tool.
java.lang.String[]	getContentTypes() Returns an array of String containing the content-types this ContentHandler can process.
Topic	getDataType(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	getFieldTopic(java.lang.String field, TopicMap tm)
Topic	getFieldType(TopicMap tm)
javax.swing.Icon	getIcon() All tools may have identifying graphic icon used within tool GUI elements.
Topic	getInd1Topic(java.lang.String ind1, java.lang.String tag, TopicMap tm)
Topic	getInd1Type(java.lang.String tag, TopicMap tm)
Topic	getInd2Topic(java.lang.String ind2, java.lang.String tag, TopicMap tm)
Topic	getInd2Type(java.lang.String tag, TopicMap tm)
java.lang.String	getIndicatorName(java.lang.String field, java.lang.String indicatorId, java.lang.String value)
java.lang.String	getIndicatorValueName(java.lang.String field, java.lang.String indicatorId, java.lang.String value)
Topic	getIndType(TopicMap tm)
Topic	getLeaderType(TopicMap tm)
Topic	getMARCClass(TopicMap tm)
java.lang.String	getName() Tools name represent the tool in UI unless the tool has been given explicitly another GUI name.
protected Topic	getOrCreateTopic(TopicMap tm, java.lang.String si)
protected Topic	getOrCreateTopic(TopicMap tm, java.lang.String si, java.lang.String bn)
protected Topic	getOrCreateTopic(TopicMap tm, java.lang.String si, java.lang.String bn, Topic type)
Topic	getRecordType(TopicMap tm)
Topic	getSubFieldCodeTopic(java.lang.String subfied, int counter, java.lang.String field, java.lang.String ind1Modifier, java.lang.String ind2Modifier, TopicMap tm)
Topic	getSubFieldCodeTopic(java.lang.String subfied, java.lang.String field, java.lang.String ind1Modifier, java.lang.String ind2Modifier, TopicMap tm)
Topic	getSubFieldCodeType(TopicMap tm)
Topic	getSubFieldDataTopic(java.lang.String data, java.lang.String tagModifier, java.lang.String ind1Modifier, java.lang.String ind2Modifier, TopicMap tm)
Topic	getTopic(TopicMap tm, java.lang.String str, java.lang.String SIBase, Topic type)
Topic	getWandoraClass(TopicMap tm)
boolean	isConfigurable() Whether this tool is configurable.
protected java.lang.String	makeFieldSI(java.lang.String field)
protected java.lang.String	makeSI(java.lang.String base, java.lang.String endPoint)
protected void	makeSubclassOf(TopicMap tm, Topic t, Topic superclass)
void	parseBasenamePatterns(java.lang.String patterns)
private java.util.HashMap	parseFieldCodes(java.lang.String str)
void	parseSIPatterns(java.lang.String patterns)
java.util.HashMap	parseSubfieldCodes(java.lang.String str)
void	processControlField(java.lang.String field, java.lang.String data, Topic record, Topic type, TopicMap tm)
protected void	topicalize(java.lang.String leader, java.util.ArrayList<MarcField> datafields, java.util.HashMap<java.lang.String,java.lang.String> controlfields, java.util.ArrayList<java.lang.String> subjectIdentifiers, java.util.ArrayList<java.lang.String> basenames, TopicMap tm)
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, getCrawlerMode, getExtractorType, getForceContent, getForceFiles, getForceUrls, getGUIText, 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, useTempTopicMap

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

TRIM_DATAS

public static boolean TRIM_DATAS

INCLUDE_INDX_IN_ASSOCIATIONS

public static boolean INCLUDE_INDX_IN_ASSOCIATIONS

SOLVE_FIELD_NAMES

public static boolean SOLVE_FIELD_NAMES

SOLVE_SUBFIELD_NAMES

public static boolean SOLVE_SUBFIELD_NAMES

CONVERT_LEADERS

public static boolean CONVERT_LEADERS

EXCLUDE_FIELDS

public static java.lang.String EXCLUDE_FIELDS

INCLUDE_FIELDS

public static java.lang.String INCLUDE_FIELDS

EXCLUDE_SUBFIELDS

public static java.lang.String EXCLUDE_SUBFIELDS

INCLUDE_SUBFIELDS

public static java.lang.String INCLUDE_SUBFIELDS

RECORD_SI_PATTERN

public static java.lang.String RECORD_SI_PATTERN

BASENAME_PATTERN

public static java.lang.String BASENAME_PATTERN

MARC_SI

protected static java.lang.String MARC_SI

IND_SI

protected static java.lang.String IND_SI

SUBFIELDCODE_SI

protected static java.lang.String SUBFIELDCODE_SI

LEADER_SI

protected static java.lang.String LEADER_SI

FIELD_SI

protected static java.lang.String FIELD_SI

FIELD_SI_TEMPLATE

protected static java.lang.String FIELD_SI_TEMPLATE

DATA_SI

protected static java.lang.String DATA_SI

RECORD_SI

protected static java.lang.String RECORD_SI

defaultEncoding

private static java.lang.String defaultEncoding

defaultLang

private static java.lang.String defaultLang

excludeFields

private java.util.HashMap excludeFields

includeFields

private java.util.HashMap includeFields

excludeSubfields

private java.util.HashMap excludeSubfields

includeSubfields

private java.util.HashMap includeSubfields

recordSIPatterns

private java.util.ArrayList<java.lang.String> recordSIPatterns

basenamePatterns

private java.util.ArrayList<java.lang.String> basenamePatterns

contentTypes

private final java.lang.String[] contentTypes

titleCodes

private java.lang.String[] titleCodes

authorCodes

private java.lang.String[] authorCodes

Constructor Detail

MarcXMLExtractor

public MarcXMLExtractor()

Creates a new instance of MarcXMLExtractor

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.

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.

getContentTypes

public java.lang.String[] getContentTypes()

Description copied from interface: Handler

Returns an array of String containing the content-types this ContentHandler can process.

Specified by:

getContentTypes in interface Handler

Overrides:

getContentTypes in class AbstractExtractor

Returns:

String array representing content types.

useURLCrawler

public boolean useURLCrawler()

Overrides:

useURLCrawler in class AbstractExtractor

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

parseFieldCodes

private java.util.HashMap parseFieldCodes(java.lang.String str)

parseSubfieldCodes

public java.util.HashMap parseSubfieldCodes(java.lang.String str)

parseSIPatterns

public void parseSIPatterns(java.lang.String patterns)

parseBasenamePatterns

public void parseBasenamePatterns(java.lang.String patterns)

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

Specified by:

_extractTopicsFrom in class AbstractExtractor

Throws:

java.lang.Exception

_extractTopicsFrom

public boolean _extractTopicsFrom(java.io.InputStream in,
                                  TopicMap topicMap)
                           throws java.lang.Exception

Throws:

java.lang.Exception

_extractTopicsFrom

public boolean _extractTopicsFrom(org.xml.sax.InputSource in,
                                  TopicMap topicMap)
                           throws java.lang.Exception

Throws:

java.lang.Exception

topicalize

protected void topicalize(java.lang.String leader,
                          java.util.ArrayList<MarcField> datafields,
                          java.util.HashMap<java.lang.String,java.lang.String> controlfields,
                          java.util.ArrayList<java.lang.String> subjectIdentifiers,
                          java.util.ArrayList<java.lang.String> basenames,
                          TopicMap tm)

processControlField

public void processControlField(java.lang.String field,
                                java.lang.String data,
                                Topic record,
                                Topic type,
                                TopicMap tm)
                         throws TopicMapException

Throws:

TopicMapException

getLeaderType

public Topic getLeaderType(TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

getFieldTopic

public Topic getFieldTopic(java.lang.String field,
                           TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

getFieldType

public Topic getFieldType(TopicMap tm)
                   throws TopicMapException

Throws:

TopicMapException

makeFieldSI

protected java.lang.String makeFieldSI(java.lang.String field)

getSubFieldCodeType

public Topic getSubFieldCodeType(TopicMap tm)
                          throws TopicMapException

Throws:

TopicMapException

getSubFieldCodeTopic

public Topic getSubFieldCodeTopic(java.lang.String subfied,
                                  int counter,
                                  java.lang.String field,
                                  java.lang.String ind1Modifier,
                                  java.lang.String ind2Modifier,
                                  TopicMap tm)
                           throws TopicMapException

Throws:

TopicMapException

getSubFieldCodeTopic

public Topic getSubFieldCodeTopic(java.lang.String subfied,
                                  java.lang.String field,
                                  java.lang.String ind1Modifier,
                                  java.lang.String ind2Modifier,
                                  TopicMap tm)
                           throws TopicMapException

Throws:

TopicMapException

getSubFieldDataTopic

public Topic getSubFieldDataTopic(java.lang.String data,
                                  java.lang.String tagModifier,
                                  java.lang.String ind1Modifier,
                                  java.lang.String ind2Modifier,
                                  TopicMap tm)
                           throws TopicMapException

Throws:

TopicMapException

getDataType

public Topic getDataType(TopicMap tm)
                  throws TopicMapException

Throws:

TopicMapException

getInd1Topic

public Topic getInd1Topic(java.lang.String ind1,
                          java.lang.String tag,
                          TopicMap tm)
                   throws TopicMapException

Throws:

TopicMapException

getInd1Type

public Topic getInd1Type(java.lang.String tag,
                         TopicMap tm)
                  throws TopicMapException

Throws:

TopicMapException

getIndType

public Topic getIndType(TopicMap tm)
                 throws TopicMapException

Throws:

TopicMapException

getInd2Topic

public Topic getInd2Topic(java.lang.String ind2,
                          java.lang.String tag,
                          TopicMap tm)
                   throws TopicMapException

Throws:

TopicMapException

getInd2Type

public Topic getInd2Type(java.lang.String tag,
                         TopicMap tm)
                  throws TopicMapException

Throws:

TopicMapException

getIndicatorName

public java.lang.String getIndicatorName(java.lang.String field,
                                         java.lang.String indicatorId,
                                         java.lang.String value)

getIndicatorValueName

public java.lang.String getIndicatorValueName(java.lang.String field,
                                              java.lang.String indicatorId,
                                              java.lang.String value)

getRecordType

public Topic getRecordType(TopicMap tm)
                    throws TopicMapException

Throws:

TopicMapException

getMARCClass

public Topic getMARCClass(TopicMap tm)
                   throws TopicMapException

Throws:

TopicMapException

getWandoraClass

public Topic getWandoraClass(TopicMap tm)
                      throws TopicMapException

Throws:

TopicMapException

getTopic

public Topic getTopic(TopicMap tm,
                      java.lang.String str,
                      java.lang.String SIBase,
                      Topic type)
               throws TopicMapException

Throws:

TopicMapException

getOrCreateTopic

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

Throws:

TopicMapException

getOrCreateTopic

protected Topic getOrCreateTopic(TopicMap tm,
                                 java.lang.String si,
                                 java.lang.String bn)
                          throws TopicMapException

Throws:

TopicMapException

getOrCreateTopic

protected Topic getOrCreateTopic(TopicMap tm,
                                 java.lang.String si,
                                 java.lang.String bn,
                                 Topic type)
                          throws TopicMapException

Throws:

TopicMapException

makeSubclassOf

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

Throws:

TopicMapException

makeSI

protected java.lang.String makeSI(java.lang.String base,
                                  java.lang.String endPoint)