org.kuali.student.datadictionary.mojo

Class KSDictionaryDocMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.kuali.student.common.mojo.AbstractKSMojo

org.kuali.student.datadictionary.mojo.KSDictionaryDocMojo

All Implemented Interfaces:

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

public class KSDictionaryDocMojo
extends AbstractKSMojo

Mojo for generating a formatted view of the data dictionary.

 <plugin>
 		<groupId>org.kuali.maven.plugins</groupId>
      <artifactId>maven-kscontractdoc-plugin</artifactId>
      <execution>
      	<id>generate-dictionary-documentation</id>
          <phase>site</phase>
          <goals>
          	<goal>ksdictionarydoc</goal>                            
          </goals>
          <configuration>
           <supportFiles>
           	<supportFile>commonApplicationContext.xml</supportFile>
           </supportFiles>
          </configuration>
     </execution>
 </plugin>
  
 

We use the QDox model to read the class files present and to enumerate the list of Message Structure objects. Then for each identified type we build an application context that includes the union of that file plus any files specified using the configuration parameter. Errors with an application context are detected and logged but will not break the plugin's ability to generate the other files.

Field Summary

Fields inherited from class org.kuali.student.common.mojo.AbstractKSMojo

localPackages

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

ROLE

Constructor Summary

Constructors

Constructor and Description
KSDictionaryDocMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
File	getHtmlDirectory()
org.apache.maven.project.MavenProject	getProject()
List<String>	getSupportFiles()
void	setHtmlDirectory(File htmlDirectory)
void	setSupportFiles(List<String> supportFiles)
void	setTestDictionaryFile(String dictionaryFile) Used for testing to hard code a single dictionary file to use.

Methods inherited from class org.kuali.student.common.mojo.AbstractKSMojo

getContextSourceDirs, getModel, getSourceDirs, setContextSourceDirs, setSourceDirs, validate

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

Constructor Detail

KSDictionaryDocMojo

public KSDictionaryDocMojo()

Method Detail

setHtmlDirectory

public void setHtmlDirectory(File htmlDirectory)

getHtmlDirectory

public File getHtmlDirectory()

getProject

public org.apache.maven.project.MavenProject getProject()

getSupportFiles

public List<String> getSupportFiles()

setSupportFiles

public void setSupportFiles(List<String> supportFiles)

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

setTestDictionaryFile

public void setTestDictionaryFile(String dictionaryFile)

Used for testing to hard code a single dictionary file to use.

Parameters:

string -