Param- 参数类

阅读(1977) 标签: 定义参数, 获取参数, 设置参数,

Param参数类,本类用于定义参数对象,设置和获取参数信息。比如设置参数名、设置参数类型、设置参数描述等等

 

实例请参考API实例 / 报表模板编辑 / 设置参数

 

l  构造函数

类名:com.raqsoft.report.usermodel.Param

public Param () //构造一个参数对象

public Param(java.lang.String name,

  java.lang.String description,

  byte paramType,

  byte dataType,

   short precision,

  short scale,

  boolean nullable,

  java.lang.String format,

   java.lang.String value) //构造一个参数配置

Parameters

name - 参数名称

description - 参数描述

paramType - 参数类型

dataType - 参数的数据类型

precision - 精度

scale - 小数位

nullable - 是否可空

format - 参数格式

value - 参数串

public Param(java.lang.String name,

  java.lang.String description,

  byte paramType,

  byte dataType,

  short precision,

  short scale,

   boolean nullable,

  java.lang.String format,

  java.lang.String value,

  java.lang.String styleName) //构造一个参数配置

Parameters

name - 参数名称

description - 参数描述

paramType - 参数类型

dataType - 参数的数据类型

precision - 精度

scale - 小数位

nullable - 是否可空

format - 参数格式

value - 参数串

styleName - 编辑风格名

 

l  可用方法

getParamType

  法:  public byte getParamType()
功能说明:  取参数类型
Returns  :   参数类型,值为“PARAM_NORMAL”表示普通参数、值为“PARAM_DYNAMIC”表示动态参数
调用举例:    
 

setParamType

  法:  public void setParamType(byte paramType)
参数说明:    paramType -参数类型,值为“PARAM_NORMAL”表示普通参数、值为“PARAM_DYNAMIC”表示动态参数
功能说明:  设参数类型
调用举例:    

 

getDataType

  法:  public byte getDataType()
功能说明:  取参数的数据类型
Returns  :   参数的数据类型
调用举例:    
 

setDataType

  法:  public void setDataType(byte dataType)
参数说明:    dataType -参数的数据类型

Types类型列表:

DT_DEFAULT,DT_INT,DT_LONG,DT_SHORT,DT_BIGINT,DT_FLOAT,DT_DOUBLE,DT_DECIMAL,DT_DATE,DT_TIME,DT_DATETIME,DT_STRING,DT_BOOLEAN,DT_INT_SERIES,DT_LONG_SERIES,DT_SHORT_SERIES,DT_BIGINT_SERIES,DT_FLOAT_SERIES,DT_DOUBLE_SERIES,DT_DECIMAL_SERIES,DT_DATE_SERIES,DT_TIME_SERIES,DT_DATETIME_SERIES,DT_STRING_SERIES,DT_BYTE_SERIES,DT_CURSOR,DT_AUTOINCREMENT
DT_DEFAULT类型时程序会自动根据数据值类型设置
功能说明:  设参数的数据类型
调用举例:    

 

getPrecision

  法:  public short getPrecision()
功能说明:  取参数的精度
Returns  :   参数的精度
调用举例:    

 

setPrecision

  法:  public void setPrecision(short precision)
参数说明:    precision - 参数的精度
功能说明:  设参数的精度
调用举例:    

 

getScale

  法:  public short getScale()
功能说明:  取小数位
Returns  :   小数位
调用举例:    

 

setScale

  法:  public void setScale(short scale)
参数说明:    scale - 小数位
功能说明:  设小数位
调用举例:    

 

isNullable

  法:  public boolean isNullable()
功能说明:  取是否可为空
Returns  :   true表示可为空,false表示不可为空
调用举例:    

 

setNullable

  法:  public void setNullable(boolean nullable)
参数说明:    nullable - true表示可为空,false表示不可为空
功能说明:  设是否可为空
调用举例:    

 

getParamName

  法:  public java.lang.String getParamName()
功能说明:  取参数名
Returns  :   参数名
调用举例:    

 

setStyleName

  法:  public void setStyleName(java.lang.String name)
参数说明:    name - 参数编辑风格名
功能说明:  设参数编辑风格
调用举例:    

 

getStyleName

  法:  public java.lang.String getStyleName()
功能说明:  获取参数编辑风格
Returns  :   参数编辑风格
调用举例:    

 

setParamName

  法:  public void setParamName(java.lang.String name)
参数说明:    name - 参数编辑风格名
功能说明:  设参数编辑风格
调用举例:    

 

getDescription

  法:  public java.lang.String getDescription()
功能说明:  取参数描述
Returns  :   参数描述
调用举例:    

 

setDescription

  法:  public void setDescription(java.lang.String description)
参数说明:    description - 参数描述
功能说明:  设参数描述
调用举例:    

 

getFormat

  法:  public java.lang.String getFormat()
功能说明:  取参数格式
Returns  :   参数格式
调用举例:    

 

setFormat

  法:  public void setFormat(java.lang.String format)
参数说明:    format - 参数格式
功能说明:  设参数格式
调用举例:    

 

getValue

  法:  public java.lang.String getValue()
功能说明:  取参数串
Returns  :   参数串
调用举例:    

 

setValue

  法:  public void setValue(java.lang.String value)
参数说明:    value - 参数串
功能说明:  设参数串
调用举例:    

 

isAutoCreated

  法:  public boolean isAutoCreated()
功能说明:  判断参数是否自动生成的,默认为false
Returns:   false表示参数不是自动生成的,true表示是自动生成的。
调用举例:     

 

setAutoCreated

  法:  public void setAutoCreated(boolean auto)
参数说明:    auto - false表示参数不是自动生成的,true表示是自动生成的。
功能说明:  设参数是否自动生成的,默认为false
调用举例:     

 

writeExternal

  法:  public void writeExternal(java.io.ObjectOutput out)
参数说明:   out – ObjectOutput
功能说明:   序列化输出本类
调用举例:  

 

readExternal

  法:  public void readExternal(java.io.ObjectInput in)

参数说明:  in – ObjectInput

功能说明:  序列化输出本类

调用举例: 

 

Serialize

  法:  public byte[] serialize()

功能说明:  序列化输出本类

Returns    字符数组

调用举例: 

 

fillRecord

  法:  public void fillRecord(byte[] buf)

参数说明:  buf – byte[]  字符数组

功能说明:  序列化输出本类

调用举例: 

 

deepClone

  法:  public java.lang.Object deepClone()

功能说明:  克隆本类

Returns   克隆成功后返回的Object对象

调用举例: