org.azyva.dragom.model.impl.simple

Class SimpleModel

java.lang.Object

org.azyva.dragom.model.impl.simple.SimpleModel

All Implemented Interfaces:

org.azyva.dragom.model.Model, org.azyva.dragom.model.ModelNodeBuilderFactory, org.azyva.dragom.model.MutableModel

public class SimpleModel
extends Object
implements org.azyva.dragom.model.Model, org.azyva.dragom.model.ModelNodeBuilderFactory, org.azyva.dragom.model.MutableModel

Simple implementation of a Model and MutableModel based on Config and optionnally MutableConfig.

In addition to Config, initialization Properties can be provided to an instance of SimpleModel in order to override properties defined within Config. This allows customizing a Model locally, such as specifying a different base URL for an SCM repository.

Initialization Properties that have the "org.azyva.dragom.model-property." prefix are considered first, with inheritance. Only if the property is not found among initialization Properties will real Model properties be considered. Note that properties defined in such a way cannot be defined only for a specific node, contrary to real Model properties.

The fact that initialization Properties can be specified does not violate the general principle that a Model is static since initialization Properties are not meant to change between tool invocations.

Note that NodePlugin's provided by Model can use runtime properties provided by RuntimePropertiesPlugin since the behavior of NodePlugin's can be tool-invocation-specific.

Author:

David Raymond

See Also:

org.azyva.dragom.model.impl.simple

Constructor Summary

Constructors

Constructor and Description
SimpleModel(org.azyva.dragom.model.config.Config config, Properties propertiesInit) Constructor.

Method Summary

Modifier and Type	Method and Description
org.azyva.dragom.model.ClassificationNodeBuilder	createClassificationNodeBuilder()
org.azyva.dragom.model.ModuleBuilder	createModuleBuilder()
org.azyva.dragom.model.MutableClassificationNode	createMutableClassificationNodeRoot()
org.azyva.dragom.model.Module	findModuleByArtifactGroupId(org.azyva.dragom.model.ArtifactGroupId artifactGroupId) Finds and returns the Module whose build produces an ArtifactGroupId.
org.azyva.dragom.model.ClassificationNode	getClassificationNode(org.azyva.dragom.model.NodePath nodePath) At each step while following the path of {SimpleClassificationNode}, SimpleClassificationNode.getSimpleClassificationNodeChildDynamic(java.lang.String) is used so that new SimpleClassificationNode can be dynamically created if required.
org.azyva.dragom.model.ClassificationNode	getClassificationNodeRoot()
Properties	getInitProperties() Returns the initialization properties that were used when creating this SimpleModel.
org.azyva.dragom.model.Module	getModule(org.azyva.dragom.model.NodePath nodePath) This method uses getClassificationNode(org.azyva.dragom.model.NodePath) to get the parent SimpleClassificationNode.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleModel

public SimpleModel(org.azyva.dragom.model.config.Config config,
                   Properties propertiesInit)

Constructor.

This is the only way to instantiate a new SimpleModel. However, once instantiated, a SimpleModel can be completed dynamically using ModelNodeBuilderFactory methods to create new SimpleNode's.

Parameters:

config - Config.

propertiesInit - Initialization properties.

Method Detail

getInitProperties

public Properties getInitProperties()

Returns the initialization properties that were used when creating this SimpleModel.

This method is not part of Model and is therefore intended to be used by the other classes that make up the SimpleModel, namely SimpleNode.

Initialization properties should be considered read-only.

Returns:

Initialization Properties.

getClassificationNodeRoot

public org.azyva.dragom.model.ClassificationNode getClassificationNodeRoot()

Specified by:

getClassificationNodeRoot in interface org.azyva.dragom.model.Model

Returns:

Root ClassificationNode.

getClassificationNode

public org.azyva.dragom.model.ClassificationNode getClassificationNode(org.azyva.dragom.model.NodePath nodePath)

At each step while following the path of {SimpleClassificationNode}, SimpleClassificationNode.getSimpleClassificationNodeChildDynamic(java.lang.String) is used so that new SimpleClassificationNode can be dynamically created if required.

Specified by:

getClassificationNode in interface org.azyva.dragom.model.Model

Parameters:

nodePath - NodePath of the ClassificationNode to return. Must be partial.

Returns:

ClassificationNode. null if no ClassificationNode corresponding to the specified NodePath exist.

getModule

public org.azyva.dragom.model.Module getModule(org.azyva.dragom.model.NodePath nodePath)

This method uses getClassificationNode(org.azyva.dragom.model.NodePath) to get the parent SimpleClassificationNode. It then uses SimpleClassificationNode.getSimpleModuleChildDynamic(java.lang.String) to get the requested SimpleModule which therefore can be dynamically created if required.

Specified by:

getModule in interface org.azyva.dragom.model.Model

Parameters:

nodePath - NodePath of the Module to return. Must not be partial.

Returns:

Module. null if no Module corresponding to the specified NodePath exist.

findModuleByArtifactGroupId

public org.azyva.dragom.model.Module findModuleByArtifactGroupId(org.azyva.dragom.model.ArtifactGroupId artifactGroupId)

Finds and returns the Module whose build produces an ArtifactGroupId.

First, FindModuleByArtifactGroupIdModuleNodeVisitor is used to find a Module among those that are already created.

If an existing Module could not be found, FindModuleThroughClassificationNodeByArtifactGroupIdClassificationNodeVisitor is used to ask the exising ClassificationNode's about such a Module.

In all cases the mapping between the ArtifactGroupId and the found Module is cached and used to speed up subsequent requests for the same ArtifactGroupId.

Specified by:

findModuleByArtifactGroupId in interface org.azyva.dragom.model.Model

Parameters:

artifactGroupId - ArtifactGroupId for which to find a Module.

Returns:

Module. null if no Module found.

createClassificationNodeBuilder

public org.azyva.dragom.model.ClassificationNodeBuilder createClassificationNodeBuilder()

Specified by:

createClassificationNodeBuilder in interface org.azyva.dragom.model.ModelNodeBuilderFactory

createModuleBuilder

public org.azyva.dragom.model.ModuleBuilder createModuleBuilder()

Specified by:

createModuleBuilder in interface org.azyva.dragom.model.ModelNodeBuilderFactory

createMutableClassificationNodeRoot

public org.azyva.dragom.model.MutableClassificationNode createMutableClassificationNodeRoot()

Specified by:

createMutableClassificationNodeRoot in interface org.azyva.dragom.model.MutableModel