ToolsResource (EHRI Backend 0.13.10 API)

java.lang.Object
- eu.ehri.extension.base.AbstractResource
- - eu.ehri.extension.ToolsResource

All Implemented Interfaces:

TxCheckedResource
```
public class ToolsResource
extends AbstractResource
```
Miscellaneous additional functionality that doesn't fit anywhere else.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT
- Fields inherited from class eu.ehri.extension.base.AbstractResource
  ACCESSOR_PARAM, ALL_PARAM, AUTH_HEADER_NAME, COMMIT_PARAM, CSV_MEDIA_TYPE, DEFAULT_LIST_LIMIT, FILTER_PARAM, graph, GROUP_PARAM, ID_PARAM, INCLUDE_PROPS_PARAM, ITEM_CACHE_TIME, jsonFactory, jsonMapper, LIMIT_PARAM, LOG_MESSAGE_HEADER_NAME, LOG_PARAM, logger, manager, N3_MIMETYPE, OFFSET_PARAM, PATCH_HEADER_NAME, RANGE_HEADER_NAME, RDF_MIMETYPE_FORMATS, RDF_XML_MIMETYPE, request, requestHeaders, RESOURCE_ENDPOINT_PREFIX, SCOPE_PARAM, SORT_PARAM, STREAM_HEADER_NAME, TOLERANT_PARAM, TURTLE_MIMETYPE, uriInfo, VERSION_PARAM

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT`

Constructor Summary

Constructors
Constructor and Description

ToolsResource(org.neo4j.graphdb.GraphDatabaseService database)

Constructors
Constructor and Description
`ToolsResource(org.neo4j.graphdb.GraphDatabaseService database)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`autoLinkRepositoryDocs(String repositoryId, String vocabularyId, Set<AccessPointType> accessPointTypes, String languageCode, boolean excludeSingle, boolean tolerant)` Create concepts and links derived from the access points on a repository's documentary units.
`javax.ws.rs.core.Response`	`exportSchema(String format, String baseUri)` Export an RDFS+OWL representation of the model schema.
`Table`	`findReplace(String from, String to, String type, String subType, String property, int maxItems, boolean commit)` Find and replace text in descriptions for a given item type and description property name.
`void`	`fullUpgradeDb1to2()`
`void`	`initialize(boolean confirm, InputStream fixtures)` Extremely lossy helper method for cleaning a test instance
`String`	`regenerateDescriptionIds(int bufferSize, boolean commit)` Regenerate description IDs.
`Table`	`regenerateIds(List<String> ids, boolean collisions, boolean tolerant, boolean commit, Table data)` Regenerate the hierarchical graph ID for a set of items, optionally renaming them.
`Table`	`regenerateIdsForScope(String scopeId, boolean collisions, boolean tolerant, boolean commit)` Regenerate the hierarchical graph ID for all items within the permission scope and lower levels.
`Table`	`regenerateIdsForType(String type, boolean collisions, boolean tolerant, boolean commit)` Regenerate the hierarchical graph ID all items of a given type.
`Table`	`relink(Table mapping)` Takes a CSV file containing a mapping from one item to another and moves changes the link target of anything linked to `from` to `to`.
`Table`	`rename(Table mapping)` Takes a CSV file containing two columns: the global id, and a new local identifier to rename an item to.
`Table`	`reparent(boolean commit, Table mapping)` Takes a CSV file containing two columns: an item global id, and a new parent ID.
`void`	`setConstraints()`
`String`	`setLabels()`
`String`	`upgradeDb1to2()`
`String`	`version()`

Methods inherited from class eu.ehri.extension.base.AbstractResource
anonymousApi, api, beginTx, creationResponse, getCacheControl, getCurrentActioner, getCurrentUser, getGraph, getIntQueryParam, getItemUri, getLogMessage, getQuery, getRdfFormat, getRequesterUserProfile, getSerializer, getStringListQueryParam, isPatch, isStreaming, single, streamingList, streamingList, streamingListOfLists, streamingPage, streamingPage, streamingVertexList, streamingVertexList

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ENDPOINT
```
public static final String ENDPOINT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ToolsResource
```
public ToolsResource(@Context
                     org.neo4j.graphdb.GraphDatabaseService database)
```
- Method Detail
  - version
```
public String version()
```
  - findReplace
```
public Table findReplace(String from,
                         String to,
                         String type,
                         String subType,
                         String property,
                         int maxItems,
                         boolean commit)
                  throws ValidationError
```
    Find and replace text in descriptions for a given item type and description property name.
    Changes will be logged to the audit log.
    
    Parameters:
    
    type - the parent entity type
    
    subType - the specific node type
    
    property - the property name
    
    from - the original text
    
    to - the replacement text
    
    maxItems - the max number of items to change (defaults to 100)
    
    commit - actually commit the changes
    
    Returns:
    
    a list of item IDs for those items changed
    
    Throws:
    
    ValidationError
  - exportSchema
```
public javax.ws.rs.core.Response exportSchema(String format,
                                              String baseUri)
                                       throws IOException
```
    Export an RDFS+OWL representation of the model schema.
    
    Parameters:
    
    format - the RDF format
    
    baseUri - the RDF base URI
    
    Returns:
    
    a streaming response
    
    Throws:
    
    IOException
  - autoLinkRepositoryDocs
```
public long autoLinkRepositoryDocs(String repositoryId,
                                   String vocabularyId,
                                   Set<AccessPointType> accessPointTypes,
                                   String languageCode,
                                   boolean excludeSingle,
                                   boolean tolerant)
                            throws ItemNotFound,
                                   ValidationError,
                                   PermissionDenied,
                                   DeserializationError
```
    Create concepts and links derived from the access points on a repository's documentary units.
    
    Parameters:
    
    repositoryId - the repository id
    
    vocabularyId - the target vocabulary
    
    languageCode - the language code of created concepts
    
    accessPointTypes - the access point types to process
    
    tolerant - proceed even if there are integrity errors due to slug collisions in the created concepts
    
    excludeSingle - don't create concepts/links for access points that are unique to a single item
    
    Returns:
    
    the number of links created
    
    Throws:
    
    ItemNotFound
    
    ValidationError
    
    PermissionDenied
    
    DeserializationError
  - regenerateIds
```
public Table regenerateIds(List<String> ids,
                           boolean collisions,
                           boolean tolerant,
                           boolean commit,
                           Table data)
                    throws ItemNotFound,
                           IOException,
                           IdRegenerator.IdCollisionError
```
    Regenerate the hierarchical graph ID for a set of items, optionally renaming them.
    The default mode is to output items whose IDs would change, without actually changing them. The collisions parameter will only output items that would cause collisions if renamed, whereas tolerant mode will skip them altogether.
    The commit flag will cause renaming to take place.
    
    Parameters:
    
    ids - the existing item IDs
    
    collisions - only output items that if renamed to the regenerated ID would cause collisions
    
    tolerant - skip items that could cause collisions rather then throwing an error
    
    commit - whether or not to rename the item
    
    Returns:
    
    a tab old-to-new mapping, or an empty body if nothing was changed
    
    Throws:
    
    ItemNotFound
    
    IOException
    
    IdRegenerator.IdCollisionError
  - regenerateIdsForType
```
public Table regenerateIdsForType(String type,
                                  boolean collisions,
                                  boolean tolerant,
                                  boolean commit)
                           throws IOException,
                                  IdRegenerator.IdCollisionError
```
    Regenerate the hierarchical graph ID all items of a given type.
    The default mode is to output items whose IDs would change, without actually changing them. The collisions parameter will only output items that would cause collisions if renamed, whereas tolerant mode will skip them altogether.
    The commit flag will cause renaming to take place.
    
    Parameters:
    
    type - the item type
    
    collisions - only output items that if renamed to the regenerated ID would cause collisions
    
    tolerant - skip items that could cause collisions rather then throwing an error
    
    commit - whether or not to rename the items
    
    Returns:
    
    a tab list old-to-new mappings, or an empty body if nothing was changed
    
    Throws:
    
    IOException
    
    IdRegenerator.IdCollisionError
  - regenerateIdsForScope
```
public Table regenerateIdsForScope(String scopeId,
                                   boolean collisions,
                                   boolean tolerant,
                                   boolean commit)
                            throws IOException,
                                   ItemNotFound,
                                   IdRegenerator.IdCollisionError
```
    Regenerate the hierarchical graph ID for all items within the permission scope and lower levels.
    The default mode is to output items whose IDs would change, without actually changing them. The collisions parameter will only output items that would cause collisions if renamed, whereas tolerant mode will skip them altogether.
    The commit flag will cause renaming to take place.
    
    Parameters:
    
    scopeId - the scope item's ID
    
    collisions - only output items that if renamed to the regenerated ID would cause collisions
    
    tolerant - skip items that could cause collisions rather then throwing an error
    
    commit - whether or not to rename the items
    
    Returns:
    
    a tab list old-to-new mappings, or an empty body if nothing was changed
    
    Throws:
    
    IOException
    
    ItemNotFound
    
    IdRegenerator.IdCollisionError
  - regenerateDescriptionIds
```
public String regenerateDescriptionIds(int bufferSize,
                                       boolean commit)
                                throws IOException,
                                       ItemNotFound,
                                       IdRegenerator.IdCollisionError
```
    Regenerate description IDs.
    
    Throws:
    
    IOException
    
    ItemNotFound
    
    IdRegenerator.IdCollisionError
  - setLabels
```
public String setLabels()
                 throws IOException,
                        ItemNotFound,
                        IdRegenerator.IdCollisionError
```
    Throws:
    
    IOException
    
    ItemNotFound
    
    IdRegenerator.IdCollisionError
  - setConstraints
```
public void setConstraints()
```
  - upgradeDb1to2
```
public String upgradeDb1to2()
                     throws IOException
```
    Throws:
    
    IOException
  - fullUpgradeDb1to2
```
public void fullUpgradeDb1to2()
                       throws IOException,
                              IdRegenerator.IdCollisionError,
                              ItemNotFound
```
    Throws:
    
    IOException
    
    IdRegenerator.IdCollisionError
    
    ItemNotFound
  - relink
```
public Table relink(Table mapping)
             throws DeserializationError
```
    Takes a CSV file containing a mapping from one item to another and moves changes the link target of anything linked to from to to.
    
    Parameters:
    
    mapping - a comma-separated TSV file, excluding headers
    
    Returns:
    
    CSV data with each row indicating the source, target, and how many items were relinked for each
    
    Throws:
    
    DeserializationError
  - reparent
```
public Table reparent(boolean commit,
                      Table mapping)
               throws DeserializationError
```
    Takes a CSV file containing two columns: an item global id, and a new parent ID. The item will be re-parented and a new global ID regenerated.
    
    Parameters:
    
    commit - actually commit changes
    
    mapping - a comma-separated CSV file, exluding headers.
    
    Returns:
    
    CSV data containing two columns: the old global ID, and a newly generated global ID, derived from the new hierarchy.
    
    Throws:
    
    DeserializationError
  - rename
```
public Table rename(Table mapping)
             throws IdRegenerator.IdCollisionError,
                    DeserializationError
```
    Takes a CSV file containing two columns: the global id, and a new local identifier to rename an item to. A new global ID will be regenerated.
    Input rows will be re-sorted lexically to ensure correct generation of dependent parent/child hierarchical IDs and output order will reflect this.
    
    Parameters:
    
    mapping - a comma-separated CSV file, exluding headers.
    
    Returns:
    
    CSV data containing two columns: the old global ID, and a newly generated global ID, derived from the new local identifier, with ordering corresponding to lexically-ordered input data.
    
    Throws:
    
    IdRegenerator.IdCollisionError
    
    DeserializationError
  - initialize
```
public void initialize(boolean confirm,
                       InputStream fixtures)
                throws Exception
```
    Extremely lossy helper method for cleaning a test instance
    
    Parameters:
    
    fixtures - YAML fixture data to be loaded into the fresh graph
    
    Throws:
    
    Exception

Class ToolsResource

Field Summary

Fields inherited from class eu.ehri.extension.base.AbstractResource

Constructor Summary

Method Summary

Methods inherited from class eu.ehri.extension.base.AbstractResource

Methods inherited from class java.lang.Object

Field Detail

ENDPOINT

Constructor Detail

ToolsResource

Method Detail

version

findReplace

exportSchema

autoLinkRepositoryDocs

regenerateIds

regenerateIdsForType

regenerateIdsForScope

regenerateDescriptionIds

setLabels

setConstraints

upgradeDb1to2

fullUpgradeDb1to2

relink

reparent

rename

initialize