wt.pds
Class AbstractArrayStatementParameter

java.lang.Object
  wt.pds.AbstractArrayStatementParameter

All Implemented Interfaces:

DatastoreTypeStatementParameter, Externalizable, Serializable, StatementParameter

Direct Known Subclasses:

ArrayStatementParameter, BaselineMemberTupleArrayStatement, SQLServerArrayStatementParameter

public abstract class AbstractArrayStatementParameter

extends Object

implements DatastoreTypeStatementParameter, Externalizable

This class is used to pass an Array of values to a Statement as a parameter. The array can be of built-in types or a user defined structure, if structTypeName is not null.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private String	arrayTypeName
private static String	CLASSNAME
private ClassInfo	datastoreType
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private String	structTypeName
private Object	value

Fields inherited from interface wt.pds.DatastoreTypeStatementParameter

DATASTORE_TYPE

Fields inherited from interface wt.pds.StatementParameter

VALUE

Constructor Summary

AbstractArrayStatementParameter()


Supported API: false

AbstractArrayStatementParameter(Class a_arrayTypeClass, Object a_value)

AbstractArrayStatementParameter(String a_arrayTypeName, Object a_value)


Supported API: false

AbstractArrayStatementParameter(String a_arrayTypeName, Object a_value, String a_structTypeName)


Supported API: false

Method Summary

private void	arrayTypeNameValidate(String a_ArrayTypeName)
void	getArgumentValue(WTConnection a_connection, CallableStatement a_statement, int a_index) This method gets the value from the statement.
String	getArrayTypeName() Gets the value of the attribute: arrayTypeName; Type name of the Array Supported API: false
ClassInfo	getDatastoreType() Gets the value of the attribute: datastoreType; The Datastore Type to encode the values as.
String	getStructTypeName() Gets the value of the attribute: structTypeName; Type name of the structure.
Object	getValue() Gets the value of the attribute: value; Value of the StatementParameter Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(AbstractArrayStatementParameter thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	registerOutput(CallableStatement a_statement, int a_index) Registers this parameter as an output value Supported API: false
abstract void	setArgumentValue(WTConnection a_connection, PreparedStatement a_statement, int a_index) This method sets the value into the statement as an argument.
void	setArrayTypeName(String a_ArrayTypeName) Sets the value of the attribute: arrayTypeName; Type name of the Array Supported API: false
void	setDatastoreType(ClassInfo a_DatastoreType) Sets the value of the attribute: datastoreType; The Datastore Type to encode the values as.
void	setStructTypeName(String a_StructTypeName) Sets the value of the attribute: structTypeName; Type name of the structure.
void	setValue(Object a_Value) Sets the value of the attribute: value; Value of the StatementParameter Supported API: false
private void	structTypeNameValidate(String a_StructTypeName)
String	toString()
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

arrayTypeName

private String arrayTypeName

structTypeName

private String structTypeName

datastoreType

private ClassInfo datastoreType

value

private Object value

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

AbstractArrayStatementParameter

public AbstractArrayStatementParameter()

Supported API: false

AbstractArrayStatementParameter

public AbstractArrayStatementParameter(String a_arrayTypeName,
                                       Object a_value)
                                throws WTPropertyVetoException

Supported API: false

Parameters:

a_arrayTypeName -

a_value -

Throws:

WTPropertyVetoException

AbstractArrayStatementParameter

public AbstractArrayStatementParameter(String a_arrayTypeName,
                                       Object a_value,
                                       String a_structTypeName)
                                throws WTPropertyVetoException

Supported API: false

Parameters:

a_arrayTypeName -

a_value -

a_structTypeName -

Throws:

WTPropertyVetoException

AbstractArrayStatementParameter

public AbstractArrayStatementParameter(Class a_arrayTypeClass,
                                       Object a_value)
                                throws WTPropertyVetoException

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(AbstractArrayStatementParameter thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

getArrayTypeName

public String getArrayTypeName()

Gets the value of the attribute: arrayTypeName; Type name of the Array

Supported API: false

Returns:

String

setArrayTypeName

public void setArrayTypeName(String a_ArrayTypeName)
                      throws WTPropertyVetoException

Sets the value of the attribute: arrayTypeName; Type name of the Array

Supported API: false

Parameters:

a_ArrayTypeName -

Throws:

WTPropertyVetoException

arrayTypeNameValidate

private void arrayTypeNameValidate(String a_ArrayTypeName)
                            throws WTPropertyVetoException

Parameters:

a_ArrayTypeName -

Throws:

WTPropertyVetoException

getStructTypeName

public String getStructTypeName()

Gets the value of the attribute: structTypeName; Type name of the structure. If this name is not specified, then the object value is used directly as the Array value.

Supported API: false

Returns:

String

setStructTypeName

public void setStructTypeName(String a_StructTypeName)
                       throws WTPropertyVetoException

Sets the value of the attribute: structTypeName; Type name of the structure. If this name is not specified, then the object value is used directly as the Array value.

Supported API: false

Parameters:

a_StructTypeName -

Throws:

WTPropertyVetoException

structTypeNameValidate

private void structTypeNameValidate(String a_StructTypeName)
                             throws WTPropertyVetoException

Parameters:

a_StructTypeName -

Throws:

WTPropertyVetoException

setArgumentValue

public abstract void setArgumentValue(WTConnection a_connection,
                                      PreparedStatement a_statement,
                                      int a_index)
                               throws SQLException,
                                      WTException

This method sets the value into the statement as an argument.

Supported API: false

Specified by:

setArgumentValue in interface StatementParameter

Parameters:

a_connection - Connection to use

a_statement - Statement to set the parameter in

a_index - Index of the parameter in the statement

Throws:

SQLException

WTException

getArgumentValue

public void getArgumentValue(WTConnection a_connection,
                             CallableStatement a_statement,
                             int a_index)
                      throws SQLException,
                             WTException

This method gets the value from the statement.

Supported API: false

Specified by:

getArgumentValue in interface StatementParameter

Parameters:

a_connection - Connection to use

a_statement - Statement to set the parameter in

a_index - Index of the parameter in the statement

Throws:

SQLException

WTException

registerOutput

public void registerOutput(CallableStatement a_statement,
                           int a_index)
                    throws SQLException

Registers this parameter as an output value

Supported API: false

Specified by:

registerOutput in interface StatementParameter

Parameters:

a_statement -

a_index - Statement parameter index

Throws:

SQLException

getDatastoreType

public ClassInfo getDatastoreType()

Gets the value of the attribute: datastoreType; The Datastore Type to encode the values as.

Supported API: false

Specified by:

getDatastoreType in interface DatastoreTypeStatementParameter

Returns:

ClassInfo

setDatastoreType

public void setDatastoreType(ClassInfo a_DatastoreType)
                      throws WTPropertyVetoException

Sets the value of the attribute: datastoreType; The Datastore Type to encode the values as.

Supported API: false

Specified by:

setDatastoreType in interface DatastoreTypeStatementParameter

Parameters:

a_DatastoreType -

Throws:

WTPropertyVetoException

getValue

public Object getValue()

Gets the value of the attribute: value; Value of the StatementParameter

Supported API: false

Specified by:

getValue in interface StatementParameter

Returns:

Object

setValue

public void setValue(Object a_Value)
              throws WTPropertyVetoException

Sets the value of the attribute: value; Value of the StatementParameter

Supported API: false

Specified by:

setValue in interface StatementParameter

Parameters:

a_Value -

Throws:

WTPropertyVetoException

toString

public String toString()