com.yworks.yfiles.graph

Interface IMapperRegistry

All Known Implementing Classes:

MapperRegistry

public interface IMapperRegistry

A registry that can be used to store IMapper implementations by tag.

Implementations of this interface can be found in the ILookup.lookup(Class) of the default IGraph implementations in the framework.

Using IMapperRegistry is described in the section Associating Data with Graph Elements.

See Also:

MapperRegistry

Method Summary

Modifier and Type	Method and Description
<K,V> void	addMapper(Class<K> keyType, Class<V> valueType, Object tag, IMapper<K,V> mapper) Registers a mapper for the given tag.
default <V> void	addMapper(Class<V> valueType, EdgeDpKey<V> tag, IMapper<IEdge,V> mapper) Adds a previously created mapper to this instance for the given tag.
default <V> void	addMapper(Class<V> valueType, ILabelLayoutDpKey<V> tag, IMapper<ILabel,V> mapper) Adds a previously created mapper to this instance for the given tag.
default <V> void	addMapper(Class<V> valueType, NodeDpKey<V> tag, IMapper<INode,V> mapper) Adds a previously created mapper to this instance for the given tag.
default <K,V> IMapper<K,V>	createConstantMapper(Class<K> kType, Class<V> vType, Object tag, V constant) Creates a simple read-only IMapper implementation and adds it to the registry using the provided tag.
default <V> IMapper<IEdge,V>	createConstantMapper(Class<V> valueType, EdgeDpKey<V> tag, V constant) Creates a simple read-only IMapper implementation with key type IEdge and adds it to the registry using the provided tag.
default <V> IMapper<ILabel,V>	createConstantMapper(Class<V> valueType, ILabelLayoutDpKey<V> tag, V constant) Creates a simple read-only IMapper implementation with key type ILabel and adds it to the registry using the provided tag.
default <V> IMapper<INode,V>	createConstantMapper(Class<V> valueType, NodeDpKey<V> tag, V constant) Creates a simple read-only IMapper implementation with key type INode and adds it to the registry using the provided tag.
default <K,V> IMapper<K,V>	createDelegateMapper(Class<K> kType, Class<V> vType, Object tag, Function<K,V> getter) Creates a delegate-based read-only IMapper implementation and adds it to the registry using the provided tag.
default <V> IMapper<IEdge,V>	createDelegateMapper(Class<V> valueType, EdgeDpKey<V> tag, Function<IEdge,V> getter) Creates a delegate-based read-only IMapper implementation with key type IEdge and adds it to the registry using the provided tag.
default <V> IMapper<ILabel,V>	createDelegateMapper(Class<V> valueType, ILabelLayoutDpKey<V> tag, Function<ILabel,V> getter) Creates a delegate-based read-only IMapper implementation with key type ILabel and adds it to the registry using the provided tag.
default <V> IMapper<INode,V>	createDelegateMapper(Class<V> valueType, NodeDpKey<V> tag, Function<INode,V> getter) Creates a delegate-based read-only IMapper implementation with key type INode and adds it to the registry using the provided tag.
default <K,V> Mapper<K,V>	createMapper(Class<K> kType, Class<V> vType, Object tag) Creates and adds a new Mapper to the registry using the provided tag.
default <V> Mapper<IEdge,V>	createMapper(Class<V> valueType, EdgeDpKey<V> tag) Creates and adds a new Mapper with key type IEdge to the registry using the provided tag.
default <V> Mapper<ILabel,V>	createMapper(Class<V> valueType, ILabelLayoutDpKey<V> tag) Creates and adds a new Mapper with key type ILabel to the registry using the provided tag.
default <V> Mapper<INode,V>	createMapper(Class<V> valueType, NodeDpKey<V> tag) Creates and adds a new Mapper with key type INode to the registry using the provided tag.
default <K,V> Mapper<K,V>	createWeakMapper(Class<K> kType, Class<V> vType, Object tag) Creates and adds a new Mapper to the registry using the provided tag.
default <V> Mapper<IEdge,V>	createWeakMapper(Class<V> valueType, EdgeDpKey<V> tag) Creates and adds a new Mapper with key type IEdge to the registry using the provided tag.
default <V> Mapper<ILabel,V>	createWeakMapper(Class<V> valueType, ILabelLayoutDpKey<V> tag) Creates and adds a new Mapper with key type ILabel to the registry using the provided tag.
default <V> Mapper<INode,V>	createWeakMapper(Class<V> valueType, NodeDpKey<V> tag) Creates and adds a new Mapper with key type INode to the registry using the provided tag.
<K,V> IMapper<K,V>	getMapper(Class<K> keyType, Class<V> valueType, Object tag) Returns a mapper that has previously been registered with this instance for the given tag.
default <V> IMapper<IEdge,V>	getMapper(Class<V> valueType, EdgeDpKey<V> tag) Returns a mapper that has previously been registered with this instance for the given tag.
default <V> IMapper<ILabel,V>	getMapper(Class<V> valueType, ILabelLayoutDpKey<V> tag) Returns a mapper that has previously been registered with this instance for the given tag.
default <V> IMapper<INode,V>	getMapper(Class<V> valueType, NodeDpKey<V> tag) Returns a mapper that has previously been registered with this instance for the given tag.
MapperMetadata	getMapperMetadata(Object tag) Gets the mapper meta data for the mapper that is registered using the tag.
default IMapper<Object,Object>	getObjectObjectMapper(Object tag) Returns a mapper instance for which there has previously been registered an instance for the given tag, however using a different type parameter set.
IEnumerable<Object>	getRegisteredTags() Gets an enumerable over all tags that have been used to register mapper implementations with this interface.
void	removeMapper(Object tag) Removes a previously registered mapper for the given tag.
void	setMapperMetadata(Object tag, MapperMetadata metadata) Sets the mapper meta data for the mapper that has been registered using the provided tag.

Method Detail

addMapper

<K,V> void addMapper(Class<K> keyType,
                     Class<V> valueType,
                     Object tag,
                     IMapper<K,V> mapper)

Registers a mapper for the given tag.

If there already was a mapper for tag, it will be replaced.

Type Parameters:

K - The key type for the mapper.

V - The value type for the mapper.

Parameters:

valueType - The value type for the mapper.

keyType - The key type for the mapper.

tag - The tag to use.

mapper - The mapper to register.

addMapper

default <V> void addMapper(Class<V> valueType,
                           EdgeDpKey<V> tag,
                           IMapper<IEdge,V> mapper)

Adds a previously created mapper to this instance for the given tag.

The key type of the mapper is IEdge while the value type of the mapper is inferred by the provided tag.

Type Parameters:

V - The value type for the mapper.

Parameters:

tag - The tag to use to look up the mapper.

mapper - The mapper instance to register.

addMapper

default <V> void addMapper(Class<V> valueType,
                           ILabelLayoutDpKey<V> tag,
                           IMapper<ILabel,V> mapper)

Adds a previously created mapper to this instance for the given tag.

The key type of the mapper is ILabel while the value type of the mapper is inferred by the provided tag.

Type Parameters:

V - The value type for the mapper.

Parameters:

tag - The tag to use to look up the mapper.

mapper - The mapper instance to register.

addMapper

default <V> void addMapper(Class<V> valueType,
                           NodeDpKey<V> tag,
                           IMapper<INode,V> mapper)

Adds a previously created mapper to this instance for the given tag.

The key type of the mapper is INode while the value type of the mapper is inferred by the provided tag.

Type Parameters:

V - The value type for the mapper.

Parameters:

tag - The tag to use to look up the mapper.

mapper - The mapper instance to register.

createConstantMapper

default <K,V> IMapper<K,V> createConstantMapper(Class<K> kType,
                                                Class<V> vType,
                                                Object tag,
                                                V constant)

Creates a simple read-only IMapper implementation and adds it to the registry using the provided tag.

If there already was a mapper for tag, it will be replaced.

Type Parameters:

K - The type of the keys of the mapper.

V - The type of the values of the mapper.

Parameters:

tag - The tag.

constant - The value to yield during IMapper reads.

Returns:

The newly created mapper instance.

See Also:

IMapper.fromConstant(Object)

createConstantMapper

default <V> IMapper<IEdge,V> createConstantMapper(Class<V> valueType,
                                                  EdgeDpKey<V> tag,
                                                  V constant)

Creates a simple read-only IMapper implementation with key type IEdge and adds it to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

constant - The value to yield during IMapper reads.

Returns:

The newly created mapper instance.

See Also:

IMapper.fromFunction(Function)

createConstantMapper

default <V> IMapper<ILabel,V> createConstantMapper(Class<V> valueType,
                                                   ILabelLayoutDpKey<V> tag,
                                                   V constant)

Creates a simple read-only IMapper implementation with key type ILabel and adds it to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

constant - The value to yield during IMapper reads.

Returns:

The newly created mapper instance.

See Also:

IMapper.fromFunction(Function)

createConstantMapper

default <V> IMapper<INode,V> createConstantMapper(Class<V> valueType,
                                                  NodeDpKey<V> tag,
                                                  V constant)

Creates a simple read-only IMapper implementation with key type INode and adds it to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

constant - The value to yield during IMapper reads.

Returns:

The newly created mapper instance.

See Also:

IMapper.fromFunction(Function)

createDelegateMapper

default <K,V> IMapper<K,V> createDelegateMapper(Class<K> kType,
                                                Class<V> vType,
                                                Object tag,
                                                Function<K,V> getter)

Creates a delegate-based read-only IMapper implementation and adds it to the registry using the provided tag.

If there already was a mapper for tag, it will be replaced.

Type Parameters:

K - The type of the keys of the mapper.

V - The type of the values of the mapper.

Parameters:

tag - The tag.

getter - The getter delegate to which IMapper reads will be delegated.

Returns:

The newly created mapper instance.

See Also:

IMapper.fromFunction(Function)

createDelegateMapper

default <V> IMapper<IEdge,V> createDelegateMapper(Class<V> valueType,
                                                  EdgeDpKey<V> tag,
                                                  Function<IEdge,V> getter)

Creates a delegate-based read-only IMapper implementation with key type IEdge and adds it to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

getter - The getter delegate to which IMapper reads will be delegated.

Returns:

The newly created mapper instance.

See Also:

IMapper.fromFunction(Function)

createDelegateMapper

default <V> IMapper<ILabel,V> createDelegateMapper(Class<V> valueType,
                                                   ILabelLayoutDpKey<V> tag,
                                                   Function<ILabel,V> getter)

Creates a delegate-based read-only IMapper implementation with key type ILabel and adds it to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

getter - The getter delegate to which IMapper reads will be delegated.

Returns:

The newly created mapper instance.

See Also:

IMapper.fromFunction(Function)

createDelegateMapper

default <V> IMapper<INode,V> createDelegateMapper(Class<V> valueType,
                                                  NodeDpKey<V> tag,
                                                  Function<INode,V> getter)

Creates a delegate-based read-only IMapper implementation with key type INode and adds it to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

getter - The getter delegate to which IMapper reads will be delegated.

Returns:

The newly created mapper instance.

See Also:

IMapper.fromFunction(Function)

createMapper

default <K,V> Mapper<K,V> createMapper(Class<K> kType,
                                       Class<V> vType,
                                       Object tag)

Creates and adds a new Mapper to the registry using the provided tag.

If there already was a mapper for tag, it will be replaced.

Type Parameters:

K - The type of the keys of the mapper.

V - The type of the values of the mapper.

Parameters:

tag - The tag.

Returns:

The newly created mapper instance.

See Also:

Mapper

createMapper

default <V> Mapper<IEdge,V> createMapper(Class<V> valueType,
                                         EdgeDpKey<V> tag)

Creates and adds a new Mapper with key type IEdge to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

Returns:

The newly created mapper instance.

See Also:

Mapper

createMapper

default <V> Mapper<ILabel,V> createMapper(Class<V> valueType,
                                          ILabelLayoutDpKey<V> tag)

Creates and adds a new Mapper with key type ILabel to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

Returns:

The newly created mapper instance.

See Also:

Mapper

createMapper

default <V> Mapper<INode,V> createMapper(Class<V> valueType,
                                         NodeDpKey<V> tag)

Creates and adds a new Mapper with key type INode to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

Returns:

The newly created mapper instance.

See Also:

Mapper

createWeakMapper

default <K,V> Mapper<K,V> createWeakMapper(Class<K> kType,
                                           Class<V> vType,
                                           Object tag)

Creates and adds a new Mapper to the registry using the provided tag.

If there already was a mapper for tag, it will be replaced.

Type Parameters:

K - The type of the keys of the mapper.

V - The type of the values of the mapper.

Parameters:

tag - The tag.

Returns:

The newly created mapper instance.

See Also:

Mapper

createWeakMapper

default <V> Mapper<IEdge,V> createWeakMapper(Class<V> valueType,
                                             EdgeDpKey<V> tag)

Creates and adds a new Mapper with key type IEdge to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

Returns:

The newly created mapper instance.

See Also:

Mapper

createWeakMapper

default <V> Mapper<ILabel,V> createWeakMapper(Class<V> valueType,
                                              ILabelLayoutDpKey<V> tag)

Creates and adds a new Mapper with key type ILabel to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

Returns:

The newly created mapper instance.

See Also:

Mapper

createWeakMapper

default <V> Mapper<INode,V> createWeakMapper(Class<V> valueType,
                                             NodeDpKey<V> tag)

Creates and adds a new Mapper with key type INode to the registry using the provided tag.

The value type of the mapper is inferred by the provided tag. If there already was a mapper for tag, it will be replaced.

Type Parameters:

V - The type of the values of the mapper.

Parameters:

tag - The tag.

Returns:

The newly created mapper instance.

See Also:

Mapper

getMapper

<K,V> IMapper<K,V> getMapper(Class<K> keyType,
                             Class<V> valueType,
                             Object tag)

Returns a mapper that has previously been registered with this instance for the given tag.

Type Parameters:

K - The key type for the mapper.

V - The value type for the mapper.

Parameters:

valueType - The value type for the mapper.

keyType - The key type for the mapper.

tag - The tag to use to look up the mapper.

Returns:

The previously registered instance or null.

getMapper

default <V> IMapper<IEdge,V> getMapper(Class<V> valueType,
                                       EdgeDpKey<V> tag)

Returns a mapper that has previously been registered with this instance for the given tag.

The key type of the mapper is IEdge while the value type of the mapper is inferred by the provided tag.

Type Parameters:

V - The value type for the mapper.

Parameters:

tag - The tag to use to look up the mapper.

Returns:

The previously registered instance or null.

getMapper

default <V> IMapper<ILabel,V> getMapper(Class<V> valueType,
                                        ILabelLayoutDpKey<V> tag)

Returns a mapper that has previously been registered with this instance for the given tag.

The key type of the mapper is ILabel while the value type of the mapper is inferred by the provided tag.

Type Parameters:

V - The value type for the mapper.

Parameters:

tag - The tag to use to look up the mapper.

Returns:

The previously registered instance or null.

getMapper

default <V> IMapper<INode,V> getMapper(Class<V> valueType,
                                       NodeDpKey<V> tag)

Returns a mapper that has previously been registered with this instance for the given tag.

The key type of the mapper is INode while the value type of the mapper is inferred by the provided tag.

Type Parameters:

V - The value type for the mapper.

Parameters:

tag - The tag to use to look up the mapper.

Returns:

The previously registered instance or null.

getMapperMetadata

MapperMetadata getMapperMetadata(Object tag)

Gets the mapper meta data for the mapper that is registered using the tag.

Parameters:

tag - The tag.

Returns:

The meta data or null if there is no such mapper registered for the given tag.

getObjectObjectMapper

default IMapper<Object,Object> getObjectObjectMapper(Object tag)

Returns a mapper instance for which there has previously been registered an instance for the given tag, however using a different type parameter set.

If the original mapper instance matches the type parameters, it will be returned, otherwise a dynamic wrapping implementation will be returned. This method can be used by generic code that does not know about the exact type parameters.

Parameters:

tag - The tag to use to look up the mapper.

Returns:

An instance that delegates to the original mapper or null if no mapper has been found for the provided tag.

getRegisteredTags

IEnumerable<Object> getRegisteredTags()

Gets an enumerable over all tags that have been used to register mapper implementations with this interface.

Returns:

The RegisteredTags.

removeMapper

void removeMapper(Object tag)

Removes a previously registered mapper for the given tag.

Parameters:

tag - The tag that has been used for registering the mapper.

setMapperMetadata

void setMapperMetadata(Object tag,
                       MapperMetadata metadata)

Sets the mapper meta data for the mapper that has been registered using the provided tag.

Throws:

IllegalArgumentException - If the KeyType or ValueType mismatch the mapper instance in the registry.

Parameters:

tag - The tag.

metadata - The meta data to store with the mapper.