eu.ehri.project.tools

Class IdRegenerator

java.lang.Object

eu.ehri.project.tools.IdRegenerator

public class IdRegenerator
extends Object

Util class for re-generating the IDs for a given set of items. Hierarchical IDs are used to enforce uniqueness of identifiers within a particular parent-child scope. In theory, since identifiers are generally very stable this works fine, but occasionally they change, invalidating the identifiers of their child items.

We also sometimes tweak the ID generation algorithm itself, which necessitates bulk ID re-generation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdRegenerator.IdCollisionError

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IdRegenerator	collisionMode(boolean collisionMode) Obtain a re-generator that only outputs items with IDs that if renamed would collide with another item's ID.
Optional<List<String>>	reGenerateId(Accessible item)
List<List<String>>	reGenerateIds(Iterable<? extends Accessible> items)
List<List<String>>	reGenerateIds(PermissionScope scope, Iterable<? extends Entity> items)
IdRegenerator	skippingCollisions(boolean skipCollisions) Obtain a re-generator that will skip items that would collide with existing items.
IdRegenerator	withActualRename(boolean doIt) Obtain a re-generator that will actually perform the rename step.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdRegenerator

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

Method Detail

reGenerateIds

public List<List<String>> reGenerateIds(PermissionScope scope,
                                        Iterable<? extends Entity> items)
                                 throws IdRegenerator.IdCollisionError

Throws:

IdRegenerator.IdCollisionError

reGenerateIds

public List<List<String>> reGenerateIds(Iterable<? extends Accessible> items)
                                 throws IdRegenerator.IdCollisionError

Throws:

IdRegenerator.IdCollisionError

reGenerateId

public Optional<List<String>> reGenerateId(Accessible item)
                                    throws IdRegenerator.IdCollisionError

Throws:

IdRegenerator.IdCollisionError

withActualRename

public IdRegenerator withActualRename(boolean doIt)

Obtain a re-generator that will actually perform the rename step.

Parameters:

doIt - whether to actually commit changes

Returns:

a new, more dangerous, re-generator

skippingCollisions

public IdRegenerator skippingCollisions(boolean skipCollisions)

Obtain a re-generator that will skip items that would collide with existing items.

Parameters:

skipCollisions - whether or not to error on an ID collision

Returns:

a new, more tolerant, re-generator

collisionMode

public IdRegenerator collisionMode(boolean collisionMode)

Obtain a re-generator that only outputs items with IDs that if renamed would collide with another item's ID.

Parameters:

collisionMode - only output items that would collide if renamed

Returns:

a new, more tolerant, re-generator