org.azyva.dragom.model.config.impl.simple

Class SimpleNodeConfig

java.lang.Object

org.azyva.dragom.model.config.impl.simple.SimpleNodeConfig

All Implemented Interfaces:

org.azyva.dragom.model.config.MutableNodeConfig, org.azyva.dragom.model.config.NodeConfig

Direct Known Subclasses:

SimpleClassificationNodeConfig, SimpleModuleConfig

public abstract class SimpleNodeConfig
extends Object
implements org.azyva.dragom.model.config.NodeConfig, org.azyva.dragom.model.config.MutableNodeConfig

Simple implementation for NodeConfig and MutableNodeConfig.

Author:

David Raymond

See Also:

org.azyva.dragom.model.config.impl.simple

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	indNew Indicates that the SimpleNodeConfig is new and has not been finalized yet.
protected int	revision Unique revision number to manage optimistic locking (see OptimisticLockHandle).

Method Summary

Modifier and Type	Method and Description
protected void	checkOptimisticLock(org.azyva.dragom.model.config.OptimisticLockHandle optimisticLockHandle, boolean indRequireLock) Check whether the OptimisticLockHandle corresponds to the current state of the data it represents.
org.azyva.dragom.model.config.OptimisticLockHandle	createOptimisticLockHandle(boolean indLock)
void	delete()
protected void	extractNodeConfigTransferObject(org.azyva.dragom.model.config.NodeConfigTransferObject nodeConfigTransferObject, org.azyva.dragom.model.config.OptimisticLockHandle optimisticLockHandle) Called by subclasses to extract the data from a NodeConfigTransferObject and set them within the SimpleNodeConfig.
List<org.azyva.dragom.model.config.PluginDefConfig>	getListPluginDefConfig()
List<org.azyva.dragom.model.config.PropertyDefConfig>	getListPropertyDefConfig()
String	getName()
org.azyva.dragom.model.config.NodeConfigTransferObject	getNodeConfigTransferObject(org.azyva.dragom.model.config.OptimisticLockHandle optimisticLockHandle)
org.azyva.dragom.model.config.PluginDefConfig	getPluginDefConfig(Class<? extends org.azyva.dragom.model.plugin.NodePlugin> classNodePlugin, String pluginId)
org.azyva.dragom.model.config.PropertyDefConfig	getPropertyDefConfig(String name)
boolean	isNew()
boolean	isOptimisticLockValid(org.azyva.dragom.model.config.OptimisticLockHandle optimisticLockHandle)
boolean	isPluginDefConfigExists(Class<? extends org.azyva.dragom.model.plugin.NodePlugin> classNodePlugin, String pluginId)
boolean	isPropertyExists(String name)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.azyva.dragom.model.config.MutableNodeConfig

setNodeConfigTransferObject

Methods inherited from interface org.azyva.dragom.model.config.NodeConfig

getNodeType

Field Detail

indNew

protected boolean indNew

Indicates that the SimpleNodeConfig is new and has not been finalized yet. This is the state in which it is after having been created using the create methods of SimpleConfig or SimpleClassificationNodeConfig.

revision

protected int revision

Unique revision number to manage optimistic locking (see OptimisticLockHandle).

Starts at since 0 within OptimisticLockHandle means not locked.

Method Detail

getName

public String getName()

Specified by:

getName in interface org.azyva.dragom.model.config.NodeConfig

getPropertyDefConfig

public org.azyva.dragom.model.config.PropertyDefConfig getPropertyDefConfig(String name)

Specified by:

getPropertyDefConfig in interface org.azyva.dragom.model.config.NodeConfig

isPropertyExists

public boolean isPropertyExists(String name)

Specified by:

isPropertyExists in interface org.azyva.dragom.model.config.NodeConfig

getListPropertyDefConfig

public List<org.azyva.dragom.model.config.PropertyDefConfig> getListPropertyDefConfig()

Specified by:

getListPropertyDefConfig in interface org.azyva.dragom.model.config.NodeConfig

getPluginDefConfig

public org.azyva.dragom.model.config.PluginDefConfig getPluginDefConfig(Class<? extends org.azyva.dragom.model.plugin.NodePlugin> classNodePlugin,
                                                                        String pluginId)

Specified by:

getPluginDefConfig in interface org.azyva.dragom.model.config.NodeConfig

isPluginDefConfigExists

public boolean isPluginDefConfigExists(Class<? extends org.azyva.dragom.model.plugin.NodePlugin> classNodePlugin,
                                       String pluginId)

Specified by:

isPluginDefConfigExists in interface org.azyva.dragom.model.config.NodeConfig

getListPluginDefConfig

public List<org.azyva.dragom.model.config.PluginDefConfig> getListPluginDefConfig()

Specified by:

getListPluginDefConfig in interface org.azyva.dragom.model.config.NodeConfig

isNew

public boolean isNew()

Specified by:

isNew in interface org.azyva.dragom.model.config.MutableNodeConfig

checkOptimisticLock

protected void checkOptimisticLock(org.azyva.dragom.model.config.OptimisticLockHandle optimisticLockHandle,
                                   boolean indRequireLock)

Check whether the OptimisticLockHandle corresponds to the current state of the data it represents.

If optimisticLockHandle is null, nothing is done.

If optimisticLockHandle is not null and is locked (OptimisticLockHandle.isLocked()), its state must correspond to the state of the data it represents, otherwise OptimisticLockException is thrown.

If optimisticLockHandle is not null and is not locked, it is simply locked to the current state of the data, unless indRequireLock, in which case an exception is thrown.

Parameters:

optimisticLockHandle - OptimisticLockHandle. Can be null.

indRequireLock - Indicates if it is required that the OptimisticLockHandle be locked.

createOptimisticLockHandle

public org.azyva.dragom.model.config.OptimisticLockHandle createOptimisticLockHandle(boolean indLock)

Specified by:

createOptimisticLockHandle in interface org.azyva.dragom.model.config.MutableNodeConfig

isOptimisticLockValid

public boolean isOptimisticLockValid(org.azyva.dragom.model.config.OptimisticLockHandle optimisticLockHandle)

Specified by:

isOptimisticLockValid in interface org.azyva.dragom.model.config.MutableNodeConfig

getNodeConfigTransferObject

public org.azyva.dragom.model.config.NodeConfigTransferObject getNodeConfigTransferObject(org.azyva.dragom.model.config.OptimisticLockHandle optimisticLockHandle)
                                                                                   throws org.azyva.dragom.model.config.OptimisticLockException

Specified by:

getNodeConfigTransferObject in interface org.azyva.dragom.model.config.MutableNodeConfig

Throws:

org.azyva.dragom.model.config.OptimisticLockException

extractNodeConfigTransferObject

protected void extractNodeConfigTransferObject(org.azyva.dragom.model.config.NodeConfigTransferObject nodeConfigTransferObject,
                                               org.azyva.dragom.model.config.OptimisticLockHandle optimisticLockHandle)
                                        throws org.azyva.dragom.model.config.DuplicateNodeException

Called by subclasses to extract the data from a NodeConfigTransferObject and set them within the SimpleNodeConfig.

Uses the indNew variable, but does not reset it. It is intended to be reset by the subclass caller method, MutableNodeConfig.setNodeConfigTransferObject(org.azyva.dragom.model.config.NodeConfigTransferObject, org.azyva.dragom.model.config.OptimisticLockHandle).

The reason for not directly implementing MutableNodeConfig.setNodeConfigValueTransferObject is that subclasses can have other tasks to perform.

If optimisticLockHandle is null, no optimistic lock is managed.

If optimisticLockHandle is not null, it must be locked (OptimisticLockHandle.isLocked()) and its state must correspond to the state of the data it represents, otherwise OptimisticLockException is thrown. The state of the OptimisticLockHandle is updated to the new revision of the SimpleNodeConfig.

Parameters:

nodeConfigTransferObject - NodeConfigTransferObject.

optimisticLockHandle - OptimisticLockHandle. Can be null.

Throws:

org.azyva.dragom.model.config.OptimisticLockException - Can be thrown only if optimisticLockHandle is not null. This is a RuntimeException that may be of interest to the caller.

org.azyva.dragom.model.config.DuplicateNodeException - When the new configuration data would introduce a duplicate MutableNode within the parent. This is a RuntimeException that may be of interest to the caller.

delete

public void delete()

Specified by:

delete in interface org.azyva.dragom.model.config.MutableNodeConfig