Package org.openhab.core.thing.link

Class ItemChannelLinkRegistry

java.lang.Object

org.openhab.core.common.registry.AbstractRegistry<L,String,P>

org.openhab.core.thing.link.AbstractLinkRegistry<ItemChannelLink,ItemChannelLinkProvider>

org.openhab.core.thing.link.ItemChannelLinkRegistry

All Implemented Interfaces:

ProviderChangeListener<ItemChannelLink>, Registry<ItemChannelLink,String>

@NonNullByDefault
public class ItemChannelLinkRegistry
extends AbstractLinkRegistry<ItemChannelLink,ItemChannelLinkProvider>

ItemChannelLinkRegistry tracks all ItemChannelLinkProviders and aggregates all ItemChannelLinks.

Author:

Dennis Nobel - Initial contribution, Markus Rathgeb - Linked items returns only existing items, Markus Rathgeb - Rewrite collection handling to improve performance

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ItemChannelLinkRegistry.ItemChannelLinkProblem

Constructor Summary

Constructors

Constructor	Description
ItemChannelLinkRegistry(ThingRegistry thingRegistry, ItemRegistry itemRegistry)

Method Summary

Modifier and Type	Method	Description
Set<ChannelUID>	getBoundChannels(String itemName)	Returns a set of bound channels for the given item name.
Set<Thing>	getBoundThings(String itemName)	Returns a set of bound things for the given item name.
Set<String>	getLinkedItemNames(UID uid)	Returns the item names, which are bound to the given UID.
Set<Item>	getLinkedItems(UID uid)	Returns a set of bound items for the given channel UID.
Map<ItemChannelLink,ItemChannelLinkRegistry.ItemChannelLinkProblem>	getOrphanLinks()	Get all orphan links (item or channel missing)
protected void	notifyListenersAboutAddedElement(ItemChannelLink element)
protected void	notifyListenersAboutRemovedElement(ItemChannelLink element)
protected void	notifyListenersAboutUpdatedElement(ItemChannelLink oldElement, ItemChannelLink element)
int	purge()	Remove all orphaned (item or channel missing) links that are editable
int	removeLinksForItem(String itemName)	Remove all links related to an item
int	removeLinksForThing(ThingUID thingUID)	Remove all links related to a thing
protected void	setEventPublisher(EventPublisher eventPublisher)
protected void	setManagedProvider(ManagedItemChannelLinkProvider provider)
protected void	setReadyService(ReadyService readyService)
protected void	unsetEventPublisher(EventPublisher eventPublisher)
protected void	unsetManagedProvider(ManagedItemChannelLinkProvider provider)
protected void	unsetReadyService(ReadyService readyService)

Methods inherited from class org.openhab.core.thing.link.AbstractLinkRegistry

getLinks, getLinks, isLinked, isLinked, isLinked, onAddElement, onRemoveElement, onUpdateElement

Methods inherited from class org.openhab.core.common.registry.AbstractRegistry

activate, add, added, addProvider, addRegistryChangeListener, beforeUpdateElement, deactivate, forEach, forEach, forEach, get, getAll, getEventPublisher, getManagedProvider, getProvider, getProvider, getValueAndProvider, notifyListeners, notifyListeners, postEvent, remove, removed, removeProvider, removeRegistryChangeListener, setManagedProvider, stream, unsetManagedProvider, update, updated, waitForCompletedAsyncActivationTasks

Methods inherited from class java.lang.Object

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

Constructor Details

ItemChannelLinkRegistry

public ItemChannelLinkRegistry(ThingRegistry thingRegistry,
 ItemRegistry itemRegistry)

Method Details

getBoundChannels

public Set<ChannelUID> getBoundChannels(String itemName)

Returns a set of bound channels for the given item name.

Parameters:

itemName - item name

Returns:

an unmodifiable set of bound channels for the given item name

getLinkedItemNames

public Set<String> getLinkedItemNames(UID uid)

Description copied from class: AbstractLinkRegistry

Returns the item names, which are bound to the given UID.

Overrides:

getLinkedItemNames in class AbstractLinkRegistry<ItemChannelLink,ItemChannelLinkProvider>

Parameters:

uid - UID

Returns:

a non-null unmodifiable collection of item names that are linked to the given UID.

getLinkedItems

public Set<Item> getLinkedItems(UID uid)

Returns a set of bound items for the given channel UID.

Parameters:

uid - channel UID

Returns:

an unmodifiable set of bound items for the given channel UID

getBoundThings

public Set<Thing> getBoundThings(String itemName)

Returns a set of bound things for the given item name.

Parameters:

itemName - item name

Returns:

an unmodifiable set of bound things for the given item name

setManagedProvider

protected void setManagedProvider(ManagedItemChannelLinkProvider provider)

unsetManagedProvider

protected void unsetManagedProvider(ManagedItemChannelLinkProvider provider)

setEventPublisher

protected void setEventPublisher(EventPublisher eventPublisher)

Overrides:

setEventPublisher in class AbstractRegistry<ItemChannelLink,String,ItemChannelLinkProvider>

setReadyService

protected void setReadyService(ReadyService readyService)

Overrides:

setReadyService in class AbstractRegistry<ItemChannelLink,String,ItemChannelLinkProvider>

unsetReadyService

protected void unsetReadyService(ReadyService readyService)

Overrides:

unsetReadyService in class AbstractRegistry<ItemChannelLink,String,ItemChannelLinkProvider>

unsetEventPublisher

protected void unsetEventPublisher(EventPublisher eventPublisher)

Overrides:

unsetEventPublisher in class AbstractRegistry<ItemChannelLink,String,ItemChannelLinkProvider>

removeLinksForThing

public int removeLinksForThing(ThingUID thingUID)

Remove all links related to a thing

Parameters:

thingUID - the UID of the thing

Returns:

the number of removed links

removeLinksForItem

public int removeLinksForItem(String itemName)

Remove all links related to an item

Parameters:

itemName - the name of the item

Returns:

the number of removed links

purge

public int purge()

Remove all orphaned (item or channel missing) links that are editable

Returns:

the number of removed links

See Also:

• getOrphanLinks()

getOrphanLinks

public Map<ItemChannelLink,ItemChannelLinkRegistry.ItemChannelLinkProblem> getOrphanLinks()

Get all orphan links (item or channel missing)

Returns:

a map with orphan links as key and reason they are broken as value

See Also:

• purge()

notifyListenersAboutAddedElement

protected void notifyListenersAboutAddedElement(ItemChannelLink element)

Overrides:

notifyListenersAboutAddedElement in class AbstractRegistry<ItemChannelLink,String,ItemChannelLinkProvider>

notifyListenersAboutRemovedElement

protected void notifyListenersAboutRemovedElement(ItemChannelLink element)

Overrides:

notifyListenersAboutRemovedElement in class AbstractRegistry<ItemChannelLink,String,ItemChannelLinkProvider>

notifyListenersAboutUpdatedElement

protected void notifyListenersAboutUpdatedElement(ItemChannelLink oldElement,
 ItemChannelLink element)

Overrides:

notifyListenersAboutUpdatedElement in class AbstractRegistry<ItemChannelLink,String,ItemChannelLinkProvider>