Package com.inductiveautomation.ignition.gateway.config

Class DefaultResourceReferenceDelegate<R>

java.lang.Object

com.inductiveautomation.ignition.gateway.config.DefaultResourceReferenceDelegate<R>

All Implemented Interfaces:

ResourceReferenceDelegate

Direct Known Subclasses:

ExtensionPointReferenceDelegate

public class DefaultResourceReferenceDelegate<R>
extends Object
implements ResourceReferenceDelegate

Encapsulates the logic of finding references to a target resource in a given resource. To do this, it uses a collection of ReferenceFinder objects that can detect the presence of a reference in a decoded resource. This class will then handle the logic of decoding relevant resources, collecting any references, turning them into PropertyReference objects which contain a ReferenceUpdater which knows how to re-encode the resource if the reference is later updated.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultResourceReferenceDelegate.Builder<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final JsonResourceCodec<R>	codec
protected final com.google.common.collect.Multimap<ResourceType,ReferenceFinder<R>>	referenceFinders
protected final ResourceType	resourceType

Fields inherited from interface com.inductiveautomation.ignition.gateway.config.ResourceReferenceDelegate

NONE

Constructor Summary

Constructors

Constructor	Description
DefaultResourceReferenceDelegate(ResourceType resourceType, JsonResourceCodec<R> codec, com.google.common.collect.Multimap<ResourceType,ReferenceFinder<R>> referenceFinders)

Method Summary

Modifier and Type	Method	Description
protected Stream<PropertyReference>	findReferences(Collection<ReferenceFinder<R>> finders, DecodedResource<R> resource, ResourcePath targetResource)
protected Collection<ReferenceFinder<R>>	getReferenceFinders(ResourceType type)
Collection<PropertyReference>	getReferences(ConfigurationManager manager, ResourcePath targetResource)	Finds any properties of any instance(s) of this resource type that reference the given resource.

Methods inherited from class java.lang.Object

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

Field Details

resourceType

protected final ResourceType resourceType

codec

protected final JsonResourceCodec<R> codec

referenceFinders

protected final com.google.common.collect.Multimap<ResourceType,ReferenceFinder<R>> referenceFinders

Constructor Details

DefaultResourceReferenceDelegate

public DefaultResourceReferenceDelegate(ResourceType resourceType,
 JsonResourceCodec<R> codec,
 com.google.common.collect.Multimap<ResourceType,ReferenceFinder<R>> referenceFinders)

Method Details

getReferences

public Collection<PropertyReference> getReferences(ConfigurationManager manager,
 ResourcePath targetResource)

Description copied from interface: ResourceReferenceDelegate

Finds any properties of any instance(s) of this resource type that reference the given resource.

Specified by:

getReferences in interface ResourceReferenceDelegate

Returns:

A collection of property references that reference the given resource. These references also include the capability to generate a ChangeOperation needed to update the reference in the case of a rename operation.

See Also:

• PropertyReference.updateReference(ResourcePath)

getReferenceFinders

protected Collection<ReferenceFinder<R>> getReferenceFinders(ResourceType type)

findReferences

protected Stream<PropertyReference> findReferences(Collection<ReferenceFinder<R>> finders,
 DecodedResource<R> resource,
 ResourcePath targetResource)