Package com.inductiveautomation.ignition.gateway.config

Class DefaultResourceReferenceDelegate<R>

java.lang.Object

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

All Implemented Interfaces:

ResourceReferenceDelegate<R>

Direct Known Subclasses:

ExtensionPointReferenceDelegate

public class DefaultResourceReferenceDelegate<R>
extends Object
implements ResourceReferenceDelegate<R>

Holds a collection of ReferenceProperty objects for a given resource type. This class handles the logic of decoding relevant resources, collecting any references, turning them into Reference objects which contain a ReferenceUpdater which can 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 List<ReferenceProperty<R>>	properties
protected final ResourceType	resourceType

Constructor Summary

Constructors

Constructor	Description
DefaultResourceReferenceDelegate(ResourceType resourceType, JsonResourceCodec<R> codec, List<ReferenceProperty<R>> properties)

Method Summary

Modifier and Type	Method	Description
protected Stream<Reference>	findReferences(Collection<ReferenceProperty<R>> properties, DecodedResource<R> resource, ResourcePath targetResource)
Collection<ReferenceProperty<R>>	getReferenceProperties()
protected Collection<ReferenceProperty<R>>	getReferencePropsForTarget(ResourceType type)	Get the relevant reference properties with the given target type
Collection<Reference>	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

properties

protected final List<ReferenceProperty<R>> properties

Constructor Details

DefaultResourceReferenceDelegate

public DefaultResourceReferenceDelegate(ResourceType resourceType,
 JsonResourceCodec<R> codec,
 List<ReferenceProperty<R>> properties)

Method Details

getReferences

public Collection<Reference> 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<R>

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:

• Reference.updateReference(ResourcePath)

getReferenceProperties

public Collection<ReferenceProperty<R>> getReferenceProperties()

Specified by:

getReferenceProperties in interface ResourceReferenceDelegate<R>

Returns:

A collection of all reference properties for the resource type represented by this delegate.

getReferencePropsForTarget

protected Collection<ReferenceProperty<R>> getReferencePropsForTarget(ResourceType type)

Get the relevant reference properties with the given target type

findReferences

protected Stream<Reference> findReferences(Collection<ReferenceProperty<R>> properties,
 DecodedResource<R> resource,
 ResourcePath targetResource)