org.azyva.dragom.job

Class BuildReferenceGraph

java.lang.Object

org.azyva.dragom.job.RootModuleVersionJobAbstractImpl

org.azyva.dragom.job.BuildReferenceGraph

public class BuildReferenceGraph
extends RootModuleVersionJobAbstractImpl

The principle of operation of this class is to traverse reference graphs in the standard way using a List of root ModuleVersion's and a ReferencePathMatcher to build the ReferenceGraph.

This is implemented in a way that is similar to other job classes, but it is only intended to be used internally as building a ReferenceGraph is not really useful in itself. If can be useful however to produce a ReferenceGraph report, as ReferenceGraphReport does.

Author:

David Raymond

Nested Class Summary

Nested classes/interfaces inherited from class org.azyva.dragom.job.RootModuleVersionJobAbstractImpl

RootModuleVersionJobAbstractImpl.UnsyncChangesBehavior

Field Summary

Fields inherited from class org.azyva.dragom.job.RootModuleVersionJobAbstractImpl

indAvoidReentry, indDepthFirst, indHandleDynamicVersion, indHandleStaticVersion, indListModuleVersionRootChanged, listActionsPerformed, listModuleVersionRoot, moduleReentryAvoider, MSG_PATTERN_KEY_ACTIONS_PERFORMED, MSG_PATTERN_KEY_CANNOT_PROCEED_WITH_UNSYNC_LOCAL_CHANGES, MSG_PATTERN_KEY_CONFLICTS_WHILE_UPDATING, MSG_PATTERN_KEY_DO_YOU_WANT_TO_UPDATE_UNSYNC_REMOTE_CHANGES, MSG_PATTERN_KEY_INITIATING_TRAVERSAL_REFERENCE_GRAPH_ROOT_MODULE_VERSION, MSG_PATTERN_KEY_MODULE_VERSION_ALREADY_PROCESSED, MSG_PATTERN_KEY_MULTIPLE_WORKSPACE_DIRECTORIES_FOR_MODULE, MSG_PATTERN_KEY_NO_ACTIONS_PERFORMED, MSG_PATTERN_KEY_ROOT_MODULE_VERSION_NOT_KNOWN, MSG_PATTERN_KEY_TRAVERSAL_REFERENCE_GRAPH_ROOT_MODULE_VERSION_COMPLETED, MSG_PATTERN_KEY_UPDATE_CHANGED_ROOT_MODULE_VERSION, MSG_PATTERN_KEY_UPDATE_ROOT_MODULE_VERSION_TO_DEFAULT, MSG_PATTERN_KEY_UPDATE_ROOT_MODULE_VERSION_TO_WORKSPACE_DIRECTORY_VERSION, MSG_PATTERN_KEY_UPDATING, MSG_PATTERN_KEY_VERSION_DOES_NOT_EXIST, MSG_PATTERN_KEY_VISITING_LEAF_MODULE_VERSION, MSG_PATTERN_KEY_VISITING_LEAF_REFERENCE_MATCHED, referencePath, resourceBundle, RUNTIME_PROPERTY_PROJECT_CODE, RUNTIME_PROPERTY_SYNC_WORKSPACE_DIR, unsyncChangesBehaviorLocal, unsyncChangesBehaviorRemote

Constructor Summary

Constructors

Constructor and Description
BuildReferenceGraph(org.azyva.dragom.reference.ReferenceGraph referenceGraph, List<org.azyva.dragom.model.ModuleVersion> listModuleVersionRoot) Constructor.

Method Summary

Modifier and Type	Method and Description
org.azyva.dragom.reference.ReferenceGraph	getReferenceGraph()
void	setupReferencePathMatcherForProjectCode() Augment the visibility of this method since it can be useful to caller.
protected boolean	visitMatchedModuleVersion(org.azyva.dragom.reference.Reference reference) This method will be called only for matched ModuleVersion's.

Methods inherited from class org.azyva.dragom.job.RootModuleVersionJobAbstractImpl

afterIterateListModuleVersionRoot, beforeIterateListModuleVersionRoot, beforeValidateListModuleVersionRoot, getProjectCode, getReferencePathMatcher, isListModuleVersionRootChanged, iterateListModuleVersionRoot, performJob, setIndAvoidReentry, setIndDepthFirst, setIndHandleDynamicVersion, setIndHandleStaticVersion, setIndListModuleVersionRootChanged, setReferencePathMatcherProvided, setUnsyncChangesBehaviorLocal, setUnsyncChangesBehaviorRemote, validateListModuleVersionRoot, visitModuleVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildReferenceGraph

public BuildReferenceGraph(org.azyva.dragom.reference.ReferenceGraph referenceGraph,
                           List<org.azyva.dragom.model.ModuleVersion> listModuleVersionRoot)

Constructor.

Parameters:

referenceGraph - ReferenceGraph that will be built or completed. Can be null in which case a new initially empty SimpleReferenceGraph is used.

listModuleVersionRoot - List of root ModuleVersion's on which to initiate the traversal of the reference graphs.

Method Detail

setupReferencePathMatcherForProjectCode

public void setupReferencePathMatcherForProjectCode()

Augment the visibility of this method since it can be useful to caller.

Overrides:

setupReferencePathMatcherForProjectCode in class RootModuleVersionJobAbstractImpl

getReferenceGraph

public org.azyva.dragom.reference.ReferenceGraph getReferenceGraph()

Returns:

ReferenceGraph that was provided to or created by the constructor.

visitMatchedModuleVersion

protected boolean visitMatchedModuleVersion(org.azyva.dragom.reference.Reference reference)

This method will be called only for matched ModuleVersion's. But the ReferenceGraph needs to include the ReferencePath's leading to them. It must also identify those ModuleVersion's which are the roots. This is all taken care of by ReferenceGraph.addMatchedReferencePath(org.azyva.dragom.reference.ReferencePath).

Overrides:

visitMatchedModuleVersion in class RootModuleVersionJobAbstractImpl

Parameters:

reference - Reference to the matched ModuleVersion.

Returns:

Indicates if children must be visited. true is returned.