org.opennms.features.topology.api

Interface IconRepository

All Known Implementing Classes:

DefaultIconRepository

public interface IconRepository

Each IconRepository stores a mapping from icon keys to icon ids. The icon key is Graph Provider specific and is defined by it (e.g. "sfree:group") The icon id should match with an id element in all existing SVGs (not only this IconRepository.

Method Summary

Modifier and Type	Method and Description
void	addIconMapping(String iconKey, String iconId) Adds a custom icon mapping.
boolean	contains(String iconKey) Verifies if a mapping for the provided icon Key is defined.
String	getSVGIconId(String iconKey) Maps the provided iconKey to an SVG id element.
void	removeIconMapping(String iconKey) Removes the given iconKey from this IconRepository.
void	save() Persists this IconRepository.

Method Detail

contains

boolean contains(String iconKey)

Verifies if a mapping for the provided icon Key is defined.

Parameters:

iconKey - the icon key

Returns:

true if a mapping is defined, false otherwise.

getSVGIconId

String getSVGIconId(String iconKey)

Maps the provided iconKey to an SVG id element. If no mapping is defined, null is returned.

Parameters:

iconKey - The icon key to look up

Returns:

The icon id, or null if no mapping is defined.

addIconMapping

void addIconMapping(String iconKey,
                    String iconId)

Adds a custom icon mapping. The iconKey must be unique in this IconRepository.

Parameters:

iconKey - The icon key

iconId - The icon id for the icon key

removeIconMapping

void removeIconMapping(String iconKey)

Removes the given iconKey from this IconRepository.

Parameters:

iconKey - The icon key to remove

save

void save()

Persists this IconRepository. Should be invoked if changes to this IconRepository should be persisted permanently (e.g. on disk)