com.ddtek.jxtr
Class JXTRUpdateBase

java.lang.Object
  |
  +--com.ddtek.jxtr.JXTRBase
        |
        +--com.ddtek.jxtr.JXTRUpdateBase

Direct Known Subclasses:

JXTRSingleTableUpdate, JXTRUpdate

public abstract class JXTRUpdateBase

extends JXTRBase

JXTRUpdateBase is an abstract base class implementing a number of methods shared between all jXTransformer write classes (JXTRSingleTableUpdate, JXTRUpdate).

Field Summary

 

Fields inherited from class com.ddtek.jxtr.JXTRBase

BINARY_AS_BASE64, BINARY_AS_HEX, TIMESTAMP_AS_ISO8601, TIMESTAMP_AS_ODBC

 

Constructor Summary

JXTRUpdateBase()           Constructs a new JXTRUpdateBase object.

 

Method Summary
int	getBatchSize()           Gets the maximum number of JDBC batch entries that can be executed at the same time.
int	getBinaryEncoding()           Returns the type of binary encoding/decoding.
java.lang.String	getNullRepresentationValue()           Gets the value that was set to represent a NULL value.
int	getTimestampEncoding()           Returns the type of timestamp encoding/decoding.
boolean	getUseNullReplacementWithNullRepresentation()           Gets the flag setting that instructs Connect for SQL/XML whether to use the NULL replacement value instead of a database NULL value when a NULL replacement value and a NULL representation value are both specified.
void	setBatchSize(int size)           Sets the maximum number of JDBC batch entries that can be executed at the same time.
void	setBigDecimal(int paramIx, java.math.BigDecimal paramValue)           Sets the specified parameter index to the specified BigDecimal value.
void	setBinaryEncoding(int binaryCoding)           Sets the type of encoding/decoding for binary values (either BINARY_AS_BASE64 or BINARY_AS_HEX).
void	setBoolean(int paramIx, boolean paramValue)           Sets the specified parameter index to the specified boolean value.
void	setByte(int paramIx, byte paramValue)           Sets the specified parameter index to the specified byte value.
void	setBytes(int paramIx, byte[] paramValue)           Sets the specified parameter index to the specified byte array value.
void	setDate(int paramIx, java.sql.Date paramValue)           Sets the specified parameter index to the specified date value.
void	setDouble(int paramIx, double paramValue)           Sets the specified parameter index to the specified double value.
void	setFloat(int paramIx, float paramValue)           Sets the specified parameter index to the specified float value.
void	setInt(int paramIx, int paramValue)           Sets the specified parameter index to the specified int value.
void	setLong(int paramIx, long paramValue)           Sets the specified parameter index to the specified long value.
void	setNull(int paramIx, int jdbcType)           Sets the specified parameter index to a NULL value.
void	setNullReplacementValue(java.lang.String defNullValue)           Sets the replacement value to use when an XPath expression does not return a value.
void	setNullRepresentationValue(java.lang.String nullValue)           Sets a value that will be replaced with NULL when the value is encountered as the result of an XPath expression.
void	setObject(int paramIx, java.lang.Object paramValue)           Sets the specified parameter index to the specified object.
void	setObject(int paramIx, java.lang.Object paramValue, int targetJdbcType)           Sets the specified parameter index to the specified object.
void	setObject(int paramIx, java.lang.Object paramValue, int targetJdbcType, int scale)           Sets the specified parameter index to the specified object.
void	setShort(int paramIx, short paramValue)           Sets the specified parameter index to the specified short value.
void	setString(int paramIx, java.lang.String paramValue)           Sets the specified parameter index to the specified string value.
void	setTime(int paramIx, java.sql.Time paramValue)           Sets the specified parameter index to the specified time value.
void	setTimestamp(int paramIx, java.sql.Timestamp paramValue)           Sets the specified parameter index to the specified timestamp value.
void	setTimestampEncoding(int timestampCoding)           Sets the type of encoding/decoding for timestamp values (either TIMESTAMP_AS_ISO8601 or TIMESTAMP_AS_ODBC ).
void	setUseNullReplacementWithNullRepresentation(boolean enable)           Sets a boolean flag that instructs Connect for SQL/XML which value to use when both a NULL replacement value and a NULL representation value are specified.

 

Methods inherited from class com.ddtek.jxtr.JXTRBase

clearWarnings, close, getPreparedStatementCloseBehaviour, getWarnings, setPreparedStatementCloseBehaviour, unlock

 

Methods inherited from class java.lang.Object

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

 

Constructor Detail

JXTRUpdateBase

public JXTRUpdateBase()

Constructs a new JXTRUpdateBase object.

setString

public void setString(int paramIx,
                      java.lang.String paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified string value.

Specified by:

setString in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setString

setDate

public void setDate(int paramIx,
                    java.sql.Date paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified date value.

Specified by:

setDate in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setDate

setBoolean

public void setBoolean(int paramIx,
                       boolean paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified boolean value.

Specified by:

setBoolean in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setBoolean

setBigDecimal

public void setBigDecimal(int paramIx,
                          java.math.BigDecimal paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified BigDecimal value.

Specified by:

setBigDecimal in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setBigDecimal

setTimestamp

public void setTimestamp(int paramIx,
                         java.sql.Timestamp paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified timestamp value.

Specified by:

setTimestamp in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setTimestamp

setLong

public void setLong(int paramIx,
                    long paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified long value.

Specified by:

setLong in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setLong

setByte

public void setByte(int paramIx,
                    byte paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified byte value.

Specified by:

setByte in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setByte

setBytes

public void setBytes(int paramIx,
                     byte[] paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified byte array value.

Specified by:

setBytes in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setBytes

setDouble

public void setDouble(int paramIx,
                      double paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified double value.

Specified by:

setDouble in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setDouble

setShort

public void setShort(int paramIx,
                     short paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified short value.

Specified by:

setShort in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setShort

setTime

public void setTime(int paramIx,
                    java.sql.Time paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified time value.

Specified by:

setTime in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setTime

setFloat

public void setFloat(int paramIx,
                     float paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified float value.

Specified by:

setFloat in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setFloat

setInt

public void setInt(int paramIx,
                   int paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified int value.

Specified by:

setInt in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setInt

setObject

public void setObject(int paramIx,
                      java.lang.Object paramValue)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified object.

Specified by:

setObject in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

See Also:

java.sql.PreparedStatement.setObject

setObject

public void setObject(int paramIx,
                      java.lang.Object paramValue,
                      int targetJdbcType)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified object.

Specified by:

setObject in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

targetJdbcType - Target JDBC type for the parameter

See Also:

java.sql.PreparedStatement.setObject

setObject

public void setObject(int paramIx,
                      java.lang.Object paramValue,
                      int targetJdbcType,
                      int scale)

Description copied from class: JXTRBase

Sets the specified parameter index to the specified object.

Specified by:

setObject in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

paramValue - Value for the parameter

targetJdbcType - Target JDBC type for the parameter

scale - Scale for numeric and decimal JDBC types

See Also:

java.sql.PreparedStatement.setObject

setNull

public void setNull(int paramIx,
                    int jdbcType)

Description copied from class: JXTRBase

Sets the specified parameter index to a NULL value.

Specified by:

setNull in class JXTRBase

Parameters:

paramIx - Index of parameter to set (1 based)

jdbcType - JDBC type for the parameter

See Also:

java.sql.PreparedStatement.setNull

setTimestampEncoding

public void setTimestampEncoding(int timestampCoding)

Sets the type of encoding/decoding for timestamp values (either TIMESTAMP_AS_ISO8601 or TIMESTAMP_AS_ODBC ). Default is TIMESTAMP_AS_ODBC.

Specified by:

setTimestampEncoding in class JXTRBase

getTimestampEncoding

public int getTimestampEncoding()

Returns the type of timestamp encoding/decoding.

Specified by:

getTimestampEncoding in class JXTRBase

Returns:

TIMESTAMP_AS_ISO8601 or TIMESTAMP_AS_ODBC.

setBinaryEncoding

public void setBinaryEncoding(int binaryCoding)

Sets the type of encoding/decoding for binary values (either BINARY_AS_BASE64 or BINARY_AS_HEX). Default is BINARY_AS_BASE64.

Specified by:

setBinaryEncoding in class JXTRBase

getBinaryEncoding

public int getBinaryEncoding()

Returns the type of binary encoding/decoding.

Specified by:

getBinaryEncoding in class JXTRBase

Returns:

BINARY_AS_BASE64 or BINARY_AS_HEX.

setNullReplacementValue

public void setNullReplacementValue(java.lang.String defNullValue)

Sets the replacement value to use when an XPath expression does not return a value.

By default, Connect for SQL/XML will use NULL when an XPath expression does not return a value. Default behaviour can be overridden by invoking this method and specifying a value to use instead of NULL.

Specified by:

setNullReplacementValue in class JXTRBase

Parameters:

defNullValue - Value to use instead of NULL.

setNullRepresentationValue

public void setNullRepresentationValue(java.lang.String nullValue)

Sets a value that will be replaced with NULL when the value is encountered as the result of an XPath expression.

Parameters:

nullValue - Value that is replaced by a NULL value.

getNullRepresentationValue

public java.lang.String getNullRepresentationValue()

Gets the value that was set to represent a NULL value.

Returns:

Value that was set to represent a NULL value.

See Also:

setNullRepresentationValue(java.lang.String)

setUseNullReplacementWithNullRepresentation

public void setUseNullReplacementWithNullRepresentation(boolean enable)

Sets a boolean flag that instructs Connect for SQL/XML which value to use when both a NULL replacement value and a NULL representation value are specified. Default is true (enable NULL replacement value if set).

When only a NULL representation value is set, a database NULL value is used. If a NULL replacement value is set in addition to the NULL representation value and this flag is set to true, the value is replaced with the NULL replacement value instead of a database NULL value.

Parameters:

enable - If true and a NULL replacement value has been set, the NULL replacement value will be used instead of a database NULL value. If false, a database NULL value is always used, even if the NULL replacement value is specified.

See Also:

setNullReplacementValue(java.lang.String)., setNullRepresentationValue(java.lang.String).

getUseNullReplacementWithNullRepresentation

public boolean getUseNullReplacementWithNullRepresentation()

Gets the flag setting that instructs Connect for SQL/XML whether to use the NULL replacement value instead of a database NULL value when a NULL replacement value and a NULL representation value are both specified.

Returns:

whether to use a NULL replacement value instead of a database NULL value when a NULL replacement value and a NULL representation value are both specified.

See Also:

setUseNullReplacementWithNullRepresentation(boolean).

setBatchSize

public void setBatchSize(int size)
                  throws java.lang.IllegalArgumentException

Sets the maximum number of JDBC batch entries that can be executed at the same time.

The default value is 0 (the complete set of input parameters, as determined by the combination of the input XML document, row pattern, and XPath expressions, will be sent as one batch to the database.

This method can be used to restrict the size of batches. If the number of parameter sets is greater than the maximum batch size, multiple batches are executed.

Parameters:

size - Maximum JDBC batch size.

Throws:

java.lang.IllegalArgumentException - if size < 0 .

getBatchSize

public int getBatchSize()

Gets the maximum number of JDBC batch entries that can be executed at the same time.

See Also:

setBatchSize(int).