com.adaptris.core.jms.oracle

Class ClobType

java.lang.Object

com.adaptris.core.jms.oracle.ClobType

All Implemented Interfaces:

TypeWrapper

public class ClobType
extends java.lang.Object
implements TypeWrapper

Handles CLOB fields.

When creating a clob, this creates a temporary clob in which to store data.

See Also:

CLOB.createTemporary(java.sql.Connection, boolean, int)

In the adapter configuration file this class is aliased as oracleaq-clob-type which is the preferred alternative to the fully qualified classname when building your configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClobType.Duration The Duration of the CLOB when attempting to create a temporary clob.
static class	ClobType.Handler Handling different types of CLOB data.

Constructor Summary

Constructors

Constructor and Description
ClobType() Default constructor
ClobType(ClobType.Duration duration, boolean cache)
ClobType(ClobType.Duration duration, boolean cache, ClobType.Handler handler)

Method Summary

Modifier and Type	Method and Description
boolean	getCache()
ClobType.Handler	getClobHandler()
ClobType.Duration	getDuration()
void	setCache(boolean b) Specify whether or not the temporary LOB should be read into the buffer cache or not.
void	setClobHandler(ClobType.Handler s) Specify how to handle the underlying CLOB.
void	setDuration(ClobType.Duration s) Specify the duration of the temporary LOB.
java.lang.String	unwrap(java.lang.Object o, AdtMessageTranslator dt) Convert the wrapped Object type into a string.
java.lang.Object	wrap(java.lang.String s, AdtMessageTranslator c) Convert the string into a wrapped object for Oracle AdtMessages

Methods inherited from class java.lang.Object

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

Constructor Detail

ClobType

public ClobType()

Default constructor

ClobType

public ClobType(ClobType.Duration duration,
                boolean cache)

Parameters:

duration - the duration of the clob

cache - whether or not temporary LOB should be read into the buffer

See Also:

setDuration(Duration), setCache(boolean)

ClobType

public ClobType(ClobType.Duration duration,
                boolean cache,
                ClobType.Handler handler)

Parameters:

duration - the duration of the clob

cache - whether or not temporary LOB should be read into the buffer

handler - of input stream to use.

See Also:

setDuration(Duration), setCache(boolean), setClobHandler(Handler)

Method Detail

wrap

public java.lang.Object wrap(java.lang.String s,
                             AdtMessageTranslator c)
                      throws java.sql.SQLException,
                             java.io.IOException,
                             javax.jms.JMSException

Description copied from interface: TypeWrapper

Convert the string into a wrapped object for Oracle AdtMessages

Specified by:

wrap in interface TypeWrapper

Parameters:

s - the string to convert

c - the AdtMessageTranslator instance.

Returns:

the wrapped object.

Throws:

java.sql.SQLException

java.io.IOException

javax.jms.JMSException

unwrap

public java.lang.String unwrap(java.lang.Object o,
                               AdtMessageTranslator dt)
                        throws java.sql.SQLException,
                               java.io.IOException,
                               javax.jms.JMSException

Description copied from interface: TypeWrapper

Convert the wrapped Object type into a string.

Specified by:

unwrap in interface TypeWrapper

Parameters:

o - the object to convert

dt - the AdtMessageTranslator instance.

Returns:

a string representation of the wrapped object.

Throws:

java.sql.SQLException

java.io.IOException

javax.jms.JMSException

getCache

public boolean getCache()

Returns:

the cached

setCache

public void setCache(boolean b)

Specify whether or not the temporary LOB should be read into the buffer cache or not.

Parameters:

b - the cached to set

getDuration

public ClobType.Duration getDuration()

Returns:

the duration

setDuration

public void setDuration(ClobType.Duration s)

Specify the duration of the temporary LOB. The following are valid values: DURATION_SESSION, DURATION_CALL.

Parameters:

s - the duration to set

See Also:

ClobType.Duration

getClobHandler

public ClobType.Handler getClobHandler()

Returns:

the clob handler

setClobHandler

public void setClobHandler(ClobType.Handler s)

Specify how to handle the underlying CLOB.

Parameters:

s - the handler to use valid types are "CHARACTER" or "ASCII", default is "ASCII"

See Also:

ClobType.Handler, ClobType.Handler.CHARACTER, ClobType.Handler.ASCII