org.zanata.maven

Class PushMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.zanata.maven.ConfigurableMojo<O>

org.zanata.maven.ConfigurableProjectMojo<O>

org.zanata.maven.PushPullMojo<PushOptions>

org.zanata.maven.PushMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, BasicOptions, ConfigurableOptions, ConfigurableProjectOptions, PushOptions, PushPullOptions

public class PushMojo
extends PushPullMojo<PushOptions>
implements PushOptions

Pushes source text to a Zanata project version so that it can be translated, and optionally push translated text as well. NB: Any documents which exist on the server but not locally will be deleted as obsolete. If deleteObsoleteModules is true, documents belonging to unknown/obsolete modules will be deleted as well.

Author:

Sean Flanigan

Field Summary

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

ROLE

Constructor Summary

Constructors

Constructor and Description
PushMojo()

Method Summary

Methods

Modifier and Type	Method and Description
int	getBatchSize()
String	getCommandName()
boolean	getCopyTrans()
boolean	getDefaultExcludes()
boolean	getDeleteObsoleteModules()
List<String>	getExcludes()
List<String>	getIncludes()
LocaleList	getLocaleMapList() Override the default ConfigurableProjectMojo.getLocaleMapList() method as the push command can have locales specified via command line.
String	getMergeType()
PushPullType	getPushType()
String	getSourceLang()
PushCommand	initCommand()

Methods inherited from class org.zanata.maven.PushPullMojo

getAllModules, getCurrentModule, getDocNameRegex, getEnableModules, getModuleSuffix, getSrcDir, getTransDir, isDryRun, isRootModule, runCommand

Methods inherited from class org.zanata.maven.ConfigurableProjectMojo

getProj, getProjectConfig, getProjectType, getProjectVersion, setLocaleMapList, setProj, setProjectConfig, setProjectType, setProjectVersion

Methods inherited from class org.zanata.maven.ConfigurableMojo

execute, getCommandDescription, getDebug, getErrors, getHelp, getKey, getLogHttp, getQuiet, getUrl, getUserConfig, getUsername, isDebugSet, isErrorsSet, isInteractiveMode, isQuietSet, setDebug, setErrors, setHelp, setInteractiveMode, setKey, setLogHttp, setQuiet, setUrl, setUserConfig, setUsername

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.zanata.client.commands.PushPullOptions

getAllModules, getCurrentModule, getDocNameRegex, getEnableModules, getModuleSuffix, getSrcDir, getTransDir, isDryRun, isRootModule

Methods inherited from interface org.zanata.client.commands.ConfigurableProjectOptions

getProj, getProjectConfig, getProjectType, getProjectVersion, setLocaleMapList, setProj, setProjectConfig, setProjectType, setProjectVersion

Methods inherited from interface org.zanata.client.commands.ConfigurableOptions

getKey, getLogHttp, getUrl, getUserConfig, getUsername, setKey, setLogHttp, setUrl, setUserConfig, setUsername

Methods inherited from interface org.zanata.client.commands.BasicOptions

getCommandDescription, getDebug, getErrors, getHelp, getQuiet, isDebugSet, isErrorsSet, isInteractiveMode, isQuietSet, setDebug, setErrors, setHelp, setInteractiveMode, setQuiet

Constructor Detail

PushMojo

public PushMojo()
         throws Exception

Throws:

Exception

Method Detail

initCommand

public PushCommand initCommand()

Specified by:

initCommand in interface BasicOptions

Specified by:

initCommand in class ConfigurableMojo<PushOptions>

getSourceLang

public String getSourceLang()

Specified by:

getSourceLang in interface PushOptions

getPushType

public PushPullType getPushType()

Specified by:

getPushType in interface PushOptions

getCopyTrans

public boolean getCopyTrans()

Specified by:

getCopyTrans in interface PushOptions

getMergeType

public String getMergeType()

Specified by:

getMergeType in interface PushOptions

getBatchSize

public int getBatchSize()

Specified by:

getBatchSize in interface PushOptions

getDeleteObsoleteModules

public boolean getDeleteObsoleteModules()

Specified by:

getDeleteObsoleteModules in interface PushOptions

getIncludes

public List<String> getIncludes()

Specified by:

getIncludes in interface PushOptions

getExcludes

public List<String> getExcludes()

Specified by:

getExcludes in interface PushOptions

getDefaultExcludes

public boolean getDefaultExcludes()

Specified by:

getDefaultExcludes in interface PushOptions

getLocaleMapList

public LocaleList getLocaleMapList()

Override the default ConfigurableProjectMojo.getLocaleMapList() method as the push command can have locales specified via command line.

Specified by:

getLocaleMapList in interface ConfigurableProjectOptions

Overrides:

getLocaleMapList in class ConfigurableProjectMojo<PushOptions>

Returns:

The locale map list taking into account the global locales in zanata.xml as well as the command line argument ones.

getCommandName

public String getCommandName()

Specified by:

getCommandName in interface BasicOptions