Package org.openhab.core.thing.link

Class ItemChannelLinkRegistry

java.lang.Object

org.openhab.core.common.registry.AbstractRegistry<ItemChannelLink,String,ItemChannelLinkProvider>

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

org.openhab.core.thing.link.ItemChannelLinkRegistry

All Implemented Interfaces:

ProviderChangeListener<ItemChannelLink>, Registry<ItemChannelLink,String>, RegistryChangeListener<Item>, EventSubscriber

@NonNullByDefault
public class ItemChannelLinkRegistry
extends AbstractLinkRegistry<ItemChannelLink,ItemChannelLinkProvider>
implements RegistryChangeListener<Item>, EventSubscriber

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, Andrew Fiddian-Green - Apply channel default tags to items

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ItemChannelLinkRegistry.ItemChannelLinkProblem

Field Summary

Fields

Modifier and Type	Field	Description
static final String	USE_TAGS

Fields inherited from interface org.openhab.core.events.EventSubscriber

ALL_EVENT_TYPES

Constructor Summary

Constructors

Constructor	Description
ItemChannelLinkRegistry(@Nullable Map<String,@Nullable Object> configuration, ThingRegistry thingRegistry, ItemRegistry itemRegistry, ItemBuilderFactory itemBuilderFactory, org.osgi.framework.BundleContext bundleContext)

Method Summary

Modifier and Type	Method	Description
void	added(Item item)	If a new item is added to the item registry and we already have prior "pre- orphaned" links to it, then update the tags from the default tags of the prior linked channels.
protected void	deactivate()
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)
Set<String>	getSubscribedEventTypes()	Subscribe to system start level events.
protected void	modified(@Nullable Map<String,@Nullable Object> configuration)
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
void	receive(Event event)	Re-initialize (one off) all the channel default tags when startup is complete.
void	removed(Item item)	If the item has gone then clear the 'tagsLinked' flag.
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)
void	updated(Item oldItem, Item item)	Either this class applied channel default tags to the item, or something else updated the item (including possibly updating its tags), so in any case do NOT try to re-apply the channel default tags.

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

Methods inherited from interface org.openhab.core.events.EventSubscriber

getEventFilter

Field Details

USE_TAGS

public static final String USE_TAGS

See Also:

• Constant Field Values

Constructor Details

ItemChannelLinkRegistry

public ItemChannelLinkRegistry(@Nullable Map<String,@Nullable Object> configuration,
 ThingRegistry thingRegistry,
 ItemRegistry itemRegistry,
 ItemBuilderFactory itemBuilderFactory,
 org.osgi.framework.BundleContext bundleContext)

Method Details

modified

protected void modified(@Nullable Map<String,@Nullable Object> configuration)

deactivate

protected void deactivate()

Overrides:

deactivate in class AbstractRegistry<ItemChannelLink,String,ItemChannelLinkProvider>

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>

added

public void added(Item item)

If a new item is added to the item registry and we already have prior "pre- orphaned" links to it, then update the tags from the default tags of the prior linked channels.

Specified by:

added in interface RegistryChangeListener<Item>

Parameters:

item - the element that has been added

removed

public void removed(Item item)

If the item has gone then clear the 'tagsLinked' flag.

Specified by:

removed in interface RegistryChangeListener<Item>

Parameters:

item - the element that has been removed

updated

public void updated(Item oldItem,
 Item item)

Either this class applied channel default tags to the item, or something else updated the item (including possibly updating its tags), so in any case do NOT try to re-apply the channel default tags. Since that might cause an infinite loop.

Specified by:

updated in interface RegistryChangeListener<Item>

Parameters:

oldItem - the element that has been updated

item - the new element

getSubscribedEventTypes

public Set<String> getSubscribedEventTypes()

Subscribe to system start level events.

Specified by:

getSubscribedEventTypes in interface EventSubscriber

Returns:

subscribed event types (not null)

receive

public void receive(Event event)

Re-initialize (one off) all the channel default tags when startup is complete.

Specified by:

receive in interface EventSubscriber

Parameters:

event - the received event (not null)