Package com.inductiveautomation.ignition.designer.project

Class DesignerProjectTreeImpl

java.lang.Object

com.inductiveautomation.ignition.common.resourcecollection.AbstractResourceCollection

com.inductiveautomation.ignition.designer.project.DesignerProjectTreeImpl

All Implemented Interfaces:

ResourceCollection, DesignableProject

public class DesignerProjectTreeImpl
extends AbstractResourceCollection
implements DesignableProject

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
DesignerProjectTreeImpl(ResourceCollection project)

Method Summary

Modifier and Type	Method	Description
void	applyChange(ProjectChange change)	Apply a set of changes, pulled from the gateway, to this project.
Optional<List<Resource>>	browse(ResourcePath path)
void	createResource(Resource resource)	Create a new resource.
void	deleteResource(ResourcePath path)	Delete the resource at a given path.
boolean	discardChanges(ResourcePath path)	Discards any local changes for a path.
void	discardOverrides(ResourcePath path)	Discards changes made to overridden resources
Map<ResourceId,Resource>	getAllResources()	Get a List of all resources in this project and all parent projects.
List<ChangeOperation>	getChanges()
Collection<ChangeOperation>	getConflicts(Collection<ChangeOperation> changes)
String	getDefiningProject(ResourcePath path)	Return the project name where the given ResourcePath is actually defined.
List<NamedManifest>	getInheritanceStructure()
ResourceCollectionManifest	getManifest()	Get the ResourceCollectionManifest for this Project.
String	getName()
Optional<Resource>	getResource(ResourcePath path)	Finds the resource at the given path, using an effective view of the resources in this project chain.
List<Snapshot>	getSnapshots()	Gets the snapshots from the effective resource collection, in reverse order of inheritance (leaf collection first)
boolean	isChanged(ResourcePath path)
boolean	isConflict(ResourcePath path)
boolean	isInherited(ResourcePath path)
boolean	isLocal(ResourcePath path)
boolean	isOverridable(ResourcePath path)
boolean	isOverridden(ResourcePath path)
void	modifyResource(Resource resource)	Modify an existing resource.
void	notifyPushComplete(List<ChangeOperation> changesPushed)	Notify that a push was completed.
void	removeAllProjectResourceListeners()	Removes all ResourceListeners.
void	renameResource(ResourcePath sourcePath, String newName)	Rename a resource at the given path.
protected ResourceCollectionDiff.EffectiveDiff	updateEffectiveState()	Call this after one or more resources or manifests have been changed.

Methods inherited from class com.inductiveautomation.ignition.common.resourcecollection.AbstractResourceCollection

addResourceListener, getEffectiveResources, getListeners, getResources, getResourcesOfType, hasResourcesOfType, removeResourceListener, updateEffectiveState

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.designer.project.DesignableProject

createOrModify, createOrModify, createResourceSafe, createResourceSafe, deleteResource, getLocalResource, getLocalResource, isProtected, modifyResource, modifyResourceIfLocal, renameResource, setProtected

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

addResourceListener, getDescription, getParent, getResource, getResources, getResourcesOfType, getSingletonResource, getTitle, hasResourcesOfType, isEnabled, isInheritable, isRunnable, removeResourceListener

Constructor Details

DesignerProjectTreeImpl

public DesignerProjectTreeImpl(ResourceCollection project)

Method Details

updateEffectiveState

protected ResourceCollectionDiff.EffectiveDiff updateEffectiveState()

Description copied from class: AbstractResourceCollection

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

Overrides:

updateEffectiveState in class AbstractResourceCollection

getResource

public Optional<Resource> getResource(ResourcePath path)

Description copied from interface: ResourceCollection

Finds the resource at the given path, using an effective view of the resources in this project chain.

Specified by:

getResource in interface ResourceCollection

Parameters:

path - Not null

Returns:

The matching project resource or empty if not found.

browse

public Optional<List<Resource>> browse(@Nonnull
 ResourcePath path)

Specified by:

browse in interface ResourceCollection

Parameters:

path - the resourcePath of the folder to browse

Returns:

an empty optional if the given path was not found or is not browseable, otherwise its direct children

modifyResource

public void modifyResource(Resource resource)
                    throws ResourceNotFoundException

Description copied from interface: DesignableProject

Modify an existing resource. Must already exist as a local resource, otherwise this will throw an ResourceNotFoundException

Specified by:

modifyResource in interface DesignableProject

Throws:

ResourceNotFoundException

createResource

public void createResource(Resource resource)
                    throws ResourceNamingException

Description copied from interface: DesignableProject

Create a new resource.

Will also create any folders needed along the new resource's path.

Specified by:

createResource in interface DesignableProject

Throws:

NameInUseException - if the resource's name is is already in use by a local sibling.

ResourceNamingException

deleteResource

public void deleteResource(ResourcePath path)
                    throws ResourceNotFoundException

Description copied from interface: DesignableProject

Delete the resource at a given path.

Specified by:

deleteResource in interface DesignableProject

Throws:

ResourceNotFoundException

renameResource

public void renameResource(ResourcePath sourcePath,
 String newName)
                    throws ResourceNamingException

Description copied from interface: DesignableProject

Rename a resource at the given path.

Specified by:

renameResource in interface DesignableProject

Throws:

ResourceNamingException

discardChanges

public boolean discardChanges(ResourcePath path)

Description copied from interface: DesignableProject

Discards any local changes for a path.

Specified by:

discardChanges in interface DesignableProject

Returns:

true if there were changes to discard, false if there were no changes in the first place.

discardOverrides

public void discardOverrides(ResourcePath path)

Description copied from interface: DesignableProject

Discards changes made to overridden resources

Specified by:

discardOverrides in interface DesignableProject

isLocal

public boolean isLocal(ResourcePath path)

Specified by:

isLocal in interface DesignableProject

Returns:

True if there is a project resource at the given path that defined in the local project.

isChanged

public boolean isChanged(ResourcePath path)

Specified by:

isChanged in interface DesignableProject

Returns:

True if there is a resource at the given path that has been locally altered.

isInherited

public boolean isInherited(ResourcePath path)

Specified by:

isInherited in interface DesignableProject

Returns:

True if there is a resource at the given path that is inherited from a parent project

isOverridable

public boolean isOverridable(ResourcePath path)

Specified by:

isOverridable in interface DesignableProject

Returns:

False if there is an inherited resource that does not allow overrides. True otherwise.

isOverridden

public boolean isOverridden(ResourcePath path)

Specified by:

isOverridden in interface DesignableProject

Returns:

True if there is a resource at the given path defined in this project that is overriding a resource from a parent project at the same path.

isConflict

public boolean isConflict(ResourcePath path)

Specified by:

isConflict in interface DesignableProject

Returns:

True if there is a resource with a conflicting (but differently cased) name at the given path - see NameCollisionException

getDefiningProject

public String getDefiningProject(ResourcePath path)

Description copied from interface: DesignableProject

Return the project name where the given ResourcePath is actually defined.

Specified by:

getDefiningProject in interface DesignableProject

getName

public String getName()

Specified by:

getName in interface ResourceCollection

Returns:

the name of this Project.

getManifest

public ResourceCollectionManifest getManifest()

Description copied from interface: ResourceCollection

Get the ResourceCollectionManifest for this Project.

Specified by:

getManifest in interface ResourceCollection

Returns:

the ResourceCollectionManifest for this Project.

getInheritanceStructure

public List<NamedManifest> getInheritanceStructure()

Specified by:

getInheritanceStructure in interface ResourceCollection

Returns:

A list of all the resource collection manifests that comprise the inheritance chain of this collection. This list is ordered in ascending inheritance order, from leaf first to super-most collection last.

getAllResources

public Map<ResourceId,Resource> getAllResources()

Description copied from interface: ResourceCollection

Get a List of all resources in this project and all parent projects.

This includes resources belonging to parent projects in the inheritance chain if this is a "stack" of projects. This means that there may be multiple resources for any given ResourcePath.

This project instance may not contain all resources that exist for the project on disk, depending on the ResourceFilter used to load it.

Specified by:

getAllResources in interface ResourceCollection

Returns:

all the resources belonging to this project instance, including resources from parent projects.

getSnapshots

public List<Snapshot> getSnapshots()

Description copied from interface: ResourceCollection

Gets the snapshots from the effective resource collection, in reverse order of inheritance (leaf collection first)

Specified by:

getSnapshots in interface ResourceCollection

Returns:

A list of Snapshots, one per resource collection represented in the effective project.

getChanges

public List<ChangeOperation> getChanges()

Specified by:

getChanges in interface DesignableProject

Returns:

The change operations that have occurred on this project since loaded or since the last applyChanges

getConflicts

public Collection<ChangeOperation> getConflicts(Collection<ChangeOperation> changes)

Specified by:

getConflicts in interface DesignableProject

Parameters:

changes - Diff operations applicable to the local project

Returns:

a collection of the change operations that conflict with local changes

applyChange

public void applyChange(ProjectChange change)

Apply a set of changes, pulled from the gateway, to this project. For local resources, this will update the "local" reference of the ResourceTreeNode so that further calls to get snapshots will reflect these changes.

Parameters:

change - The change collection to apply.

notifyPushComplete

public void notifyPushComplete(List<ChangeOperation> changesPushed)

Notify that a push was completed. This is a signal to the project that some resources may no longer be considered modified.

Parameters:

changesPushed - A list of the changes that were pushed, which may be a subset of those retrieved via getChanges()

removeAllProjectResourceListeners

public void removeAllProjectResourceListeners()

Removes all ResourceListeners. This should only be used when shutting down a designer instance or switching the projects in the designer.