eu.ehri.project.tools

Class Linker

java.lang.Object

eu.ehri.project.tools.Linker

public class Linker
extends Object

Utility class for performing operations on the database related to the creation and validation of links between items.

Constructor Summary

Constructors

Constructor and Description
Linker(com.tinkerpop.frames.FramedGraph<?> graph)

Method Summary

Modifier and Type	Method and Description
int	createAndLinkRepositoryVocabulary(Repository repository, Vocabulary vocabulary, Actioner user) Populate a pre-created vocabulary with concepts created based on access points for all collections within a repository, then link those concepts to the relevant documentary units.
Linker	withAccessPointTypes(Set<AccessPointType> accessPointTypes) Set the linker to include only the given access point types, discarding those already configured.
Linker	withDefaultLanguage(String defaultLanguageCode) Set the default language code to use for concept descriptions.
Linker	withExcludeSingles(boolean excludeSingles) Set the linker to ignore concepts which would only connect to a single item.
Linker	withLogMessage(Optional<String> logMessage) Set the log message for the created items.
Linker	withTolerant(boolean tolerant) Set the linker to proceed even if there are integrity errors caused by two distinct concept names slugifying to the same string.

Methods inherited from class java.lang.Object

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

Constructor Detail

Linker

public Linker(com.tinkerpop.frames.FramedGraph<?> graph)

Method Detail

createAndLinkRepositoryVocabulary

public int createAndLinkRepositoryVocabulary(Repository repository,
                                             Vocabulary vocabulary,
                                             Actioner user)
                                      throws ValidationError,
                                             PermissionDenied

Populate a pre-created vocabulary with concepts created based on access points for all collections within a repository, then link those concepts to the relevant documentary units.

One creation event will be generated for the newly-created concepts (with the vocabulary as the scope) and another for the newly-created links. Currently events will still be created if no concepts/links are made.

It should be advised that this function is not idempotent and running it twice will generate concepts/links twice.

NB. One could argue this function does too much...

Parameters:

repository - the repository

vocabulary - an existing (presumably empty) vocabulary

user - the user to whom to attribute the operation

Returns:

the number of new links created

Throws:

ValidationError

PermissionDenied

withExcludeSingles

public Linker withExcludeSingles(boolean excludeSingles)

Set the linker to ignore concepts which would only connect to a single item.

Parameters:

excludeSingles - a boolean value

Returns:

a new linker object

withTolerant

public Linker withTolerant(boolean tolerant)

Set the linker to proceed even if there are integrity errors caused by two distinct concept names slugifying to the same string.

Parameters:

tolerant - a boolean value

Returns:

a new linker object

withDefaultLanguage

public Linker withDefaultLanguage(String defaultLanguageCode)

Set the default language code to use for concept descriptions.

Parameters:

defaultLanguageCode - a three-letter ISO-639-2 code

Returns:

a new linker object

withLogMessage

public Linker withLogMessage(Optional<String> logMessage)

Set the log message for the created items.

Parameters:

logMessage - a descriptive string

Returns:

a new linker object

withAccessPointTypes

public Linker withAccessPointTypes(Set<AccessPointType> accessPointTypes)

Set the linker to include only the given access point types, discarding those already configured. If an empty list is given, all access point types will be included.

Parameters:

accessPointTypes - a list of access point types

Returns:

a new linker object