Package org.frankframework.jdbc

Class Result2LobWriterBase

java.lang.Object

org.frankframework.batch.AbstractResultHandler

org.frankframework.batch.ResultWriter

org.frankframework.jdbc.Result2LobWriterBase

All Implemented Interfaces:

IResultHandler, FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, IWithParameters, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

Result2BlobWriter, Result2ClobWriter

public abstract class Result2LobWriterBase
extends ResultWriter
implements org.springframework.context.ApplicationContextAware

Baseclass for batch resultHandler that writes the transformed record to a LOB.

Since:

4.7

Author:

Gerrit van Brakel

Parameters

any parameters defined on the resultHandler will be applied to the SQL statement

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Connection>	openConnections
protected Map<String,Object>	openLobHandles
protected Map<String,ResultSet>	openResultSets
protected FixedQuerySender	querySender

Fields inherited from class org.frankframework.batch.AbstractResultHandler

log, paramList

Constructor Summary

Constructors

Constructor	Description
Result2LobWriterBase()

Method Summary

Modifier and Type	Method	Description
void	close()
void	configure()	Configure this component.
protected Writer	createWriter(PipeLineSession session, String streamId)
String	finalizeResult(PipeLineSession session, String streamId, boolean error)	Called when all records in the original file are handled.
protected abstract Object	getLobHandle(IDbmsSupport dbmsSupport, ResultSet rs)
String	getPhysicalDestinationName()
protected abstract Writer	getWriter(IDbmsSupport dbmsSupport, Object lobHandle, ResultSet rs)
void	open()
void	setDatasourceName(String datasourceName)
void	setJmsRealm(String jmsRealmName)
void	setQuery(String query)	The SQL query text
protected abstract void	updateLob(IDbmsSupport dbmsSupport, Object lobHandle, ResultSet rs)

Methods inherited from class org.frankframework.batch.ResultWriter

closeBlock, closeDocument, closeRecordType, getWriter, handleResult, openBlock, openDocument, openRecordType, replacePattern, setBlockNamePattern, setOnCloseBlock, setOnCloseDocument, setOnOpenBlock, setOnOpenDocument, writeNewLine

Methods inherited from class org.frankframework.batch.AbstractResultHandler

addParameter, getParameterList, hasPrefix, isDefault, setBlockByRecordType, setDefault, setName, setPipe, setPrefix, setSuffix

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.batch.IResultHandler

isBlockByRecordType

Field Details

openConnections

protected Map<String,Connection> openConnections

openResultSets

protected Map<String,ResultSet> openResultSets

openLobHandles

protected Map<String,Object> openLobHandles

querySender

protected FixedQuerySender querySender

Constructor Details

Result2LobWriterBase

public Result2LobWriterBase()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractResultHandler

Throws:

ConfigurationException - in case it was not able to configure the component.

open

public void open()
          throws SenderException

Specified by:

open in interface IResultHandler

Overrides:

open in class AbstractResultHandler

Throws:

SenderException

close

public void close()
           throws SenderException

Specified by:

close in interface IResultHandler

Overrides:

close in class AbstractResultHandler

Throws:

SenderException

getLobHandle

protected abstract Object getLobHandle(IDbmsSupport dbmsSupport,
 ResultSet rs)
                                throws SenderException

Throws:

SenderException

getWriter

protected abstract Writer getWriter(IDbmsSupport dbmsSupport,
 Object lobHandle,
 ResultSet rs)
                             throws SenderException

Throws:

SenderException

updateLob

protected abstract void updateLob(IDbmsSupport dbmsSupport,
 Object lobHandle,
 ResultSet rs)
                           throws SenderException

Throws:

SenderException

createWriter

protected Writer createWriter(PipeLineSession session,
 String streamId)
                       throws Exception

Specified by:

createWriter in class ResultWriter

Throws:

Exception

finalizeResult

public String finalizeResult(PipeLineSession session,
 String streamId,
 boolean error)
                      throws Exception

Description copied from interface: IResultHandler

Called when all records in the original file are handled.

Specified by:

finalizeResult in interface IResultHandler

Overrides:

finalizeResult in class ResultWriter

Parameters:

session - current PipeLineSession

streamId - identification of the original file/stream/message containing the untransformed records

Returns:

the name or names of the output files

Throws:

Exception

setQuery

public void setQuery(String query)

The SQL query text

setDatasourceName

@ReferTo(FixedQuerySender.class)
public void setDatasourceName(String datasourceName)

getPhysicalDestinationName

@ReferTo(FixedQuerySender.class)
public String getPhysicalDestinationName()

setJmsRealm

@ReferTo(FixedQuerySender.class)
public void setJmsRealm(String jmsRealmName)