com.inductiveautomation.ignition.designer

Class DesignerContextImpl.DesignerProjectHolderImpl

java.lang.Object

com.inductiveautomation.ignition.client.model.DefaultProjectHolder

com.inductiveautomation.ignition.designer.DesignerContextImpl.DesignerProjectHolderImpl

All Implemented Interfaces:

ResourceLockManager, ProjectHolder, DesignerProjectContext

Enclosing class:

DesignerContextImpl

public class DesignerContextImpl.DesignerProjectHolderImpl
extends DefaultProjectHolder
implements DesignerProjectContext

Field Summary

Fields inherited from class com.inductiveautomation.ignition.client.model.DefaultProjectHolder

listeners, project

Constructor Summary

Constructors

Constructor and Description
DesignerProjectHolderImpl(Project project, ProjectScope scope)

Method Summary

Modifier and Type	Method and Description
java.util.UUID	addFolder(long newResourceId, java.lang.String moduleId, int scope, java.lang.String folderName, java.util.UUID parent) Adds a new folder under the given parent.
boolean	canEditResourceProtection() Checks whether or not the current logged in user can edit the protection bits of project resources.
boolean	checkLockLostState(long resourceId) Silently checks to see if the resource ID is in the resource locks.
void	deleteResource(long resourceId) Removes the resource from the current project
protected void	fireResourceModified(ProjectResource resource, ProjectChangeListener.ResourceModification mod)
int	getClientScopedUnsavedChangeCount() Counts the number of open or updated locks this designer owns for client scoped resources.
protected DesignerContextImpl.LockInfo	getLockInfo(long resourceId)
protected java.util.Map<java.lang.Long,DesignerContextImpl.LockInfo>	getResourceLocks()
ProjectScope	getScope()
int	getUnsavedChangeCount() Counts the number of open or updated locks this designer owns.
protected boolean	giveResourceProtectionOption(ProjectResource resource) This method shows a dialog that allows the user to changed the protection status of the resource or do nothing, or write once.
boolean	hasLock(long resourceId) Checks to see if the given lock is currently held, which means either: it has been obtained but not released (it is open) It has been obtained, modified, and then released, but a save operation has not occurred.
boolean	isLockModified(long resourceId) Returns true if the lock has been obtained and updated
boolean	isLockOpen(long resourceId) Returns true if the lock has been obtained and not released
boolean	isResourceProtected(long resourceId, boolean quiet)
protected void	lockLog(java.lang.String action, long lock)
void	moveResource(long resourceId, java.util.UUID newParent) Moves the resource to a new parent.
long	newResourceId() Creates and obtains the lock for a new resource id
void	releaseAllLocks()
void	releaseLock(long resourceId) Designer elements should call this function when they are done with the resource that they obtained a lock for.
boolean	requestLock(long resourceId) Requests the lock for the given resource.
boolean	requestLockQuietly(long resourceId) Just like requestLock, except that if the lock isn't obtained, no error message is displayed.
protected boolean	resourceExists(long resourceId)
void	saveFinished(Project diff) After the project is saved, the Gateway returns a diff which includes the changes other designers made.
void	structuredRename(long resourceId, java.lang.String newName) Attempts to rename the given project resource, respecting the requirement that the name be unique amongst siblings (with respect to the folder structure)
void	synchLocks() Attempts to re-obtain all locks that this resource lock manager currently has.
void	update(Project diff, boolean dirty)
boolean	updateLock(long resourceId) Designer elements should call this function when they have actually updated the resource with the given ID.
void	updateResource(long id, byte[] data) Convenience call that updates only the serialized bytes of a project resource, leaving all other parameters intact.
void	updateResource(ProjectResource resource) Adds or updates the given project resource

Methods inherited from class com.inductiveautomation.ignition.client.model.DefaultProjectHolder

addProjectChangeListener, applyDiff, fireProjectChanged, getProject, removeProjectChangeListener, setProject

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.client.model.ProjectHolder

addProjectChangeListener, applyDiff, getProject, removeProjectChangeListener

Constructor Detail

DesignerProjectHolderImpl

public DesignerProjectHolderImpl(Project project,
                                 ProjectScope scope)

Method Detail

getScope

public ProjectScope getScope()

Specified by:

getScope in interface DesignerProjectContext

newResourceId

public long newResourceId()
                   throws java.lang.Exception

Description copied from interface: ResourceLockManager

Creates and obtains the lock for a new resource id

Specified by:

newResourceId in interface ResourceLockManager

Throws:

java.lang.Exception

getUnsavedChangeCount

public int getUnsavedChangeCount()

Counts the number of open or updated locks this designer owns.

getClientScopedUnsavedChangeCount

public int getClientScopedUnsavedChangeCount()

Counts the number of open or updated locks this designer owns for client scoped resources.

Returns:

int - count of unsaved client scoped resources

getResourceLocks

protected java.util.Map<java.lang.Long,DesignerContextImpl.LockInfo> getResourceLocks()

checkLockLostState

public boolean checkLockLostState(long resourceId)

Silently checks to see if the resource ID is in the resource locks. If the resource is not in resourceLocks or if it is found in the lostResourceLocks, false is returned. Otherwise true is returned.

Parameters:

resourceId - the ProjectResource.resourceId we want to check

Returns:

false if not in the resourceLocks map or is in the lostResourceLocks set. true otherwise

updateLock

public boolean updateLock(long resourceId)

Description copied from interface: ResourceLockManager

Designer elements should call this function when they have actually updated the resource with the given ID. Note that you MUST have the lock before updating the resource!

Specified by:

updateLock in interface ResourceLockManager

Returns:

True if we still have the lock.

lockLog

protected void lockLog(java.lang.String action,
                       long lock)

getLockInfo

protected DesignerContextImpl.LockInfo getLockInfo(long resourceId)

hasLock

public boolean hasLock(long resourceId)

Description copied from interface: ResourceLockManager

Checks to see if the given lock is currently held, which means either:

1. it has been obtained but not released (it is open)
2. It has been obtained, modified, and then released, but a save operation has not occurred.

Specified by:

hasLock in interface ResourceLockManager

isLockModified

public boolean isLockModified(long resourceId)

Description copied from interface: ResourceLockManager

Returns true if the lock has been obtained and updated

Specified by:

isLockModified in interface ResourceLockManager

isLockOpen

public boolean isLockOpen(long resourceId)

Description copied from interface: ResourceLockManager

Returns true if the lock has been obtained and not released

Specified by:

isLockOpen in interface ResourceLockManager

releaseLock

public void releaseLock(long resourceId)

Designer elements should call this function when they are done with the resource that they obtained a lock for. Note that you must have the lock for the resource before releasing it!

Specified by:

releaseLock in interface ResourceLockManager

synchLocks

public void synchLocks()

Description copied from interface: ResourceLockManager

Attempts to re-obtain all locks that this resource lock manager currently has. Used in situations where the gateway has lost our lock set. (re-connections)

Specified by:

synchLocks in interface ResourceLockManager

releaseAllLocks

public void releaseAllLocks()

requestLock

public boolean requestLock(long resourceId)

Requests the lock for the given resource. If the lock is obtained, true is returned. If the lock isn't able to be obtained, false is returned.

Specified by:

requestLock in interface ResourceLockManager

requestLockQuietly

public boolean requestLockQuietly(long resourceId)

Description copied from interface: ResourceLockManager

Just like requestLock, except that if the lock isn't obtained, no error message is displayed.

Specified by:

requestLockQuietly in interface ResourceLockManager

canEditResourceProtection

public boolean canEditResourceProtection()
                                  throws GatewayException

Description copied from interface: DesignerProjectContext

Checks whether or not the current logged in user can edit the protection bits of project resources. Note: RPC call to gateway.

Specified by:

canEditResourceProtection in interface DesignerProjectContext

Throws:

GatewayException

resourceExists

protected boolean resourceExists(long resourceId)

giveResourceProtectionOption

protected boolean giveResourceProtectionOption(ProjectResource resource)

This method shows a dialog that allows the user to changed the protection status of the resource or do nothing, or write once. Also, the resource is set protected if the user chooses that dialog

saveFinished

public void saveFinished(Project diff)

After the project is saved, the Gateway returns a diff which includes the changes other designers made. This will apply that diff to our copy of the project.

update

public void update(Project diff,
                   boolean dirty)

fireResourceModified

protected void fireResourceModified(ProjectResource resource,
                                    ProjectChangeListener.ResourceModification mod)

updateResource

public void updateResource(long id,
                           byte[] data)

Description copied from interface: DesignerProjectContext

Convenience call that updates only the serialized bytes of a project resource, leaving all other parameters intact.

Specified by:

updateResource in interface DesignerProjectContext

isResourceProtected

public boolean isResourceProtected(long resourceId,
                                   boolean quiet)

updateResource

public void updateResource(ProjectResource resource)

Description copied from interface: DesignerProjectContext

Adds or updates the given project resource

Specified by:

updateResource in interface DesignerProjectContext

deleteResource

public void deleteResource(long resourceId)

Description copied from interface: DesignerProjectContext

Removes the resource from the current project

Specified by:

deleteResource in interface DesignerProjectContext

structuredRename

public void structuredRename(long resourceId,
                             java.lang.String newName)
                      throws java.lang.IllegalArgumentException

Description copied from interface: DesignerProjectContext

Attempts to rename the given project resource, respecting the requirement that the name be unique amongst siblings (with respect to the folder structure)

Specified by:

structuredRename in interface DesignerProjectContext

Parameters:

resourceId - The ID of the resource to rename

newName - The new name

Throws:

java.lang.IllegalArgumentException - Thrown when the name is not unique.

moveResource

public void moveResource(long resourceId,
                         java.util.UUID newParent)

Description copied from interface: DesignerProjectContext

Moves the resource to a new parent. If the name is already in use by a child of that parent, the resource will be renamed automatically.

Specified by:

moveResource in interface DesignerProjectContext

addFolder

public java.util.UUID addFolder(long newResourceId,
                                java.lang.String moduleId,
                                int scope,
                                java.lang.String folderName,
                                java.util.UUID parent)

Description copied from interface: DesignerProjectContext

Adds a new folder under the given parent. If there is already a child with the given name, the name will be automatically modified

Specified by:

addFolder in interface DesignerProjectContext

Returns:

the UUID of the new folder