Package com.inductiveautomation.ignition.common.project

Class ChangeOperation

java.lang.Object

com.inductiveautomation.ignition.common.project.ChangeOperation

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ChangeOperation.ManifestChangeOperation, ChangeOperation.ResourceChangeOperation

public abstract class ChangeOperation
extends Object
implements Serializable

Modifications to projects are defined as a series of ChangeOperations. The following operations can be performed:

• Create - a new resource is added.
• Delete - a resource is deleted
• Modify - a resource is modified.
• Manifest - the project manifest has been modified. The manifest is a description of the project- its name, parent, etc.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChangeOperation.CreateResourceOperation
static class	ChangeOperation.DeleteResourceOperation
static class	ChangeOperation.ManifestChangeOperation
static class	ChangeOperation.ModifyResourceOperation
static enum	ChangeOperation.OperationType
static class	ChangeOperation.ResourceChangeOperation

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator<ChangeOperation>	CHANGE_SORT	Comparator that orders ChangeOperations in the correct order to submit to a push

Method Summary

Modifier and Type	Method	Description
static Set<ProjectResourceId>	changeOpsToIdSet(List<ChangeOperation> changes)	Grabs all the project resource ids for the given changes and returns them as a set.
ChangeOperation.OperationType	getOperationType()
abstract String	getProjectName()
static ProjectResource	getResourceFromChange(ChangeOperation op)
static ProjectResourceId	getResourceIdFromChange(ChangeOperation op)
static ChangeOperation.CreateResourceOperation	newCreateOp(ProjectResource resource)	Create a new ChangeOperation.CreateResourceOperation for newly created resource.
static ChangeOperation.DeleteResourceOperation	newDeleteOp(ResourceSignature resourceSignature)	Create a new ChangeOperation.DeleteResourceOperation for the resource identified by resourceSignature.
static ChangeOperation.ManifestChangeOperation	newManifestChangeOp(String projectName, ProjectManifest manifest)	Create a new ChangeOperation.ManifestChangeOperation for the project identified by projectName.
static ChangeOperation.ManifestChangeOperation	newManifestChangeOp(String projectName, ProjectManifest manifest, int baseHashCode)	Create a new ChangeOperation.ManifestChangeOperation for the project identified by projectName.
static ChangeOperation.ModifyResourceOperation	newModifyOp(ProjectResource resource, ResourceSignature baseSignature)	Create a new ChangeOperation.ModifyResourceOperation for a resource that has been modified.

Methods inherited from class java.lang.Object

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

Field Details

CHANGE_SORT

public static final Comparator<ChangeOperation> CHANGE_SORT

Comparator that orders ChangeOperations in the correct order to submit to a push

Method Details

getOperationType

@Nonnull
public ChangeOperation.OperationType getOperationType()

Returns:

the ChangeOperation.OperationType.

getProjectName

public abstract String getProjectName()

Returns:

the name of the project the target of this operation belongs to.

newCreateOp

public static ChangeOperation.CreateResourceOperation newCreateOp(ProjectResource resource)

Create a new ChangeOperation.CreateResourceOperation for newly created resource.

Parameters:

resource - the ProjectResource that was created. Not null.

Returns:

a ChangeOperation.CreateResourceOperation for resource. Not null.

newModifyOp

public static ChangeOperation.ModifyResourceOperation newModifyOp(ProjectResource resource,
 ResourceSignature baseSignature)

Create a new ChangeOperation.ModifyResourceOperation for a resource that has been modified.

Modify operations are expressed relative to a base ResourceSignature.

Parameters:

resource - the modified ProjectResource.

baseSignature - the base ResourceSignature.

Returns:

a ChangeOperation.ModifyResourceOperation for resource.

newDeleteOp

public static ChangeOperation.DeleteResourceOperation newDeleteOp(ResourceSignature resourceSignature)

Create a new ChangeOperation.DeleteResourceOperation for the resource identified by resourceSignature.

Parameters:

resourceSignature - the ResourceSignature.

Returns:

a ChangeOperation.DeleteResourceOperation for resourceId.

newManifestChangeOp

public static ChangeOperation.ManifestChangeOperation newManifestChangeOp(String projectName,
 ProjectManifest manifest)

Create a new ChangeOperation.ManifestChangeOperation for the project identified by projectName.

Parameters:

projectName - the name of the project with an updated manifest.

Returns:

a ChangeOperation.ManifestChangeOperation for projectName.

newManifestChangeOp

public static ChangeOperation.ManifestChangeOperation newManifestChangeOp(String projectName,
 ProjectManifest manifest,
 int baseHashCode)

Create a new ChangeOperation.ManifestChangeOperation for the project identified by projectName.

Parameters:

projectName - the name of the project with an updated manifest.

manifest - the updated ProjectManifest.

baseHashCode - the hashcode of the original ProjectManifest (i.e. the unmodified manifest from the snapshot)

Returns:

a ChangeOperation.ManifestChangeOperation for projectName.

getResourceIdFromChange

@Nullable
public static ProjectResourceId getResourceIdFromChange(ChangeOperation op)

Returns:

the ProjectResourceId of op if it is a ChangeOperation.ResourceChangeOperation, otherwise null.

getResourceFromChange

@Nullable
public static ProjectResource getResourceFromChange(ChangeOperation op)

Returns:

the resource from the op if it is a ChangeOperation.CreateResourceOperation or ChangeOperation.ModifyResourceOperation, otherwise null

changeOpsToIdSet

public static Set<ProjectResourceId> changeOpsToIdSet(List<ChangeOperation> changes)

Grabs all the project resource ids for the given changes and returns them as a set.