ro.nextreports.engine.queryexec

Class QueryParameter

java.lang.Object

ro.nextreports.engine.queryexec.QueryParameter

All Implemented Interfaces:

java.io.Serializable

public class QueryParameter
extends java.lang.Object
implements java.io.Serializable

Parameter defined for report

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALL_VALUES All values for java classes
static java.lang.String	BIGDECIMAL_VALUE Value for BigDecimal java class
static java.lang.String	BIGINTEGER_VALUE Value for BigInteger java class
static java.lang.String	BOOLEAN_VALUE Value for Boolean java class
static java.lang.String	BYTE_VALUE Value for Byte java class
static java.lang.String	DATE_VALUE Value for Date java class
protected java.lang.String	defaultSource
protected java.util.ArrayList<java.io.Serializable>	defaultSourceValues
protected java.util.ArrayList<java.io.Serializable>	defaultValues
protected java.lang.String	description
static java.lang.String	DOUBLE_VALUE Value for Double java class
static java.lang.String	FLOAT_VALUE Value for Float java class
protected boolean	hidden
protected boolean	ignore
static java.lang.String	INTEGER_VALUE Value for Integer java class
static java.lang.String	INTERVAL_END_DATE_NAME Name of end date parameter used in intervals
static java.lang.String	INTERVAL_START_DATE_NAME Name of start date parameter used in intervals
protected boolean	isProcedureParameter
static java.lang.String	LONG_VALUE Value for Long java class
protected boolean	mandatory
protected boolean	manualSource
static java.lang.String	MULTIPLE_SELECTION Parameter multiple selection : more than one value can be selected at runtime
protected java.lang.String	name
static byte	NO_ORDER No order for parameter source
static java.lang.String	OBJECT_VALUE Value for Object java class
static byte	ORDER_BY_ID Order by id for parameter with manual source
static byte	ORDER_BY_NAME Order by name for parameter with manual source
static byte	ORDER_BY_SELECT Select order for parameter source
protected byte	orderBy
protected java.lang.String	previewValue
protected java.lang.String	runtimeName
protected java.lang.String	schema
protected java.lang.String	selection
static java.lang.String[]	SELECTIONS All value sfor parameter selection
static java.lang.String	SHORT_VALUE Value for Short java class
static java.lang.String	SINGLE_SELECTION Parameter single selection : only ine value can be selected at runtime
protected java.lang.String	source
static java.lang.String	STRING_VALUE Value for String java class
protected boolean	subreportParameter
static java.lang.String	TIME_VALUE Value for Time java class
static java.lang.String	TIMESTAMP_VALUE Value for Timestamp java class
protected java.lang.Class	valueClass
protected java.lang.String	valueClassName
protected java.util.List	values

Constructor Summary

Constructors

Constructor and Description
QueryParameter(java.lang.String name, java.lang.String valueClassName) Create a query parameter
QueryParameter(java.lang.String name, java.lang.String description, java.lang.String valueClassName) Create a query parameter

Method Summary

Methods

Modifier and Type	Method and Description
boolean	compare(java.lang.Object o)
boolean	equals(java.lang.Object o) Equals
java.lang.String	getDefaultSource() Get default source for parameters
java.util.ArrayList<java.io.Serializable>	getDefaultSourceValues() Get default source parameter values
java.util.ArrayList<java.io.Serializable>	getDefaultValues() Get default parameter values
java.util.List<java.lang.String>	getDependentParameterNames() Get dependent parameter names
java.lang.String	getDescription() Get parameter description
java.lang.String	getName() Get parameter name
byte	getOrderBy() Get order for parameter values : ORDER_BY_NAME, ORDER_BY_ID Has meaning only if parameter has a manual source
java.lang.String	getPreviewValue() Get preview value for procedure parameter This value must be used inside the business procedure to exit (so we can can the columns as fast as possible)
java.lang.String	getRuntimeName() Get parameter name at runtime
java.lang.String	getSchema() Get database schema
java.lang.String	getSelection() Get parameter selection
java.lang.String	getSource() Get parameter source
java.lang.Class	getValueClass() Get java class object for the parameter value
java.lang.String	getValueClassName() Get the name of the value class
java.util.List	getValues() Get parameter values
int	hashCode() Hash code value for this parameter
boolean	isDependent() See if parameter is dependent on other parameters (its manual source contains other parameters names between tags '${' and '}'
boolean	isHidden() See if current parameter is hidden (does not appear at runtime)
boolean	isIgnore()
boolean	isMandatory() See if parameter is mandatory (must enter value(s) at runtime)
boolean	isManualSource() See if parameter has a manual source (an sql select)
boolean	isProcedureParameter() See if this parameter is a procedure parameter
boolean	isSubreportParameter()
void	setDefaultSource(java.lang.String defaultSource) Set default source for parameters
void	setDefaultSourceValues(java.util.ArrayList<java.io.Serializable> defaultSourceValues) Set default source parameter values
void	setDefaultValues(java.util.ArrayList<java.io.Serializable> defaultValues) Set default parameter values
void	setDescription(java.lang.String description) Set parameter description
void	setHidden(boolean hidden) Set hidden
void	setIgnore(boolean ignore)
void	setMandatory(boolean mandatory) Set mandatory flag
void	setManualSource(boolean manualSource) Set manual source flag
void	setName(java.lang.String name) Set parameter name This method is useful if we want to clone a parameter because we need to change the name
void	setOrderBy(byte orderBy) Set order for parameter values :
void	setPreviewValue(java.lang.String previewValue) Set preview value for procedure parameter Allows to set null for any type
void	setProcedureParameter(boolean procedureParameter) Set procedure parameter
void	setRuntimeName(java.lang.String runtimeName) Set parameter runtime name
void	setSchema(java.lang.String schema) Set database schema
void	setSelection(java.lang.String selection) Set parameter selection
void	setSource(java.lang.String source) Set parameter source
void	setSubreportParameter(boolean subreportParameter)
void	setValues(java.util.List values) Set parameter values
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INTEGER_VALUE

public static final java.lang.String INTEGER_VALUE

Value for Integer java class

See Also:

Constant Field Values

STRING_VALUE

public static final java.lang.String STRING_VALUE

Value for String java class

See Also:

Constant Field Values

BOOLEAN_VALUE

public static final java.lang.String BOOLEAN_VALUE

Value for Boolean java class

See Also:

Constant Field Values

BYTE_VALUE

public static final java.lang.String BYTE_VALUE

Value for Byte java class

See Also:

Constant Field Values

DATE_VALUE

public static final java.lang.String DATE_VALUE

Value for Date java class

See Also:

Constant Field Values

TIMESTAMP_VALUE

public static final java.lang.String TIMESTAMP_VALUE

Value for Timestamp java class

See Also:

Constant Field Values

TIME_VALUE

public static final java.lang.String TIME_VALUE

Value for Time java class

See Also:

Constant Field Values

DOUBLE_VALUE

public static final java.lang.String DOUBLE_VALUE

Value for Double java class

See Also:

Constant Field Values

FLOAT_VALUE

public static final java.lang.String FLOAT_VALUE

Value for Float java class

See Also:

Constant Field Values

LONG_VALUE

public static final java.lang.String LONG_VALUE

Value for Long java class

See Also:

Constant Field Values

SHORT_VALUE

public static final java.lang.String SHORT_VALUE

Value for Short java class

See Also:

Constant Field Values

BIGDECIMAL_VALUE

public static final java.lang.String BIGDECIMAL_VALUE

Value for BigDecimal java class

See Also:

Constant Field Values

BIGINTEGER_VALUE

public static final java.lang.String BIGINTEGER_VALUE

Value for BigInteger java class

See Also:

Constant Field Values

OBJECT_VALUE

public static final java.lang.String OBJECT_VALUE

Value for Object java class

See Also:

Constant Field Values

SINGLE_SELECTION

public static final java.lang.String SINGLE_SELECTION

Parameter single selection : only ine value can be selected at runtime

See Also:

Constant Field Values

MULTIPLE_SELECTION

public static final java.lang.String MULTIPLE_SELECTION

Parameter multiple selection : more than one value can be selected at runtime

See Also:

Constant Field Values

NO_ORDER

public static final byte NO_ORDER

No order for parameter source

See Also:

Constant Field Values

ORDER_BY_SELECT

public static final byte ORDER_BY_SELECT

Select order for parameter source

See Also:

Constant Field Values

ORDER_BY_NAME

public static final byte ORDER_BY_NAME

Order by name for parameter with manual source

See Also:

Constant Field Values

ORDER_BY_ID

public static final byte ORDER_BY_ID

Order by id for parameter with manual source

See Also:

Constant Field Values

INTERVAL_START_DATE_NAME

public static java.lang.String INTERVAL_START_DATE_NAME

Name of start date parameter used in intervals

INTERVAL_END_DATE_NAME

public static java.lang.String INTERVAL_END_DATE_NAME

Name of end date parameter used in intervals

ALL_VALUES

public static final java.lang.String[] ALL_VALUES

All values for java classes

SELECTIONS

public static final java.lang.String[] SELECTIONS

All value sfor parameter selection

name

protected java.lang.String name

runtimeName

protected java.lang.String runtimeName

description

protected java.lang.String description

valueClassName

protected java.lang.String valueClassName

valueClass

protected transient java.lang.Class valueClass

source

protected java.lang.String source

selection

protected java.lang.String selection

ignore

protected boolean ignore

mandatory

protected boolean mandatory

manualSource

protected boolean manualSource

schema

protected java.lang.String schema

isProcedureParameter

protected boolean isProcedureParameter

previewValue

protected java.lang.String previewValue

orderBy

protected byte orderBy

defaultValues

protected java.util.ArrayList<java.io.Serializable> defaultValues

defaultSource

protected java.lang.String defaultSource

hidden

protected boolean hidden

values

protected transient java.util.List values

defaultSourceValues

protected transient java.util.ArrayList<java.io.Serializable> defaultSourceValues

subreportParameter

protected transient boolean subreportParameter

Constructor Detail

QueryParameter

public QueryParameter(java.lang.String name,
              java.lang.String valueClassName)

Create a query parameter

Parameters:

name - parameter name

valueClassName - name for the value class

QueryParameter

public QueryParameter(java.lang.String name,
              java.lang.String description,
              java.lang.String valueClassName)

Create a query parameter

Parameters:

name - parameter name

description - parameter description

valueClassName - name for the value class

Method Detail

getName

public java.lang.String getName()

Get parameter name

Returns:

parameter name

setName

public void setName(java.lang.String name)

Set parameter name This method is useful if we want to clone a parameter because we need to change the name

getRuntimeName

public java.lang.String getRuntimeName()

Get parameter name at runtime

Returns:

parameter name at runtime

setRuntimeName

public void setRuntimeName(java.lang.String runtimeName)

Set parameter runtime name

Parameters:

runtimeName - parameter runtime name

getDescription

public java.lang.String getDescription()

Get parameter description

Returns:

parameter description

setDescription

public void setDescription(java.lang.String description)

Set parameter description

Parameters:

description - parameter description

getValueClass

public java.lang.Class getValueClass()

Get java class object for the parameter value

Returns:

java class object for the parameter value

getValueClassName

public java.lang.String getValueClassName()

Get the name of the value class

Returns:

the name of the value class

getSelection

public java.lang.String getSelection()

Get parameter selection

Returns:

parameter selection

setSelection

public void setSelection(java.lang.String selection)

Set parameter selection

Parameters:

selection - parameter selection

getSource

public java.lang.String getSource()

Get parameter source

Returns:

parameter source

setSource

public void setSource(java.lang.String source)

Set parameter source

Parameters:

source - parameter source

isIgnore

public boolean isIgnore()

setIgnore

public void setIgnore(boolean ignore)

getValues

public java.util.List getValues()

Get parameter values

Returns:

parameter values

setValues

public void setValues(java.util.List values)

Set parameter values

Parameters:

values - parameter values

getDefaultValues

public java.util.ArrayList<java.io.Serializable> getDefaultValues()

Get default parameter values

Returns:

default parameter values

setDefaultValues

public void setDefaultValues(java.util.ArrayList<java.io.Serializable> defaultValues)

Set default parameter values

Parameters:

defaultValues - default parameter values

getDefaultSource

public java.lang.String getDefaultSource()

Get default source for parameters

Returns:

default source for parameters

setDefaultSource

public void setDefaultSource(java.lang.String defaultSource)

Set default source for parameters

Parameters:

defaultSource - default source for parameters

getDefaultSourceValues

public java.util.ArrayList<java.io.Serializable> getDefaultSourceValues()

Get default source parameter values

Returns:

default source parameter values

setDefaultSourceValues

public void setDefaultSourceValues(java.util.ArrayList<java.io.Serializable> defaultSourceValues)

Set default source parameter values

Parameters:

defaultSourceValues - default source parameter values

isMandatory

public boolean isMandatory()

See if parameter is mandatory (must enter value(s) at runtime)

Returns:

true if parameter is mandatory

setMandatory

public void setMandatory(boolean mandatory)

Set mandatory flag

Parameters:

mandatory - mandatory flag

isManualSource

public boolean isManualSource()

See if parameter has a manual source (an sql select)

Returns:

true if parameter has a manual source

setManualSource

public void setManualSource(boolean manualSource)

Set manual source flag

Parameters:

manualSource - manual source flag

getSchema

public java.lang.String getSchema()

Get database schema

Returns:

database schema

setSchema

public void setSchema(java.lang.String schema)

Set database schema

Parameters:

schema - database schema

isProcedureParameter

public boolean isProcedureParameter()

See if this parameter is a procedure parameter

Returns:

true if this parameter is a procedure parameter

setProcedureParameter

public void setProcedureParameter(boolean procedureParameter)

Set procedure parameter

Parameters:

procedureParameter - true if this parameter is a procedure parameter, false otherwise

getPreviewValue

public java.lang.String getPreviewValue()

Get preview value for procedure parameter This value must be used inside the business procedure to exit (so we can can the columns as fast as possible)

Returns:

preview value as a string

setPreviewValue

public void setPreviewValue(java.lang.String previewValue)

Set preview value for procedure parameter Allows to set null for any type

Parameters:

previewValue - preview value for procedure parameter

getOrderBy

public byte getOrderBy()

Get order for parameter values : ORDER_BY_NAME, ORDER_BY_ID Has meaning only if parameter has a manual source

Returns:

order type of parameter values

setOrderBy

public void setOrderBy(byte orderBy)

Set order for parameter values :

Parameters:

orderBy - one of ORDER_BY_NAME, ORDER_BY_ID

isHidden

public boolean isHidden()

See if current parameter is hidden (does not appear at runtime)

Returns:

true if parameter iss hidden

setHidden

public void setHidden(boolean hidden)

Set hidden

Parameters:

hidden - hidden

isDependent

public boolean isDependent()

See if parameter is dependent on other parameters (its manual source contains other parameters names between tags '${' and '}'

Returns:

true if parameter is dependent on other parameters, false otherwise

getDependentParameterNames

public java.util.List<java.lang.String> getDependentParameterNames()

Get dependent parameter names

Returns:

a list of the names of all parameters the current parameter depends on

isSubreportParameter

public boolean isSubreportParameter()

setSubreportParameter

public void setSubreportParameter(boolean subreportParameter)

equals

public boolean equals(java.lang.Object o)

Equals

Overrides:

equals in class java.lang.Object

Parameters:

o - parameter object

Returns:

true if current parameter object equals parameter object, false otherwise

compare

public boolean compare(java.lang.Object o)

hashCode

public int hashCode()

Hash code value for this parameter

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this parameter

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object