org.springframework.xd.dirt.plugins.job

Class ExpandedJobParametersConverter

java.lang.Object

org.springframework.batch.core.converter.DefaultJobParametersConverter

org.springframework.xd.dirt.plugins.job.ExpandedJobParametersConverter

All Implemented Interfaces:

org.springframework.batch.core.converter.JobParametersConverter

public class ExpandedJobParametersConverter
extends org.springframework.batch.core.converter.DefaultJobParametersConverter

More flexible implementation of the JobParametersConverter. Allows to convert a wide variety of object types to JobParameters.

Since:

1.0

Author:

Gunnar Hillert

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABSOLUTE_FILE_PATH
static java.lang.String	IS_RESTART_JOB_PARAMETER_KEY
protected org.apache.commons.logging.Log	logger
static java.lang.String	UNIQUE_JOB_PARAMETER_KEY

Fields inherited from class org.springframework.batch.core.converter.DefaultJobParametersConverter

DATE_TYPE, LONG_TYPE, STRING_TYPE

Constructor Summary

Constructors

Constructor and Description
ExpandedJobParametersConverter() Default Constructor, initializing DefaultJobParametersConverter.setDateFormat(DateFormat) with TimeUtils.getDefaultDateFormat().

Method Summary

Methods

Modifier and Type	Method and Description
org.springframework.batch.core.JobParameters	getJobParameters(java.util.Properties properties) If makeParametersUnique is true the JobParameter with key UNIQUE_JOB_PARAMETER_KEY will be added with a random number value.
java.lang.String	getJobParametersAsString(org.springframework.batch.core.JobParameters jobParameters) This method will convert JobParameters to a JSON String.
java.lang.String	getJobParametersAsString(org.springframework.batch.core.JobParameters jobParameters, boolean isRestart) This method will convert JobParameters to a JSON String.
org.springframework.batch.core.JobParameters	getJobParametersForFile(java.io.File file) Return JobParameters for the passed-in File.
org.springframework.batch.core.JobParameters	getJobParametersForJsonString(java.lang.String jobParametersAsJsonMap) Converts a String-based JSON map to JobParameters.
org.springframework.batch.core.JobParameters	getJobParametersForMap(java.util.Map<?,?> map) Will convert the provided Map into JobParameters.
org.springframework.batch.core.JobParameters	removeRestartParameterIfExists(org.springframework.batch.core.JobParameters jobParameters) If JobParameters contains a parameters named "XD_isRestart" removed it.
void	setDateFormat(java.text.DateFormat dateFormat) Will set the DateFormat on the underlying DefaultJobParametersConverter.
void	setDateFormatAsString(java.lang.String dateFormatAsString) Allows for setting the DateFormat using a String.
void	setMakeParametersUnique(boolean makeParametersUnique) If not set, this property defaults to true.
void	setNumberFormat(java.text.NumberFormat numberFormat) Setter for the NumberFormat which is set on the underlying DefaultJobParametersConverter.
void	setNumberFormatAsString(java.lang.String numberFormatAsString) Allows for setting the NumberFormat using a String.

Methods inherited from class org.springframework.batch.core.converter.DefaultJobParametersConverter

getProperties

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

ABSOLUTE_FILE_PATH

public static final java.lang.String ABSOLUTE_FILE_PATH

See Also:

Constant Field Values

UNIQUE_JOB_PARAMETER_KEY

public static final java.lang.String UNIQUE_JOB_PARAMETER_KEY

See Also:

Constant Field Values

IS_RESTART_JOB_PARAMETER_KEY

public static final java.lang.String IS_RESTART_JOB_PARAMETER_KEY

See Also:

Constant Field Values

Constructor Detail

ExpandedJobParametersConverter

public ExpandedJobParametersConverter()

Default Constructor, initializing DefaultJobParametersConverter.setDateFormat(DateFormat) with TimeUtils.getDefaultDateFormat().

Method Detail

setDateFormat

public void setDateFormat(java.text.DateFormat dateFormat)

Will set the DateFormat on the underlying DefaultJobParametersConverter. If not set explicitly, the DateFormat will default to TimeUtils.getDefaultDateFormat().

Overrides:

setDateFormat in class org.springframework.batch.core.converter.DefaultJobParametersConverter

Parameters:

dateFormat - Must not be null

setDateFormatAsString

public void setDateFormatAsString(java.lang.String dateFormatAsString)

Allows for setting the DateFormat using a String. If not set, the default DateFormat used will be TimeUtils.getDefaultDateFormat().

Parameters:

dateFormatAsString - Will be ignored if null or empty.

setMakeParametersUnique

public void setMakeParametersUnique(boolean makeParametersUnique)

If not set, this property defaults to true.

Parameters:

makeParametersUnique - If not set defaults to true

setNumberFormat

public void setNumberFormat(java.text.NumberFormat numberFormat)

Setter for the NumberFormat which is set on the underlying DefaultJobParametersConverter. If not set explicitly, defaults to NumberFormat.getInstance(Locale.US);

Overrides:

setNumberFormat in class org.springframework.batch.core.converter.DefaultJobParametersConverter

Parameters:

numberFormat - Must not be null.

setNumberFormatAsString

public void setNumberFormatAsString(java.lang.String numberFormatAsString)

Allows for setting the NumberFormat using a String. The passed-in String will be converted to a DecimalFormat.

Parameters:

numberFormatAsString - Will be ignored if null or empty.

getJobParametersForFile

public org.springframework.batch.core.JobParameters getJobParametersForFile(java.io.File file)

Return JobParameters for the passed-in File. Will set the JobParameter with key ABSOLUTE_FILE_PATH to the File's absolutePath. Method will ultimately call getJobParameters(Properties).

Parameters:

file - Must not be null.

getJobParametersForJsonString

public org.springframework.batch.core.JobParameters getJobParametersForJsonString(java.lang.String jobParametersAsJsonMap)

Converts a String-based JSON map to JobParameters. The String is converted using Jackson's ObjectMapper. The method will ultimately call getJobParametersForMap(Map).

Parameters:

jobParametersAsJsonMap - Can be null or empty.

getJobParametersForMap

public org.springframework.batch.core.JobParameters getJobParametersForMap(java.util.Map<?,?> map)

Will convert the provided Map into JobParameters. The method will ultimately call getJobParameters(Properties).

Parameters:

map - Can be null or an empty Map.

getJobParameters

public org.springframework.batch.core.JobParameters getJobParameters(java.util.Properties properties)

If makeParametersUnique is true the JobParameter with key UNIQUE_JOB_PARAMETER_KEY will be added with a random number value. The method will ultimately call DefaultJobParametersConverter.getJobParameters(Properties).

Specified by:

getJobParameters in interface org.springframework.batch.core.converter.JobParametersConverter

Overrides:

getJobParameters in class org.springframework.batch.core.converter.DefaultJobParametersConverter

Parameters:

properties - Can be null.

getJobParametersAsString

public java.lang.String getJobParametersAsString(org.springframework.batch.core.JobParameters jobParameters)

This method will convert JobParameters to a JSON String. The parameters in the resulting JSON String are sorted by the name of the parameters. This method will delegate to getJobParametersAsString(JobParameters, boolean)

Parameters:

jobParameters - Must not be null

Returns:

A JSON String representation of the JobParameters

getJobParametersAsString

public java.lang.String getJobParametersAsString(org.springframework.batch.core.JobParameters jobParameters,
                                        boolean isRestart)

This method will convert JobParameters to a JSON String. The parameters in the resulting JSON String are sorted by the name of the parameters.

Parameters:

jobParameters - Must not be null

isRestart - When true, add a restart flag

Returns:

A JSON String representation of the JobParameters

removeRestartParameterIfExists

public org.springframework.batch.core.JobParameters removeRestartParameterIfExists(org.springframework.batch.core.JobParameters jobParameters)

If JobParameters contains a parameters named "XD_isRestart" removed it.

Parameters:

jobParameters - Must not be null

Returns:

A new instance of JobParameters