Package io.goobi.viewer.model.archives

Class ArchiveManager

java.lang.Object

io.goobi.viewer.model.archives.ArchiveManager

All Implemented Interfaces:

Serializable

public class ArchiveManager
extends Object
implements Serializable

Loads and holds archive tree models. This class should have an application wide scope

Author:

florian

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ArchiveManager.DatabaseState

Constructor Summary

Constructors

Constructor	Description
ArchiveManager()

Method Summary

Modifier and Type	Method	Description
org.apache.commons.lang3.tuple.Pair<Optional<String>,Optional<String>>	findIndexedNeighbours(String entryId)	In the list of archive document search hits, find the id of the entry just before the given one
ArchiveResource	getArchive(String resourceId)
List<ArchiveEntry>	getArchiveHierarchyForIdentifier(ArchiveResource resource, String identifier)	Returns the entry hierarchy from the root down to the entry with the given identifier.
ArchiveResource	getArchiveResource(String archiveName)
ArchiveTree	getArchiveTree(String resourceId)
String	getArchiveUrl(ArchiveResource resource, String entryIdentifier)
List<ArchiveResource>	getDatabases()
ArchiveManager.DatabaseState	getDatabaseState()
ArchiveParser	getEadParser()
NodeType	getNodeType(String name)	Returns the node type configured for the given name.
Optional<ArchiveResource>	getOnlyDatabaseResource()	If only one archive database exists and database status is ArchiveManager.DatabaseState.ARCHIVES_LOADED, redirect to the matching url.
Map<String,NodeType>	getUpdatedNodeTypes()	Reloads nodeTyps from the config.
boolean	isInErrorState()
ArchiveResource	loadArchiveForEntry(String identifier)
void	updateArchiveList()	Checks the list of ead archives for updates.

Methods inherited from class java.lang.Object

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

Constructor Details

ArchiveManager

public ArchiveManager()

Method Details

getArchiveTree

public ArchiveTree getArchiveTree(String resourceId)
                           throws IllegalStateException,
PresentationException,
IndexUnreachableException

Parameters:

resourceId -

Returns:

ArchiveTree

Throws:

IllegalStateException

PresentationException

IndexUnreachableException

getArchiveResource

public ArchiveResource getArchiveResource(String archiveName)

Parameters:

archiveName -

Returns:

ArchiveResource

getNodeType

public NodeType getNodeType(String name)

Returns the node type configured for the given name. If no node type is configured for the name, then the default node type - indicated by the default="true" attribute - is used

Parameters:

name -

Returns:

NodeType

getOnlyDatabaseResource

public Optional<ArchiveResource> getOnlyDatabaseResource()

If only one archive database exists and database status is ArchiveManager.DatabaseState.ARCHIVES_LOADED, redirect to the matching url.

Returns:

Optional

loadArchiveForEntry

public ArchiveResource loadArchiveForEntry(String identifier)
                                    throws IllegalStateException,
PresentationException,
IndexUnreachableException

Parameters:

identifier -

Returns:

ArchiveResource

Throws:

IllegalStateException

PresentationException

IndexUnreachableException

getArchiveUrl

public String getArchiveUrl(ArchiveResource resource,
 String entryIdentifier)

Parameters:

resource -

entryIdentifier -

Returns:

Constructed URL

getDatabaseState

public ArchiveManager.DatabaseState getDatabaseState()

getDatabases

public List<ArchiveResource> getDatabases()

Returns:

List

findIndexedNeighbours

public org.apache.commons.lang3.tuple.Pair<Optional<String>,Optional<String>> findIndexedNeighbours(String entryId)
                                                                                             throws PresentationException,
IndexUnreachableException

In the list of archive document search hits, find the id of the entry just before the given one

Parameters:

entryId -

Returns:

the neighboring entry id if it exists

Throws:

PresentationException

IndexUnreachableException

getArchiveHierarchyForIdentifier

public List<ArchiveEntry> getArchiveHierarchyForIdentifier(ArchiveResource resource,
 String identifier)

Returns the entry hierarchy from the root down to the entry with the given identifier.

Parameters:

resource -

identifier - Entry identifier

Returns:

List of entries An empty list if the identified node has no ancestors or doesn't exist

getArchive

public ArchiveResource getArchive(String resourceId)

getUpdatedNodeTypes

public Map<String,NodeType> getUpdatedNodeTypes()

Reloads nodeTyps from the config.

Returns:

this.nodeTypes

updateArchiveList

public void updateArchiveList()

Checks the list of ead archives for updates. An update occurs if either the "lastModifiedDate" of an archive has changed since the last request, or if an archive was added or removed. In these cases, the list of records associated with an archive entry is updated as well

isInErrorState

public boolean isInErrorState()

getEadParser

public ArchiveParser getEadParser()

Returns:

the eadParser