org.fusesource.mvnplugins.graph

Class ProjectMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.fusesource.mvnplugins.graph.ProjectMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

ProjectReportMojo, ReactorMojo

public class ProjectMojo
extends org.apache.maven.plugin.AbstractMojo

Generates a graph image of the dependencies of the project based on graphviz 'dot' files. Alternatively, generates TGF (trivial graph format) files. To automatically generate images from dot files, you must have graphviz tools installed.

Author:

Hiram Chirino

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.artifact.resolver.ArtifactCollector	artifactCollector
protected org.apache.maven.artifact.factory.ArtifactFactory	artifactFactory
protected org.apache.maven.artifact.metadata.ArtifactMetadataSource	artifactMetadataSource
protected org.apache.maven.artifact.resolver.ArtifactResolver	artifactResolver
protected boolean	cascade If true then the 'test scope' and 'optional' attributes are cascaded down to the dependencies of the original node.
protected java.lang.String	direction The direction that the graph will be laid out in.
protected java.lang.String	excludeArtifactIds A comma separated list of artifact Ids to exclude.
protected java.lang.String	excludeGroupIds A comma separated list of group Ids to exclude.
protected boolean	hideExternal If set to true if dependencies external to the reactor project should be hidden.
protected boolean	hideGroupId If set to true then the group id label will not be drawn.
protected boolean	hideOmitted If set to true, omitted dependencies will not be drawn.
protected boolean	hideOptional If set to true optional dependencies are not drawn.
protected boolean	hidePoms If set to true pom dependencies are not drawn.
protected java.lang.String	hideScopes A comma separated list of scopes.
protected boolean	hideTransitive If set to true then dependencies not explicitly defined in the projects pom will not be drawn.
protected boolean	hideType If set to true then the module type label will not be drawn.
protected boolean	hideVersion If set to true then the version label will not be drawn.
protected java.lang.String	includeArtifactIds A comma separated list of artifact Ids to include.
protected java.lang.String	includeGroupIds A comma separated list of group Ids to include.
protected boolean	keepDot If set to true then the intermediate dot file will not be deleted.
protected java.lang.String	label The label for the graph.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository
protected org.apache.maven.project.MavenProject	project
protected java.io.File	target The file the diagram will be written to.
protected org.apache.maven.shared.dependency.tree.DependencyTreeBuilder	treeBuilder

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
ProjectMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	collectProjects(java.util.ArrayList<org.apache.maven.project.MavenProject> projects)
void	execute()
java.io.File	getTarget()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

project

protected org.apache.maven.project.MavenProject project

Since:

1.0

localRepository

protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

Since:

1.0

artifactResolver

protected org.apache.maven.artifact.resolver.ArtifactResolver artifactResolver

Since:

1.0

artifactFactory

protected org.apache.maven.artifact.factory.ArtifactFactory artifactFactory

Since:

1.0

artifactMetadataSource

protected org.apache.maven.artifact.metadata.ArtifactMetadataSource artifactMetadataSource

Since:

1.0

artifactCollector

protected org.apache.maven.artifact.resolver.ArtifactCollector artifactCollector

treeBuilder

protected org.apache.maven.shared.dependency.tree.DependencyTreeBuilder treeBuilder

Since:

1.0

target

protected java.io.File target

The file the diagram will be written to. Must use a file extension that the dot command supports or just the '.dot' or '.tgf' extension.

hideOmitted

protected boolean hideOmitted

If set to true, omitted dependencies will not be drawn. Dependencies are marked as omitted if it would result in a resolution conflict.

hideOptional

protected boolean hideOptional

If set to true optional dependencies are not drawn.

hideExternal

protected boolean hideExternal

If set to true if dependencies external to the reactor project should be hidden.

hidePoms

protected boolean hidePoms

If set to true pom dependencies are not drawn.

hideScopes

protected java.lang.String hideScopes

A comma separated list of scopes. Dependencies which match the specified scopes will not be drawn.
For example: runtime,test

hideTransitive

protected boolean hideTransitive

If set to true then dependencies not explicitly defined in the projects pom will not be drawn.

hideVersion

protected boolean hideVersion

If set to true then the version label will not be drawn.

hideGroupId

protected boolean hideGroupId

If set to true then the group id label will not be drawn.

includeGroupIds

protected java.lang.String includeGroupIds

A comma separated list of group Ids to include. If this parameter is specified, any group Id not matching will be excluded. A '*' can be appended only at the end to match subgroups
For example: com.apache,java.net.*

excludeGroupIds

protected java.lang.String excludeGroupIds

A comma separated list of group Ids to exclude. A '*' can be appended only at the end to match subgroups
For example: com.apache,java.net.*

includeArtifactIds

protected java.lang.String includeArtifactIds

A comma separated list of artifact Ids to include. If this parameter is specified, any artifact Id not matching will be excluded. A '*' can be appended only at the end to match subgroups
For example: commons-*

excludeArtifactIds

protected java.lang.String excludeArtifactIds

A comma separated list of artifact Ids to exclude. A '*' can be appended only at the end to match subgroups
For example: commons-*

hideType

protected boolean hideType

If set to true then the module type label will not be drawn.

keepDot

protected boolean keepDot

If set to true then the intermediate dot file will not be deleted.

label

protected java.lang.String label

The label for the graph.

cascade

protected boolean cascade

If true then the 'test scope' and 'optional' attributes are cascaded down to the dependencies of the original node.

direction

protected java.lang.String direction

The direction that the graph will be laid out in. it can be one of the following values:
TB LR BT RL
top to bottom, from left to right, from bottom to top, and from right to left, respectively


Constructor Detail

ProjectMojo

public ProjectMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

collectProjects

protected void collectProjects(java.util.ArrayList<org.apache.maven.project.MavenProject> projects)

getTarget

public java.io.File getTarget()