Package org.nuiton.jaxx.plugin

Class GenerateHelpSearchMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.jaxx.plugin.AbstractJaxxMojo

org.nuiton.jaxx.plugin.AbstractGenerateHelpMojo

org.nuiton.jaxx.plugin.GenerateHelpSearchMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.nuiton.plugin.Plugin, org.nuiton.plugin.PluginWithEncoding

@Mojo(name="generate-help-search",
      defaultPhase=PROCESS_SOURCES,
      requiresProject=true,
      requiresDependencyResolution=COMPILE)
@Execute(goal="generate-help-files")
public class GenerateHelpSearchMojo
extends AbstractGenerateHelpMojo

Generate the javax search index help for your project. The current files should be generated always in a generated directory and not in your src directories (this is mainly binary files not to be stored in scm system)...

Since:

2.0.0

Author:

Tony Chemit - chemit@codelutin.com

Nested Class Summary

Nested classes/interfaces inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo

AbstractJaxxMojo.JaxxFileUpdater

Nested classes/interfaces inherited from interface org.nuiton.plugin.Plugin

org.nuiton.plugin.Plugin.InitState, org.nuiton.plugin.Plugin.Packaging

Field Summary

Fields

Modifier and Type	Field	Description
protected File	inputHelp	The directory where to pick content files to generate the index.
protected File	outputHelpSearch	The directory where to create or update help search index files.
protected String	timestamp

Fields inherited from class org.nuiton.jaxx.plugin.AbstractGenerateHelpMojo

generateSearch, locales

Fields inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo

generateHelp

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

ROLE

Constructor Summary

Constructors

Constructor	Description
GenerateHelpSearchMojo()

Method Summary

Modifier and Type	Method	Description
protected boolean	checkSkip()
protected void	doActionForLocale(Locale locale, boolean isDefaultLocale, File localizedTarget, String localePath)	Do the action for the given locale.
protected void	generateSearchIndex(File source, File target, Locale locale)
File	getTargetDirectory()
void	init()
protected void	postDoAction()	Call back after doing all stuff for all locales declared
protected void	preDoAction()	Call back before doing all stuff for all locales declared
void	setTargetDirectory(File targetDirectory)

Methods inherited from class org.nuiton.jaxx.plugin.AbstractGenerateHelpMojo

cleanHelpIdsStore, doAction, getHelpIdsFilename, getHelpIdsStoreFile, getMergeHelpIdsFilename, getMergeHelpIdsStoreFile, getOutputHelpIds, loadHelpIds, removeQuote, setHelpIdsFilename, setMergeHelpIdsFilename, setOutputHelpIds, storeHelpIds

Methods inherited from class org.nuiton.jaxx.plugin.AbstractJaxxMojo

checkPackaging, getEncoding, getLastModified, getProject, isForce, isVerbose, setEncoding, setForce, setProject, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, afterExecute, backupFile, checkEncoding, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getRootProject, getTemplate, hasClassPath, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, needInvoke, needInvoke, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, writeFile

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

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

execute, getLog, setLog

Field Detail

outputHelpSearch

@Parameter(property="jaxx.outputHelpSearch",
           defaultValue="${project.basedir}/target/generated-sources/help",
           required=true)
protected File outputHelpSearch

The directory where to create or update help search index files.

Since:

2.0.0

inputHelp

@Parameter(property="jaxx.inputHelp",
           defaultValue="${project.basedir}/src/main/help",
           required=true)
protected File inputHelp

The directory where to pick content files to generate the index.

Since:

2.0.0

timestamp

protected String timestamp

Constructor Detail

GenerateHelpSearchMojo

public GenerateHelpSearchMojo()

Method Detail

init

public void init()
          throws Exception

Overrides:

init in class AbstractGenerateHelpMojo

Throws:

Exception

getTargetDirectory

public File getTargetDirectory()

Specified by:

getTargetDirectory in class AbstractJaxxMojo

setTargetDirectory

public void setTargetDirectory(File targetDirectory)

Specified by:

setTargetDirectory in class AbstractJaxxMojo

checkSkip

protected boolean checkSkip()

Overrides:

checkSkip in class AbstractGenerateHelpMojo

doActionForLocale

protected void doActionForLocale(Locale locale,
                                 boolean isDefaultLocale,
                                 File localizedTarget,
                                 String localePath)
                          throws Exception

Description copied from class: AbstractGenerateHelpMojo

Do the action for the given locale.

Specified by:

doActionForLocale in class AbstractGenerateHelpMojo

Parameters:

locale - the locale to treate

isDefaultLocale - true if given locale is de the default locale

localizedTarget - where are stored help files for the given locale

localePath - the locale path to use (is default if given locale is default).

Throws:

Exception - if any pb

preDoAction

protected void preDoAction()
                    throws IOException

Description copied from class: AbstractGenerateHelpMojo

Call back before doing all stuff for all locales declared

Specified by:

preDoAction in class AbstractGenerateHelpMojo

Throws:

IOException

postDoAction

protected void postDoAction()

Description copied from class: AbstractGenerateHelpMojo

Call back after doing all stuff for all locales declared

Specified by:

postDoAction in class AbstractGenerateHelpMojo

generateSearchIndex

protected void generateSearchIndex(File source,
                                   File target,
                                   Locale locale)
                            throws Exception

Throws:

Exception