org.azyva.dragom.model

Interface Node

All Known Subinterfaces:

ClassificationNode, Module, MutableClassificationNode, MutableModule, MutableNode

public interface Node

Represents a node at runtime.

Two type of Node's exist each represented by a different sub-interfaces:

• ClassificationNode
• Module

Author:

David Raymond

Method Summary

Modifier and Type	Method and Description
ClassificationNode	getClassificationNodeParent()
List<String>	getListPluginId(Class<? extends NodePlugin> classNodePlugin) Returns the List of plugin IDs of all NodePlugin's of the specified class available.
Model	getModel()
String	getName()
NodePath	getNodePath()
<NodePluginInterface extends NodePlugin> NodePluginInterface	getNodePlugin(Class<NodePluginInterface> classNodePlugin, String pluginId) Gets the specified NodePlugin for this Node.
NodeType	getNodeType()
String	getProperty(String name) Returns the value of a property.
boolean	isCreatedDynamically()
boolean	isNodePluginExists(Class<? extends NodePlugin> classNodePlugin, String pluginId) Verifies if a NodePlugin exists for this Node, without instantiating it.
void	raiseNodeEvent(NodeEvent nodeEvent) Raises a NodeEvent.
<NodeEventClass extends NodeEvent> void	registerListener(NodeEventListener<NodeEventClass> nodeEventListener, boolean indChildrenAlso) Registers a NodeEventListener.

Method Detail

getClassificationNodeParent

ClassificationNode getClassificationNodeParent()

Returns:

Parent ClassificationNode. null in the case of the root ClassificationNode.

getName

String getName()

Returns:

Name. This is essentially equivalent to getNodeConfig().getName() when a NodeConfig is available.

getModel

Model getModel()

Returns:

Model.

getNodeType

NodeType getNodeType()

Returns:

NodeType.

getNodePath

NodePath getNodePath()

Returns:

NodePath. null for the root ClassificationNode.

getProperty

String getProperty(String name)

Returns the value of a property.

Parameters:

name - Name of the property.

Returns:

Value of the property.

getNodePlugin

<NodePluginInterface extends NodePlugin> NodePluginInterface getNodePlugin(Class<NodePluginInterface> classNodePlugin,
                                                                           String pluginId)

Gets the specified NodePlugin for this Node.

The NodePlugin must exist. isNodePluginExists(java.lang.Class<? extends org.azyva.dragom.model.plugin.NodePlugin>, java.lang.String) can be used to verify if a NodePlugin exists before getting it.

Type Parameters:

NodePluginInterface - NodePlugin interface.

Parameters:

classNodePlugin - Class of the NodePlugin.

pluginId - Plugin ID to distinguish between multiple instances of the same NodePlugin.

Returns:

NodePlugin. The type is as specified by classNodePlugin.

isNodePluginExists

boolean isNodePluginExists(Class<? extends NodePlugin> classNodePlugin,
                           String pluginId)

Verifies if a NodePlugin exists for this Node, without instantiating it.

Parameters:

classNodePlugin - Class of the NodePlugin.

pluginId - Plugin ID to distinguish between multiple instances of the same NodePlugin.

Returns:

Indicates if the NodePlugin exists.

getListPluginId

List<String> getListPluginId(Class<? extends NodePlugin> classNodePlugin)

Returns the List of plugin IDs of all NodePlugin's of the specified class available.

Parameters:

classNodePlugin - Class of the NodePlugin.

Returns:

List of plugin IDs.

registerListener

<NodeEventClass extends NodeEvent> void registerListener(NodeEventListener<NodeEventClass> nodeEventListener,
                                                         boolean indChildrenAlso)

Registers a NodeEventListener.

The NodeEventListener is registered within the Node, and thus within the Model. It is also possible to register NodeEventListener's in the ExecContext.

Type Parameters:

NodeEventClass - NodeEvent class.

Parameters:

nodeEventListener - NodeEventListener.

indChildrenAlso - Indicates if NodeEvent raised on children should be dispatched to the NodeEventListener.

raiseNodeEvent

void raiseNodeEvent(NodeEvent nodeEvent)

Raises a NodeEvent.

The NodeEvent is dispatched to all registered NodeEventListener's interested in it.

NodeEventListener's registered in the ExecContext using EventPlugin.registerListener(org.azyva.dragom.model.Node, org.azyva.dragom.model.event.NodeEventListener<NodeEventClass>, boolean, boolean) are also considered.

The NodeEvent sub-interface (ModuleEvent or ClassificationNodeEvent) must match the type of Node.

The NodeEvent must be dispatched on NodeEvent.getNode().

Parameters:

nodeEvent - NodeEvent.

isCreatedDynamically

boolean isCreatedDynamically()

Returns:

Indicates if the Node was created dynamically. This generally means that it is not based on a NodeConfig and is inferred from some external system.