org.apache.lens.api.query.save

Class Parameter

java.lang.Object

org.apache.lens.api.query.save.Parameter

public class Parameter
extends Object

The class Parameter.

Constructor Summary

Constructors

Constructor and Description
Parameter()
Parameter(String name)
Parameter(String name, String displayName, String[] defaultValue, ParameterDataType dataType, ParameterCollectionType collectionType)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
ParameterCollectionType	getCollectionType() Collection type of the parameter.
ParameterDataType	getDataType() Data type of the parameter.
String[]	getDefaultValue() The default value that will be used, if the parameter is not supplied with any values while running the query.
String	getDisplayName() Display name of the parameter.
String	getName() Name of the parameter used in the query.
int	hashCode()
void	setCollectionType(ParameterCollectionType collectionType) Collection type of the parameter.
void	setDataType(ParameterDataType dataType) Data type of the parameter.
void	setDefaultValue(String[] defaultValue) The default value that will be used, if the parameter is not supplied with any values while running the query.
void	setDisplayName(String displayName) Display name of the parameter.
void	setName(String name) Name of the parameter used in the query.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Parameter

public Parameter(String name)

Parameter

@ConstructorProperties(value={"name","displayName","defaultValue","dataType","collectionType"})
@Generated(value="lombok")
public Parameter(String name,
                                                   String displayName,
                                                   String[] defaultValue,
                                                   ParameterDataType dataType,
                                                   ParameterCollectionType collectionType)

Parameter

@Generated(value="lombok")
public Parameter()

Method Detail

getName

@Generated(value="lombok")
public String getName()

Name of the parameter used in the query. It should match the following regex pattern ":[a-zA-Z][a-zA-Z_0-9]".

getDisplayName

@Generated(value="lombok")
public String getDisplayName()

Display name of the parameter. Should be used by the UI apps for resolution.

getDefaultValue

@Generated(value="lombok")
public String[] getDefaultValue()

The default value that will be used, if the parameter is not supplied with any values while running the query.

getDataType

@Generated(value="lombok")
public ParameterDataType getDataType()

Data type of the parameter. Could be number, decimal, string or boolean. The value supplied will be parsed with the corresponding data type.

getCollectionType

@Generated(value="lombok")
public ParameterCollectionType getCollectionType()

Collection type of the parameter. Depending on the type of expression IN/EQ, it could be a single/multiple collection.

setName

@Generated(value="lombok")
public void setName(String name)

Name of the parameter used in the query. It should match the following regex pattern ":[a-zA-Z][a-zA-Z_0-9]".

setDisplayName

@Generated(value="lombok")
public void setDisplayName(String displayName)

Display name of the parameter. Should be used by the UI apps for resolution.

setDefaultValue

@Generated(value="lombok")
public void setDefaultValue(String[] defaultValue)

The default value that will be used, if the parameter is not supplied with any values while running the query.

setDataType

@Generated(value="lombok")
public void setDataType(ParameterDataType dataType)

Data type of the parameter. Could be number, decimal, string or boolean. The value supplied will be parsed with the corresponding data type.

setCollectionType

@Generated(value="lombok")
public void setCollectionType(ParameterCollectionType collectionType)

Collection type of the parameter. Depending on the type of expression IN/EQ, it could be a single/multiple collection.

toString

@Generated(value="lombok")
public String toString()

Overrides:

toString in class Object

equals

@Generated(value="lombok")
public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

@Generated(value="lombok")
public int hashCode()

Overrides:

hashCode in class Object