com.neurosys.etl.common.transformers

Class URLGeneratorTransformer

java.lang.Object

com.neurosys.etl.common.transformers.JoinTransformer<String>

com.neurosys.etl.common.transformers.StringConcatTransformer

com.neurosys.etl.common.transformers.URLGeneratorTransformer

All Implemented Interfaces:

FunctionTransformer, Function, org.apache.commons.collections.Transformer

Direct Known Subclasses:

WebURLGeneratorTransformer, WicketURLGeneratorTransformer

public class URLGeneratorTransformer
extends StringConcatTransformer

Specialized use case of StringConcatTransformer used to generate URLs.
In this a processor is expeected to return a param=value pair.

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	paramsAdded
protected boolean	usePathAsParams If true will assume to join /../../ in Path Style

Fields inherited from class com.neurosys.etl.common.transformers.JoinTransformer

filter, processors

Constructor Summary

Constructors

Constructor and Description
URLGeneratorTransformer()
URLGeneratorTransformer(List processors)
URLGeneratorTransformer(Object base, Object params)

Method Summary

Modifier and Type	Method and Description
protected String	addAnalyticsParams(Object input, String url) Add analytic params (not affected by secureURL(Object, String))
protected String	decorateURL(Object input, String url) Any stuff to add on the URL
boolean	isParamsAdded()
boolean	isUsePathAsParams() If true will assume to join /../../ in Path Style
protected String	joinDelimet(String result, Object processor, boolean hasNext) In Join operations it maybe desired a delimeter is needed between joins of two JoinTransformer.processors in sequence.
protected String	secureURL(Object input, String url) Override to secure url params
void	setParamsAdded(boolean paramsAdded)
void	setProcessors(List processors)
void	setUsePathAsParams(boolean usePathAsParams) If true will assume to join /../../ in Path Style
Object	transform(Object input) Call secureURL(Object, String) then decorateURL(Object, String) and then addAnalyticsParams(Object, String)

Methods inherited from class com.neurosys.etl.common.transformers.StringConcatTransformer

cleanDangligngDelimets, getDanglingDelimRegEx, getDelimiter, join, setDanglingDelimRegEx, setDelimiter

Methods inherited from class com.neurosys.etl.common.transformers.JoinTransformer

getFilter, getProcessors, setFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neurosys.etl.common.transformers.FunctionTransformer

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

paramsAdded

protected boolean paramsAdded

usePathAsParams

protected boolean usePathAsParams

If true will assume to join /../../ in Path Style

Constructor Detail

URLGeneratorTransformer

public URLGeneratorTransformer()

URLGeneratorTransformer

public URLGeneratorTransformer(List processors)

URLGeneratorTransformer

public URLGeneratorTransformer(Object base,
                               Object params)

Parameters:

base - as a static String or a Transformer capable of generating the base path from input

params - as a static String of URL params or a Transformer capable of generating the parameters key value pairs from the input

Method Detail

setProcessors

public void setProcessors(List processors)

Overrides:

setProcessors in class JoinTransformer<String>

secureURL

protected String secureURL(Object input,
                           String url)
                    throws Exception

Override to secure url params

Throws:

Exception

decorateURL

protected String decorateURL(Object input,
                             String url)
                      throws Exception

Any stuff to add on the URL

Throws:

Exception

addAnalyticsParams

protected String addAnalyticsParams(Object input,
                                    String url)
                             throws Exception

Add analytic params (not affected by secureURL(Object, String))

Parameters:

input - as Object

url - as String

Returns:

Throws:

Exception

transform

public Object transform(Object input)

Call secureURL(Object, String) then decorateURL(Object, String) and then addAnalyticsParams(Object, String)

Specified by:

transform in interface org.apache.commons.collections.Transformer

Overrides:

transform in class JoinTransformer<String>

joinDelimet

protected String joinDelimet(String result,
                             Object processor,
                             boolean hasNext)

Description copied from class: JoinTransformer

In Join operations it maybe desired a delimeter is needed between joins of two JoinTransformer.processors in sequence.

Overrides:

joinDelimet in class StringConcatTransformer

Parameters:

result - as T so far of all joins

processor - as type T or Transformer

hasNext - as boolean (if there are any more processors in the chain). If false the current processor is the last. Note: If a JoinTransformer.filter is defined; hasNext cannot factor the next in the chain will be part of result or not. However, if there are any dangling delims left JoinTransformer.cleanDangligngDelimets(Object) can be defined.

Returns:

Object as result after delimition

isParamsAdded

public boolean isParamsAdded()

setParamsAdded

public void setParamsAdded(boolean paramsAdded)

isUsePathAsParams

public boolean isUsePathAsParams()

If true will assume to join /../../ in Path Style

setUsePathAsParams

public void setUsePathAsParams(boolean usePathAsParams)

If true will assume to join /../../ in Path Style