Package io.goobi.viewer.model.archives

Class SolrEADParser

java.lang.Object

io.goobi.viewer.model.archives.ArchiveParser

io.goobi.viewer.model.archives.SolrEADParser

All Implemented Interfaces:

Serializable

public class SolrEADParser
extends ArchiveParser

Loads and parses EAD documents from the Solr index.

See Also:

• Serialized Form

Field Summary

Fields inherited from class io.goobi.viewer.model.archives.ArchiveParser

associatedRecordMap

Constructor Summary

Constructors

Constructor	Description
SolrEADParser()

Method Summary

Modifier and Type	Method	Description
static List<org.apache.solr.common.SolrDocument>	getChildDocsForIddoc(String iddoc)
List<ArchiveResource>	getPossibleDatabases()	Gets the database names.
String	getUrl()
void	loadChildren(ArchiveEntry entry, Set<String> loadPath, boolean loadChildrenRecursively)
ArchiveEntry	loadDatabase(ArchiveResource database, int lazyLoadingThreshold)	Loads the given database and parses the EAD document.
ArchiveEntry	loadNode(int order, int hierarchy, org.apache.solr.common.SolrDocument doc, Set<String> loadPath, boolean loadChildrenRecursively)
boolean	searchInUnparsedNodes(ArchiveEntry node, String searchValue)
String	toString()

Methods inherited from class io.goobi.viewer.model.archives.ArchiveParser

getAssociatedRecordPis, getIdForName, updateAssociatedRecordMap

Methods inherited from class java.lang.Object

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

Constructor Details

SolrEADParser

public SolrEADParser()

Method Details

getPossibleDatabases

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

Gets the database names.

Specified by:

getPossibleDatabases in class ArchiveParser

Returns:

List

Throws:

IndexUnreachableException

PresentationException

loadDatabase

public ArchiveEntry loadDatabase(ArchiveResource database,
 int lazyLoadingThreshold)
                          throws PresentationException,
IndexUnreachableException

Loads the given database and parses the EAD document.

Specified by:

loadDatabase in class ArchiveParser

Parameters:

database - the archive resource to load

lazyLoadingThreshold - minimum tree size to switch to lazy loading

Returns:

Root element of the loaded tree

Throws:

IndexUnreachableException

PresentationException

loadNode

public ArchiveEntry loadNode(int order,
 int hierarchy,
 org.apache.solr.common.SolrDocument doc,
 Set<String> loadPath,
 boolean loadChildrenRecursively)
                      throws PresentationException,
IndexUnreachableException

Parameters:

order - position of this node within its parent's children

hierarchy - depth level of this node in the tree

doc - Solr document representing this archive entry

loadPath - set of IDDOCs on the path to the search hit to load

loadChildrenRecursively - if true, child nodes are loaded recursively

Returns:

ArchiveEntry

Throws:

IndexUnreachableException

PresentationException

loadChildren

public void loadChildren(ArchiveEntry entry,
 Set<String> loadPath,
 boolean loadChildrenRecursively)
                  throws PresentationException,
IndexUnreachableException

Parameters:

entry - the parent entry whose children are to be loaded

loadPath - set of IDDOCs on the path to the search hit

loadChildrenRecursively - if true, child nodes are loaded recursively

Throws:

PresentationException

IndexUnreachableException

getChildDocsForIddoc

public static List<org.apache.solr.common.SolrDocument> getChildDocsForIddoc(String iddoc)
                                                                      throws PresentationException,
IndexUnreachableException

Parameters:

iddoc - Parent IDDOC

Returns:

Map<String, List<SolrDocument>>

Throws:

PresentationException

IndexUnreachableException

searchInUnparsedNodes

public boolean searchInUnparsedNodes(ArchiveEntry node,
 String searchValue)

Specified by:

searchInUnparsedNodes in class ArchiveParser

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

getUrl

public String getUrl()

Specified by:

getUrl in class ArchiveParser

toString

public String toString()

Overrides:

toString in class Object