Package lumis.portal.file.transformation

Class SimpleParameterType

java.lang.Object

lumis.portal.file.transformation.SimpleParameterType

All Implemented Interfaces:

Serializable, IParameterType

public class SimpleParameterType
extends Object
implements IParameterType, Serializable

Defines a custom parameter type.

Since:

6.1.0

Version:

$Revision: 16824 $ $Date: 2015-01-23 18:49:12 -0200 (Fri, 23 Jan 2015) $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAMED_QUERY_FIND_PARAMETER_BY_NAME
static String	NAMED_QUERY_FIND_PARAMETER_BY_NAME_PARAMETER
static String	NAMED_QUERY_REMOVE_USELESS_PARAM
static Set<String>	NATIVE_TYPES_NAMES	Native parameter types.
static String	PARAMETER_NAME_FORMAT	Format parameter name.
static String	PARAMETER_NAME_HEIGHT	Height parameter name.
static String	PARAMETER_NAME_WIDTH	Width parameter name.

Constructor Summary

Constructors

Constructor	Description
SimpleParameterType()

Method Summary

Modifier and Type	Method	Description
String	getId()	Returns the id.
String	getName()	Returns the parameterName.
ITransformationBuilder	getTransformationBuilder()	Returns the transformationBuilder.
static boolean	isNative(String name)	Verify whether the given name is of one of the native types.
static boolean	isRemovable(String name)	Asserts if a given transformation parameter is used by other transformations.
void	setId(String id)	Sets the id.
void	setName(String parameterName)	Sets the parameterName.
void	setTransformationBuilder(Class<? extends ITransformationBuilder> transformationBuilder)	Sets the transformationBuilder.
void	setTransformationBuilder(String transformationBuilder)

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_NAME_WIDTH

public static final String PARAMETER_NAME_WIDTH

Width parameter name. Used in transformations.

Since:

6.1.0

See Also:

Constant Field Values

PARAMETER_NAME_HEIGHT

public static final String PARAMETER_NAME_HEIGHT

Height parameter name. Used in transformations.

Since:

6.1.0

See Also:

Constant Field Values

PARAMETER_NAME_FORMAT

public static final String PARAMETER_NAME_FORMAT

Format parameter name. Used in transformations.

Since:

6.1.0

See Also:

Constant Field Values

NATIVE_TYPES_NAMES

public static final Set<String> NATIVE_TYPES_NAMES

Native parameter types. The types with these names (no matter the case) may not be deleted.
Note: For standardization purpose, these names are stored in upper case.

Since:

6.2.0

See Also:

isNative(String)

NAMED_QUERY_FIND_PARAMETER_BY_NAME

public static final String NAMED_QUERY_FIND_PARAMETER_BY_NAME

Since:

6.1.0

See Also:

Constant Field Values

NAMED_QUERY_REMOVE_USELESS_PARAM

public static final String NAMED_QUERY_REMOVE_USELESS_PARAM

Since:

6.1.0

See Also:

Constant Field Values

NAMED_QUERY_FIND_PARAMETER_BY_NAME_PARAMETER

public static final String NAMED_QUERY_FIND_PARAMETER_BY_NAME_PARAMETER

Since:

6.1.0

See Also:

Constant Field Values

Constructor Detail

SimpleParameterType

public SimpleParameterType()

Method Detail

getId

public String getId()

Returns the id.

Returns:

the id

Since:

6.1.0

setId

public void setId(String id)

Sets the id.

Parameters:

id - the id value to set.

Since:

6.1.0

getName

public String getName()

Returns the parameterName.

Specified by:

getName in interface IParameterType

Returns:

the parameterName

Since:

6.1.0

setName

public void setName(String parameterName)

Sets the parameterName.

Parameters:

parameterName - the parameterName value to set.

Since:

6.1.0

getTransformationBuilder

public ITransformationBuilder getTransformationBuilder()

Returns the transformationBuilder.

Specified by:

getTransformationBuilder in interface IParameterType

Returns:

the transformationBuilder.

Throws:

IllegalArgumentException

Since:

6.1.0

setTransformationBuilder

public void setTransformationBuilder(Class<? extends ITransformationBuilder> transformationBuilder)

Sets the transformationBuilder.

Parameters:

transformationBuilder - the transformationBuilder value to set.

Since:

6.1.0

setTransformationBuilder

public void setTransformationBuilder(String transformationBuilder)
                              throws ClassNotFoundException,
                                     InstantiationException,
                                     IllegalAccessException

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

isRemovable

public static boolean isRemovable(String name)
                           throws PortalException

Asserts if a given transformation parameter is used by other transformations.

Parameters:

name - the name of the parameter

Returns:

true if the Transformation Parameter must be deleted or false if the parameter must not be deleted.

Throws:

PortalException

Since:

6.1.0

isNative

public static final boolean isNative(String name)

Verify whether the given name is of one of the native types.

Parameters:

name - the type name.

Returns:

whether the given name is of one of the native types.

Throws:

NullPointerException - if the given name is null.

Since:

6.2.0

See Also:

NATIVE_TYPES_NAMES