Package com.inductiveautomation.ignition.common.project

Class RuntimeProject

java.lang.Object

com.inductiveautomation.ignition.common.project.AbstractProject

com.inductiveautomation.ignition.common.project.RuntimeProject

All Implemented Interfaces:

Project, Serializable

public class RuntimeProject
extends AbstractProject

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RuntimeProject.DiffException
static class	RuntimeProject.EffectiveProjectSnapshot	An EffectiveProjectSnapshot is a ProjectSnapshot of a project and its effective resource set plus additional information about what its hierarchy was at the time the snapshot was made.
static class	RuntimeProject.GsonAdapter
static class	RuntimeProject.RuntimeProjectBuilder

Field Summary

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

GLOBAL_PROJECT_NAME, PIPELINE_PROJECT_NAME, PROJECT_NAME_PATTERN, SFC_PROJECT_NAME

Constructor Summary

Constructors

Constructor	Description
RuntimeProject(List<NamedManifest> projects, Map<ProjectResourceId,ProjectResource> resources)

Method Summary

Modifier and Type	Method	Description
ProjectDiff.EffectiveDiff	applyChange(List<ProjectDiff.AbsoluteDiff> diffs)
Optional<List<ProjectResource>>	browse(ResourcePath path)
static RuntimeProject	createAndValidate(List<NamedManifest> projects, Map<ProjectResourceId,ProjectResource> resources)	Create a RuntimeProject from projects and resources and validate it before returning.
ProjectDiff.EffectiveDiff	diff(RuntimeProject.EffectiveProjectSnapshot effectiveSnapshot)	Get a ProjectDiff generated by diffing an RuntimeProject.EffectiveProjectSnapshot from getEffectiveSnapshot() with the current *effective* state of the project.
Map<ProjectResourceId,ProjectResource>	getAllResources()	Get a List of all resources in this project and all parent projects.
RuntimeProject.EffectiveProjectSnapshot	getEffectiveSnapshot()	Get an RuntimeProject.EffectiveProjectSnapshot.
ProjectManifest	getManifest()	Get the ProjectManifest for this Project.
String	getName()
List<NamedManifest>	getProjectInheritanceStructure()
List<ProjectSnapshot>	getProjectSnapshots()	Gets the snapshots from the effective project, in order of project inheritance (leaf project last)
Optional<ProjectResource>	getResource(ResourcePath path)	Finds the resource at the given path, using an effective view of the resources in this project chain.
Optional<RuntimeProject>	validate()	Validate this RuntimeProject by following inheritable project projects until a root is found.
RuntimeProject	validateOrThrow()	Validate this RuntimeProject by following inheritable parent projects until a root is found.

Methods inherited from class com.inductiveautomation.ignition.common.project.AbstractProject

addProjectResourceListener, getEffectiveResources, getListeners, getResources, getResourcesOfType, hasResourcesOfType, removeProjectResourceListener, 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.common.project.Project

getDescription, getParent, getResource, getSingletonResource, getTitle, isEnabled, isInheritable, isRunnable

Constructor Details

RuntimeProject

public RuntimeProject(@Nonnull
 List<NamedManifest> projects,
 @Nonnull
 Map<ProjectResourceId,ProjectResource> resources)

Method Details

createAndValidate

public static RuntimeProject createAndValidate(@Nonnull
 List<NamedManifest> projects,
 @Nonnull
 Map<ProjectResourceId,ProjectResource> resources)
                                        throws ProjectInvalidException

Create a RuntimeProject from projects and resources and validate it before returning.

Parameters:

projects - the list of NamedManifests that comprise the project hierarchy.

resources - the ProjectResources for this project.

Returns:

a validated RuntimeProject.

Throws:

ProjectInvalidException - if validation fails.

See Also:

• validateOrThrow()

validate

public Optional<RuntimeProject> validate()

Validate this RuntimeProject by following inheritable project projects until a root is found.

Returns:

an Optional containing this RuntimeProject instance if it was validated.

validateOrThrow

public RuntimeProject validateOrThrow()
                               throws ProjectInvalidException

Validate this RuntimeProject by following inheritable parent projects until a root is found.

Returns:

this RuntimeProject instance.

Throws:

ProjectInvalidException - if the project hierarchy is invalid.

getName

public String getName()

Returns:

the name of this Project.

getManifest

public ProjectManifest getManifest()

Description copied from interface: Project

Get the ProjectManifest for this Project.

Returns:

the ProjectManifest for this Project.

getProjectInheritanceStructure

public List<NamedManifest> getProjectInheritanceStructure()

Returns:

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

getAllResources

public Map<ProjectResourceId,ProjectResource> getAllResources()

Description copied from interface: Project

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.

Returns:

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

getResource

public Optional<ProjectResource> getResource(ResourcePath path)

Description copied from interface: Project

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

Parameters:

path - Not null

Returns:

The matching project resource or empty if not found.

browse

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

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

getProjectSnapshots

public List<ProjectSnapshot> getProjectSnapshots()

Description copied from interface: Project

Gets the snapshots from the effective project, in order of project inheritance (leaf project last)

Returns:

A list of ProjectSnapshots, one per project represented in the effective project.

applyChange

public ProjectDiff.EffectiveDiff applyChange(List<ProjectDiff.AbsoluteDiff> diffs)

getEffectiveSnapshot

public RuntimeProject.EffectiveProjectSnapshot getEffectiveSnapshot()

Get an RuntimeProject.EffectiveProjectSnapshot.

This snapshot can be used with diff(EffectiveProjectSnapshot) at some later time to obtain a ProjectDiff describing what has changed.

Returns:

an effective RuntimeProject.EffectiveProjectSnapshot.

diff

public ProjectDiff.EffectiveDiff diff(RuntimeProject.EffectiveProjectSnapshot effectiveSnapshot)
                               throws RuntimeProject.DiffException

Get a ProjectDiff generated by diffing an RuntimeProject.EffectiveProjectSnapshot from getEffectiveSnapshot() with the current *effective* state of the project.

Parameters:

effectiveSnapshot - an RuntimeProject.EffectiveProjectSnapshot from getEffectiveSnapshot().

Returns:

a ProjectDiff.

Throws:

RuntimeProject.DiffException - if the diff cannot be completed because the project hierarchy changed since the snapshot was taken.