Package io.goobi.viewer.model.archives

Class ArchiveParser

java.lang.Object

io.goobi.viewer.model.archives.ArchiveParser

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SolrEADParser

public abstract class ArchiveParser
extends Object
implements Serializable

Abstract base class for parsing EAD archive structures and resolving associated Goobi viewer record identifiers from the Solr index.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Map.Entry<String,Boolean>>	associatedRecordMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ArchiveParser()

Method Summary

Modifier and Type	Method	Description
protected static Map<String,Map.Entry<String,Boolean>>	getAssociatedRecordPis(SolrSearchIndex searchIndex)
static String	getIdForName(String name)
abstract List<ArchiveResource>	getPossibleDatabases()	Gets the database names and file names.
abstract String	getUrl()
abstract ArchiveEntry	loadDatabase(ArchiveResource database, int lazyLoadingThreshold)	Loads the given database and parses the EAD document.
abstract boolean	searchInUnparsedNodes(ArchiveEntry node, String searchValue)
void	updateAssociatedRecordMap()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

associatedRecordMap

protected transient Map<String,Map.Entry<String,Boolean>> associatedRecordMap

Constructor Details

ArchiveParser

protected ArchiveParser()

Method Details

updateAssociatedRecordMap

public void updateAssociatedRecordMap()
                               throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

getAssociatedRecordPis

protected static Map<String,Map.Entry<String,Boolean>> getAssociatedRecordPis(SolrSearchIndex searchIndex)
                                                                       throws PresentationException,
IndexUnreachableException

Parameters:

searchIndex - Solr search index to query

Returns:

Map<String, Entry<String, Boolean>>

Throws:

PresentationException

IndexUnreachableException

getPossibleDatabases

public abstract List<ArchiveResource> getPossibleDatabases()
                                                    throws PresentationException,
IndexUnreachableException,
IOException,
HTTPException

Gets the database names and file names.

Returns:

List

Throws:

HTTPException

IndexUnreachableException

IOException

PresentationException

loadDatabase

public abstract ArchiveEntry loadDatabase(ArchiveResource database,
 int lazyLoadingThreshold)
                                   throws PresentationException,
IndexUnreachableException,
IllegalStateException,
IOException,
HTTPException

Loads the given database and parses the EAD document.

Parameters:

database - archive resource to load

lazyLoadingThreshold - Number of total archive nodes from which to no longer eager load the entire tree

Returns:

Root element of the loaded tree

Throws:

HTTPException

IllegalStateException

IndexUnreachableException

IOException

PresentationException

getIdForName

public static String getIdForName(String name)

getUrl

public abstract String getUrl()

searchInUnparsedNodes

public abstract boolean searchInUnparsedNodes(ArchiveEntry node,
 String searchValue)

Parameters:

node - archive entry node to search within

searchValue - search term to match against unparsed nodes

Returns:

true if new nodes were loaded; false otherwise