org.azyva.dragom.model.config

Interface NodeConfig

All Known Subinterfaces:

ClassificationNodeConfig, ModuleConfig, MutableClassificationNodeConfig, MutableModuleConfig, MutableNodeConfig

public interface NodeConfig

Configuration of a Node.

A NodeConfig can represent a Module or a ClassificationNode, as specified by getNodeType(). If a NodeConfig represents a Module, it will also implement ModuleConfig. If a NodeConfig represents a ClassificationNode, it will also implement ClassificationNode.

Author:

David Raymond

See Also:

Config

Method Summary

Modifier and Type	Method and Description
List<PluginDefConfig>	getListPluginDefConfig() Returns a List of all the PluginDefConfig's.
List<PropertyDefConfig>	getListPropertyDefConfig() Returns a List of all the PropertyDefConfig's.
String	getName()
NodeType	getNodeType()
PluginDefConfig	getPluginDefConfig(Class<? extends NodePlugin> classNodePlugin, String pluginId) Returns a PluginDefConfig.
PropertyDefConfig	getPropertyDefConfig(String name) Returns a PropertyDefConfig.
boolean	isPluginDefConfigExists(Class<? extends NodePlugin> classNodePlugin, String pluginId) Verifies if a PluginDefConfig exists.
boolean	isPropertyExists(String name) Verifies if a PropertyDefConfig exists.

Method Detail

getName

String getName()

Returns:

Name.

getNodeType

NodeType getNodeType()

Returns:

NodeType.

getPropertyDefConfig

PropertyDefConfig getPropertyDefConfig(String name)

Returns a PropertyDefConfig.

If the PropertyDefConfig exists but is defined with the value field set to null, a PropertyDefConfig is returned (instead of returning null).

Parameters:

name - Name of the PropertyDefConfig.

Returns:

PropertyDefConfig. null if the PropertyDefConfig does not exist.

isPropertyExists

boolean isPropertyExists(String name)

Verifies if a PropertyDefConfig exists.

If the PropertyDefConfig exists but is defined with the value field set to null, true is returned.

Returns true if an only if getPropertyDefConfig(java.lang.String) does not return null.

Parameters:

name - Name of the PropertyDefConfig.

Returns:

Indicates if the PropertyDefConfig exists.

getListPropertyDefConfig

List<PropertyDefConfig> getListPropertyDefConfig()

Returns a List of all the PropertyDefConfig's.

If no PropertyDefConfig is defined for the NodeConfig, an empty List is returned (as opposed to null).

The order of the PropertyDefConfig is generally expected to be as defined in the underlying storage for the configuration, hence the List return type. But no particular order is actually guaranteed.

An implementations should not return a List that could allow the caller to modify its internal data structures. Either a copy or an unmodifiable List view should be returned. Caller should not expect the returned List to be modifiable, even if the intent is not modify the internal structure of the implementation.

Returns:

See description.

getPluginDefConfig

PluginDefConfig getPluginDefConfig(Class<? extends NodePlugin> classNodePlugin,
                                   String pluginId)

Returns a PluginDefConfig.

If the PluginDefConfig exists but is defined with the pluginClass field set to null, a PluginDefConfig is returned (instead of returning null).

Parameters:

classNodePlugin - Class of the NodePlugin interface.

pluginId - Plugin ID to distinguish between multiple instances of the same plugin. Can be null to get a PluginDefConfig whose field pluginId is null.

Returns:

PluginDefConfig. null if the PluginDefConfig does not exist.

isPluginDefConfigExists

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

Verifies if a PluginDefConfig exists.

If the PluginDefConfig exists but is defined with the pluginClass field set to null, true is returned.

Returns true if an only if getPluginDefConfig(java.lang.Class<? extends org.azyva.dragom.model.plugin.NodePlugin>, java.lang.String) does not return null.

Parameters:

classNodePlugin - Class of the NodePlugin interface.

pluginId - Plugin ID to distinguish between multiple instances of the same plugin. Can be null to get a PluginDefConfig whose field pluginId is null.

Returns:

Indicates if the PluginDefConfig exists.

getListPluginDefConfig

List<PluginDefConfig> getListPluginDefConfig()

Returns a List of all the PluginDefConfig's.

If no PluginDefConfig is defined for the NodeConfig, an empty Set is returned (as opposed to null).

The order of the PluginDefConfig is generally expected to be as defined in the underlying storage for the configuration, hence the List return type. But no particular order is actually guaranteed.

An implementations should not return a List that could allow the caller to modify its internal data structures. Either a copy or an unmodifiable List view should be returned. Caller should not expect the returned List to be modifiable, even if the intent is not modify the internal structure of the implementation.

Returns:

See description.