org.azyva.dragom.job

Class ReferenceGraphReport

java.lang.Object

org.azyva.dragom.job.RootModuleVersionJobAbstractImpl

org.azyva.dragom.job.ReferenceGraphReport

public class ReferenceGraphReport
extends RootModuleVersionJobAbstractImpl

Produces a report about a ReferenceGraph.

Author:

David Raymond

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReferenceGraphReport.ModuleFilter
static class	ReferenceGraphReport.OutputFormat
static class	ReferenceGraphReport.ReferenceGraphMode

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
ReferenceGraphReport(List<org.azyva.dragom.model.ModuleVersion> listModuleVersionRoot, ReferenceGraphReport.OutputFormat outputFormat) Constructor.

Method Summary

Modifier and Type	Method and Description
void	includeModules(ReferenceGraphReport.ModuleFilter moduleFilter) Indicates to include the Module's and their Version's in the report.
void	includeMostRecentStaticVersionInScm() Indicates to include the most recent static Version in the SCM for each Module.
void	includeMostRecentVersionInReferenceGraph() Indicates to include the most recent Version in the reference graph for each Module.
void	includeReferenceGraph(ReferenceGraphReport.ReferenceGraphMode referenceGraphMode) Indicates to include the reference graph in the report.
void	includeReferencePaths() Indicates to include the ReferencePath literals for each ModuleVersion.
void	performJob() Main method for performing the job.
void	setOutputFilePath(Path pathOutputFile) Sets the output file Path.
void	setOutputWriter(Writer writerOutput) Sets the output Writer.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceGraphReport

public ReferenceGraphReport(List<org.azyva.dragom.model.ModuleVersion> listModuleVersionRoot,
                            ReferenceGraphReport.OutputFormat outputFormat)

Constructor.

Parameters:

listModuleVersionRoot - List of root ModuleVersions's.

outputFormat - OutputFormat.

Method Detail

setOutputFilePath

public void setOutputFilePath(Path pathOutputFile)

Sets the output file Path.

Either the output file Path or the output Writer can be set, but not both.

Parameters:

pathOutputFile - Output file Path.

setOutputWriter

public void setOutputWriter(Writer writerOutput)

Sets the output Writer.

Either the output file Path or the output Writer can be set, but not both.

Parameters:

writerOutput - Output Writer.

includeReferenceGraph

public void includeReferenceGraph(ReferenceGraphReport.ReferenceGraphMode referenceGraphMode)

Indicates to include the reference graph in the report.

Parameters:

referenceGraphMode - ReferenceGraphMode.

includeModules

public void includeModules(ReferenceGraphReport.ModuleFilter moduleFilter)

Indicates to include the Module's and their Version's in the report.

Parameters:

moduleFilter - ModuleFilter.

includeMostRecentVersionInReferenceGraph

public void includeMostRecentVersionInReferenceGraph()

Indicates to include the most recent Version in the reference graph for each Module.

includeMostRecentStaticVersionInScm

public void includeMostRecentStaticVersionInScm()

Indicates to include the most recent static Version in the SCM for each Module.

Also implies including most recent Version in the reference graph for each Module (see includeMostRecentVersionInReferenceGraph().

includeReferencePaths

public void includeReferencePaths()

Indicates to include the ReferencePath literals for each ModuleVersion.

performJob

public void performJob()

Main method for performing the job.

Overrides:

performJob in class RootModuleVersionJobAbstractImpl