org.dcm4che3.conf.core.index

Class ReferenceIndexingDecorator

java.lang.Object

org.dcm4che3.conf.core.DelegatingConfiguration

org.dcm4che3.conf.core.index.ReferenceIndexingDecorator

All Implemented Interfaces:

BatchRunner, Configuration

public class ReferenceIndexingDecorator
extends DelegatingConfiguration

Keeps an index of objects referable by uuids to allow fast lookup by uuid

IMPORTANT: Some cache implementations have issues with isolation, so the base impl treats both absence of objects in the cache as well as empty paths the same way - i.e. like that entry does not exist

Author:

Roman K

Nested Class Summary

Nested classes/interfaces inherited from interface org.dcm4che3.conf.core.api.Configuration

Configuration.ConfigStorageType, Configuration.NodeFactory

Nested classes/interfaces inherited from interface org.dcm4che3.conf.core.api.BatchRunner

BatchRunner.Batch

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	log
(package private) static PathPattern	referencePattern
protected Map<String,Path>	uuidToReferableIndex

Fields inherited from class org.dcm4che3.conf.core.DelegatingConfiguration

delegate

Fields inherited from interface org.dcm4che3.conf.core.api.Configuration

CONF_STORAGE_SYSTEM_PROP, OLOCK_HASH_KEY, REFERENCE_BY_UUID_PATTERN, REFERENCE_KEY, UUID_KEY, WEAK_REFERENCE_KEY

Constructor Summary

Constructors

Constructor and Description
ReferenceIndexingDecorator()
ReferenceIndexingDecorator(Configuration delegate, Map<String,Path> uuidToSimplePathCache)

Method Summary

Modifier and Type	Method and Description
protected List<DuplicateUUIDException>	addReferablesToIndex(List<Object> pathItems, Object configNode)
protected Object	getNodeByUUID(Class configurableClass, String uuid)
Path	getPathByUUID(String uuid)
void	persistNode(Path path, Map<String,Object> configNode, Class configurableClass) Persists the configuration node to the specified path.
void	refreshNode(Path path) Invalidates any present cached state for the node It is imperative that some other nodes might also be refreshed during the operation.
protected void	removeFromCache(String uuid)
void	removeNode(Path path) Removes a configuration node under the specified path with all its children permanently
protected void	removeOldReferablesFromIndex(Object oldConfigurationNode)
Iterator	search(String liteXPathExpression) Performs a search on the configuration tree and returns an iterator to configuration nodes that satisfy the search criteria.

Methods inherited from class org.dcm4che3.conf.core.DelegatingConfiguration

getConfigurationNode, getConfigurationRoot, lock, nodeExists, runBatch

Methods inherited from class java.lang.Object

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

Field Detail

referencePattern

static PathPattern referencePattern

log

private static final Logger log

uuidToReferableIndex

protected Map<String,Path> uuidToReferableIndex

Constructor Detail

ReferenceIndexingDecorator

public ReferenceIndexingDecorator()

ReferenceIndexingDecorator

public ReferenceIndexingDecorator(Configuration delegate,
                                  Map<String,Path> uuidToSimplePathCache)

Method Detail

getPathByUUID

public Path getPathByUUID(String uuid)

Specified by:

getPathByUUID in interface Configuration

Overrides:

getPathByUUID in class DelegatingConfiguration

removeOldReferablesFromIndex

protected void removeOldReferablesFromIndex(Object oldConfigurationNode)

addReferablesToIndex

protected List<DuplicateUUIDException> addReferablesToIndex(List<Object> pathItems,
                                                            Object configNode)

Returns:

list of duplicate uuid exceptions, list is empty if no duplicates detected

getNodeByUUID

protected Object getNodeByUUID(Class configurableClass,
                               String uuid)
                        throws ConfIndexOutOfSyncException

Throws:

ConfIndexOutOfSyncException

persistNode

public void persistNode(Path path,
                        Map<String,Object> configNode,
                        Class configurableClass)
                 throws ConfigurationException

Description copied from interface: Configuration

Persists the configuration node to the specified path. The path must exist (or at least all nodes but the last one). The property is created/fully overwritten, i.e. if there were any child nodes in the old root that are not present in the new node root, they will be deleted in the new tree.

Specified by:

persistNode in interface Configuration

Overrides:

persistNode in class DelegatingConfiguration

Parameters:

path - path to the node

configNode - configuration node to persist

configurableClass - class annotated with ConfigurableClass, ConfigurableProperty annotations that corresponds to this node.

Throws:

ConfigurationException

refreshNode

public void refreshNode(Path path)
                 throws ConfigurationException

Description copied from interface: Configuration

Invalidates any present cached state for the node It is imperative that some other nodes might also be refreshed during the operation. There is no guarantee whether the new version will be re-loaded lazily or eagerly

Specified by:

refreshNode in interface Configuration

Overrides:

refreshNode in class DelegatingConfiguration

Throws:

ConfigurationException

removeNode

public void removeNode(Path path)
                throws ConfigurationException

Description copied from interface: Configuration

Removes a configuration node under the specified path with all its children permanently

Specified by:

removeNode in interface Configuration

Overrides:

removeNode in class DelegatingConfiguration

Throws:

ConfigurationException

search

public Iterator search(String liteXPathExpression)
                throws IllegalArgumentException,
                       ConfigurationException

Description copied from interface: Configuration

Performs a search on the configuration tree and returns an iterator to configuration nodes that satisfy the search criteria.

Specified by:

search in interface Configuration

Overrides:

search in class DelegatingConfiguration

Parameters:

liteXPathExpression - Must be absolute path, no double slashes, no @attributes (only [attr=val] or [attr<>val])

Throws:

IllegalArgumentException

ConfigurationException

removeFromCache

protected void removeFromCache(String uuid)