com.moximedia.aims
Class SqlParameter

java.lang.Object
  com.moximedia.aims.SqlParameter

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SqlParameter

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable

The SqlParameter class is used by the SqlReport object to represent a replaceable parameter for use in constructing a SQL query string.

Author:

jdc

See Also:

Serialized Form

Field Summary

static int	PARAMETER_TYPE_DATABASE_COLUMN_INDEX
static int	PARAMETER_TYPE_DATABASE_COLUMN_VALUE
static int	PARAMETER_TYPE_FAT_FIELD_VALUE

Constructor Summary

SqlParameter()
Creates a new instance of SqlParameter

Method Summary

java.lang.Object	clone()
int	getColumnIndex()
SqlParameter	getCopy()
java.lang.String	getFieldName()
int	getObjectId() Returns the IMF internal object id for this object, guaranteed to be different from any other oobject of this type in the currently running application.
int	getParameterType()
java.lang.String	getValue(AimsRecordset rs)
boolean	isValid()
void	setFieldName(java.lang.String fieldName)
void	setParameterType(int type)
void	setParameterType(java.lang.String type)
void	setXmlAttribute(java.lang.String tag, java.lang.String name, java.lang.String value) Sets one of the attributes of this object using a string value.

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_TYPE_FAT_FIELD_VALUE

public static final int PARAMETER_TYPE_FAT_FIELD_VALUE

See Also:

Constant Field Values

PARAMETER_TYPE_DATABASE_COLUMN_VALUE

public static final int PARAMETER_TYPE_DATABASE_COLUMN_VALUE

See Also:

Constant Field Values

PARAMETER_TYPE_DATABASE_COLUMN_INDEX

public static final int PARAMETER_TYPE_DATABASE_COLUMN_INDEX

See Also:

Constant Field Values

Constructor Detail

SqlParameter

public SqlParameter()

Creates a new instance of SqlParameter

Method Detail

getObjectId

public int getObjectId()

Returns the IMF internal object id for this object, guaranteed to be different from any other oobject of this type in the currently running application.

Returns:

The internal id for this object.

clone

public java.lang.Object clone()

getColumnIndex

public int getColumnIndex()

getCopy

public SqlParameter getCopy()

setParameterType

public void setParameterType(int type)

setParameterType

public void setParameterType(java.lang.String type)

getParameterType

public int getParameterType()

getFieldName

public java.lang.String getFieldName()

setFieldName

public void setFieldName(java.lang.String fieldName)

isValid

public boolean isValid()

setXmlAttribute

public void setXmlAttribute(java.lang.String tag,
                            java.lang.String name,
                            java.lang.String value)

Sets one of the attributes of this object using a string value. This method should only be called from the SAX event handler.

Parameters:

tag - The XML element tag containing this attribute.

name - The XML attribute name.

value - The XML attribute value.

getValue

public java.lang.String getValue(AimsRecordset rs)