de.gerdiproject.harvest.config.parameters.constants

Class ParameterMappingFunctions

java.lang.Object

de.gerdiproject.harvest.config.parameters.constants.ParameterMappingFunctions

public class ParameterMappingFunctions
extends Object

This class provides functions for mapping string values to specific AbstractParameter values.

Author:

Robin Weiss

Method Summary

Modifier and Type	Method and Description
static Function<String,String>	createClassNameListMapper(Collection<Class<?>> validClasses) Creates a mapping function that forwards an input string if it is a simple class name of a specified collection.
static <V> Function<String,V>	createMapperForETL(Function<String,V> originalMappingFunction, AbstractETL<?,?> etl) Creates a mapping function that executes another mapping function while throwing an exception if a specified ETL is currently busy.
static <V> Function<String,V>	createMapperForETLs(Function<String,V> originalMappingFunction) Creates a mapping function that executes another mapping function while throwing an exception if any ETL is currently busy.
static Function<String,String>	createStringListMapper(Collection<String> validValues) Creates a mapping function that forwards input string values to the output only if they are in a collection of valid values or if the input values are null.
static Boolean	mapToBoolean(String value) This function checks if a string represents a boolean value and throws an exception if it does not.
static Integer	mapToInteger(String value) This function checks if a string represents an Integer value and throws an exception if it does not.
static String	mapToNonEmptyString(String value) This function checks if the string value is neither null nor empty and throws an exception if this check fails.
static String	mapToString(String value) This function simply forwards the string parameter that was passed to it.
static Integer	mapToUnsignedInteger(String value) This function checks if a string represents a positive Integer value and throws an exception if it does not.
static String	mapToUrlString(String value) This function checks if a string represents a valid URL and returns the value if it does.

Methods inherited from class java.lang.Object

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

Method Detail

mapToString

public static String mapToString(String value)

This function simply forwards the string parameter that was passed to it. If any useful checks should come up in the future, they can be implemented here to be used by all string parameters.

Parameters:

value - a string value

Returns:

a string value

mapToNonEmptyString

public static String mapToNonEmptyString(String value)
                                  throws IllegalArgumentException

This function checks if the string value is neither null nor empty and throws an exception if this check fails.

Parameters:

value - a string value

Returns:

a non-empty, non-null string value

Throws:

IllegalArgumentException - if the value is null or empty

mapToBoolean

public static Boolean mapToBoolean(String value)
                            throws ClassCastException

This function checks if a string represents a boolean value and throws an exception if it does not.

Parameters:

value - a string representation of a parameter value

Returns:

a boolean value

Throws:

ClassCastException - this exception is thrown when the String value cannot be mapped to the target value

mapToInteger

public static Integer mapToInteger(String value)
                            throws ClassCastException

This function checks if a string represents an Integer value and throws an exception if it does not.

Parameters:

value - a string representation of a parameter value

Returns:

an integer value

Throws:

ClassCastException - this exception is thrown when the String value cannot be mapped to the target value

mapToUnsignedInteger

public static Integer mapToUnsignedInteger(String value)
                                    throws ClassCastException

This function checks if a string represents a positive Integer value and throws an exception if it does not.

Parameters:

value - a string representation of a parameter value

Returns:

a positive integer value represented by the string

Throws:

ClassCastException - this exception is thrown when the String value cannot be mapped to the target value

mapToUrlString

public static String mapToUrlString(String value)
                             throws IllegalArgumentException

This function checks if a string represents a valid URL and returns the value if it does.

Parameters:

value - a string representation of a parameter value

Returns:

a valid URL string

Throws:

IllegalArgumentException - this exception is thrown when the string does not represent a valid URL

createMapperForETL

public static <V> Function<String,V> createMapperForETL(Function<String,V> originalMappingFunction,
                                                        AbstractETL<?,?> etl)

Creates a mapping function that executes another mapping function while throwing an exception if a specified ETL is currently busy. The case is ignored when comparing the list values.

Type Parameters:

V - the type of the parameter value

Parameters:

originalMappingFunction - the mapping function that is to be extended

etl - the AbstractETL of which the status is to be checked

Returns:

a mapping function

createMapperForETLs

public static <V> Function<String,V> createMapperForETLs(Function<String,V> originalMappingFunction)

Creates a mapping function that executes another mapping function while throwing an exception if any ETL is currently busy. The case is ignored when comparing the list values.

Type Parameters:

V - the type of the parameter value

Parameters:

originalMappingFunction - the mapping function that is to be extended

Returns:

a mapping function

createStringListMapper

public static Function<String,String> createStringListMapper(Collection<String> validValues)

Creates a mapping function that forwards input string values to the output only if they are in a collection of valid values or if the input values are null. The case is ignored when comparing the list values.

Parameters:

validValues - a collection of allowed string values

Returns:

a mapping function

createClassNameListMapper

public static Function<String,String> createClassNameListMapper(Collection<Class<?>> validClasses)

Creates a mapping function that forwards an input string if it is a simple class name of a specified collection. The comparison ignores the case of the input string.

Parameters:

validClasses - a list of allowed class names

Returns:

a mapping function