Package com.inductiveautomation.ignition.common.resourcecollection

Class AbstractResourceCollection

java.lang.Object

com.inductiveautomation.ignition.common.resourcecollection.AbstractResourceCollection

All Implemented Interfaces:

ResourceCollection

Direct Known Subclasses:

DesignerProjectTreeImpl, RuntimeResourceCollection

public abstract class AbstractResourceCollection
extends Object
implements ResourceCollection

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.resourcecollection.ResourceCollection

GLOBAL_PROJECT_NAME, PIPELINE_PROJECT_NAME, PROJECT_NAME_PATTERN, SFC_PROJECT_NAME

Constructor Summary

Constructors

Constructor	Description
AbstractResourceCollection()

Method Summary

Modifier and Type	Method	Description
void	addResourceListener(ResourceListener listener)	Adds a listener for specific types of resource changes.
protected Map<ResourcePath,Resource>	getEffectiveResources()
protected CopyOnWriteArrayList<ResourceListener>	getListeners()
List<Resource>	getResources()	Get the effective Resources for this project.
List<Resource>	getResourcesOfType(ResourceType type)	Get all non-folder Resources of type type belonging to the module identified by moduleId.
boolean	hasResourcesOfType(ResourceType type)	Short-circuiting evaluation of whether project has any resources of given type.
void	removeResourceListener(ResourceListener listener)	Removes an existing listener.
protected ResourceCollectionDiff.EffectiveDiff	updateEffectiveState()	Call this after one or more resources or manifests have been changed.
protected ResourceCollectionDiff.EffectiveDiff	updateEffectiveState(@Nullable Object contextObject)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.common.resourcecollection.ResourceCollection

browse, getAllResources, getDescription, getInheritanceStructure, getManifest, getName, getParent, getResource, getResource, getSingletonResource, getSnapshots, getTitle, isEnabled, isInheritable, isRunnable

Constructor Details

AbstractResourceCollection

public AbstractResourceCollection()

Method Details

getListeners

protected CopyOnWriteArrayList<ResourceListener> getListeners()

getEffectiveResources

protected Map<ResourcePath,Resource> getEffectiveResources()

Returns:

the effective resources for this project, calculated by looking at the inheritance chain of resource collections. Inherited resources will have their paths re-mapped so that all resources appear to originate from this resource collection.

getResources

public List<Resource> getResources()

Description copied from interface: ResourceCollection

Get the effective Resources for this project.

This includes inherited resources from parent projects, recursively, except where resources in child projects override resources by the same name from parent projects. In other words, for any given ResourcePath, only the resource "closest" to this project in the inheritance chain will be included in this list.

Note that depending on the ResourceFilter used to load this project instance, this may not include all resource types that are actually part of this project.

Specified by:

getResources in interface ResourceCollection

Returns:

the effective Resources for this project.

updateEffectiveState

protected ResourceCollectionDiff.EffectiveDiff updateEffectiveState()

Call this after one or more resources or manifests have been changed. This will calculate the effective change to the resources and notify listeners.

updateEffectiveState

protected ResourceCollectionDiff.EffectiveDiff updateEffectiveState(@Nullable
 @Nullable Object contextObject)

getResourcesOfType

public List<Resource> getResourcesOfType(ResourceType type)

Description copied from interface: ResourceCollection

Get all non-folder Resources of type type belonging to the module identified by moduleId.

Resource types belonging to the Ignition platform are identified by module id "ignition".

Specified by:

getResourcesOfType in interface ResourceCollection

Parameters:

type - the resource type.

Returns:

all non-folder Resources of type type belonging to the module identified by moduleId.

See Also:

• ResourceCollection.getResources()
• Resource.PLATFORM_MODULE_ID

hasResourcesOfType

public boolean hasResourcesOfType(ResourceType type)

Description copied from interface: ResourceCollection

Short-circuiting evaluation of whether project has any resources of given type.

Specified by:

hasResourcesOfType in interface ResourceCollection

Parameters:

type - the resource type.

Returns:

true if the project contains at least one resource of the given type.

See also: ProjectLifecycleFactory#getProjectFilter()

See Also:

• ResourceCollection.getResourcesOfType(ResourceType)

addResourceListener

public void addResourceListener(ResourceListener listener)

Description copied from interface: ResourceCollection

Adds a listener for specific types of resource changes.

Specified by:

addResourceListener in interface ResourceCollection

Parameters:

listener - the ResourceListener to add.

removeResourceListener

public void removeResourceListener(ResourceListener listener)

Description copied from interface: ResourceCollection

Removes an existing listener. If not added, no-op.

Specified by:

removeResourceListener in interface ResourceCollection

Parameters:

listener - the ResourceListener to remove.