Package com.inductiveautomation.ignition.designer.project

Interface DesignableProject

All Superinterfaces:

Project, java.io.Serializable

All Known Implementing Classes:

DesignerProjectTreeImpl

public interface DesignableProject
extends Project

Extension of Project with additional functionality to support the Designer's need to model the project as a tree of resources which can be mutated and staged for push and pull operations.

Field Summary

Fields inherited from interface com.inductiveautomation.ignition.common.project.Project

GLOBAL_PROJECT_NAME, PIPELINE_PROJECT_NAME, PROJECT_NAME_PATTERN, SFC_PROJECT_NAME

Method Summary

Modifier and Type	Method	Description
default void	createOrModify(ProjectResource resource)	Create the given resource if one doesn't already exist, otherwise, modify it.
default void	createOrModify(ResourcePath path, java.util.function.Consumer<ProjectResourceBuilder> builderConsumer)	Create the given resource if one doesn't already exist, otherwise, modify it.
void	createResource(ProjectResource resource)	Create a new resource.
default ProjectResource	createResourceSafe(ResourcePath path, java.util.function.Consumer<ProjectResourceBuilder> builderConsumer)	Create a new resource and add it at the given path.
default ProjectResource	createResourceSafe(ResourcePath path, java.util.function.Consumer<ProjectResourceBuilder> builderConsumer, java.lang.String nameFormat)	Create a new resource and add it at the given path.
default void	deleteResource(ProjectResourceId id)	Delete the resource with the given id.
void	deleteResource(ResourcePath path)	Delete the resource at a given path.
boolean	discardChanges(ResourcePath path)	Discards any local changes for a path.
java.util.List<ChangeOperation>	getChanges()
java.util.Collection<ChangeOperation>	getConflicts(java.util.Collection<ChangeOperation> changes)
java.lang.String	getDefiningProject(ResourcePath path)	Return the project name where the given ResourcePath is actually defined.
default java.util.Optional<ProjectResource>	getLocalResource(ProjectResourceId id)	Get a resource, but only if it is a locally defined resource.
default java.util.Optional<ProjectResource>	getLocalResource(ResourcePath path)	Get a resource, but only if it is a locally defined resource.
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(ProjectResource resource)	Modify an existing resource.
default void	modifyResource(ResourcePath path, java.util.function.Consumer<ProjectResourceBuilder> builderConsumer)	Modify an existing resource, if it exists.
default boolean	modifyResourceIfLocal(ResourcePath path, java.util.function.Consumer<ProjectResourceBuilder> builderConsumer)	Modify an existing resource, if it exists.
default void	renameResource(ProjectResourceId id, java.lang.String newName)	Rename a resource at the given path.
void	renameResource(ResourcePath path, java.lang.String newName)	Rename a resource at the given path.

Methods inherited from interface com.inductiveautomation.ignition.common.project.Project

addProjectResourceListener, browse, getAllResources, getDescription, getManifest, getName, getParent, getProjectInheritanceStructure, getProjectSnapshots, getResource, getResource, getResources, getResourcesOfType, getSingletonResource, getTitle, hasResourcesOfType, isEnabled, isInheritable, isRunnable, removeProjectResourceListener

Method Detail

getLocalResource

default java.util.Optional<ProjectResource> getLocalResource(ProjectResourceId id)

Get a resource, but only if it is a locally defined resource.

getLocalResource

default java.util.Optional<ProjectResource> getLocalResource(ResourcePath path)

Get a resource, but only if it is a locally defined resource.

createResource

void createResource(ProjectResource resource)
             throws ResourceNamingException

Create a new resource.

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

Throws:

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

ResourceNamingException

createResourceSafe

default ProjectResource createResourceSafe(ResourcePath path,
                                           java.util.function.Consumer<ProjectResourceBuilder> builderConsumer)

Create a new resource and add it at the given path. If there is already a resource at the given path, then the new resource will be given a new name like "OriginalName (1)"

Parameters:

path - The desired path for the new resource. Any needed folders along the path will be created.

builderConsumer - Callback for setting the details of the new resource. The correct project name and resource path will already be set automatically.

Returns:

The resource that was created

createResourceSafe

default ProjectResource createResourceSafe(ResourcePath path,
                                           java.util.function.Consumer<ProjectResourceBuilder> builderConsumer,
                                           java.lang.String nameFormat)

Create a new resource and add it at the given path. If there is already a resource at the given path, then the new resource will be given a new name.

Parameters:

path - The desired path for the new resource

builderConsumer - Callback for setting the details of the new resource. The correct project name and resource path will already be set automatically.

nameFormat - String format for appending a number to the end of the existing name, like " (%s)"

Returns:

The resource that was created

modifyResource

void modifyResource(ProjectResource resource)
             throws ResourceNotFoundException

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

Throws:

ResourceNotFoundException

modifyResource

default void modifyResource(ResourcePath path,
                            java.util.function.Consumer<ProjectResourceBuilder> builderConsumer)
                     throws ResourceNotFoundException

Modify an existing resource, if it exists. If not, will throw an ResourceNotFoundException

Throws:

ResourceNotFoundException

modifyResourceIfLocal

default boolean modifyResourceIfLocal(ResourcePath path,
                                      java.util.function.Consumer<ProjectResourceBuilder> builderConsumer)
                               throws ResourceNotFoundException

Modify an existing resource, if it exists. If not, do nothing.

Returns:

True if a local resource was found and modified.

Throws:

ResourceNotFoundException

createOrModify

default void createOrModify(ProjectResource resource)

Create the given resource if one doesn't already exist, otherwise, modify it.

createOrModify

default void createOrModify(ResourcePath path,
                            java.util.function.Consumer<ProjectResourceBuilder> builderConsumer)

Create the given resource if one doesn't already exist, otherwise, modify it.

deleteResource

default void deleteResource(ProjectResourceId id)
                     throws ResourceNotFoundException

Delete the resource with the given id.

Throws:

ResourceNotFoundException

deleteResource

void deleteResource(ResourcePath path)
             throws ResourceNotFoundException

Delete the resource at a given path.

Throws:

ResourceNotFoundException

renameResource

default void renameResource(ProjectResourceId id,
                            java.lang.String newName)
                     throws ResourceNamingException

Rename a resource at the given path.

Throws:

ResourceNamingException

renameResource

void renameResource(ResourcePath path,
                    java.lang.String newName)
             throws ResourceNamingException

Rename a resource at the given path.

Throws:

ResourceNamingException

discardChanges

boolean discardChanges(ResourcePath path)

Discards any local changes for a path.

Returns:

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

isLocal

boolean isLocal(ResourcePath path)

Returns:

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

isChanged

boolean isChanged(ResourcePath path)

Returns:

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

isInherited

boolean isInherited(ResourcePath path)

Returns:

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

isOverridable

boolean isOverridable(ResourcePath path)

Returns:

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

isOverridden

boolean isOverridden(ResourcePath path)

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

boolean isConflict(ResourcePath path)

Returns:

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

getDefiningProject

java.lang.String getDefiningProject(ResourcePath path)

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

getChanges

java.util.List<ChangeOperation> getChanges()

Returns:

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

getConflicts

java.util.Collection<ChangeOperation> getConflicts(java.util.Collection<ChangeOperation> changes)

Parameters:

changes - Diff operations applicable to the local project

Returns:

a collection of the change operations from diff that conflict with local changes