org.opennms.features.topology.api

Interface IconRepository

All Known Subinterfaces:

ConfigurableIconRepository

All Known Implementing Classes:

DefaultIconRepository, GraphMLIconRepository

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
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.

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.