com.goldencode.p2j.util

Class LobCopy

java.lang.Object

com.goldencode.p2j.util.LobCopy

public class LobCopy
extends java.lang.Object

Object which performs a large object (LOB) copy operation. All configuration methods return the current object instance, to allow method chaining.

Field Summary

Fields

Modifier and Type	Field and Description
private LobCopyInput	source Source DMO to be copied
private java.lang.String	sourceCodePage Source content's code page; null for binary data
private boolean	sourceCodePageSet Test whether the CONVERT SOURCE CODEPAGE option was used, even if with unknown value.
private LobCopyOutput	target Target DMO into which to copy
private java.lang.String	targetCodePage Target content's code page; null for binary data

Constructor Summary

Constructors

Constructor and Description
LobCopy(LobCopyInput source, LobCopyOutput target) Constructor which accepts a source and target large object on which to perform the copy.

Method Summary

Modifier and Type	Method and Description
(package private) static LargeObject	assertParameterType(java.lang.Object obj) Assert that the given parameter is an instance of LargeObject.
private int	getDataLengthForOverlay(byte[] data) Gets data length for active 'overlay at' option.
(package private) static java.lang.String	getLobDefaultCodePage(LargeObject lob) Get the default code page of the given LOB.
void	run() Perform the copy.
LobCopy	sourceCodePage(java.lang.String sourceCodePage) Set the source's code page.
LobCopy	sourceCodePage(Text sourceCodePage) Set the source's code page.
LobCopy	targetCodePage(java.lang.String targetCodePage) Set the target's code page.
LobCopy	targetCodePage(Text targetCodePage) Set the target's code page.
LobCopy	targetCodePage(unknown unk) Set the target's code page.

Methods inherited from class java.lang.Object

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

Field Detail

source

private final LobCopyInput source

Source DMO to be copied

target

private final LobCopyOutput target

Target DMO into which to copy

sourceCodePage

private java.lang.String sourceCodePage

Source content's code page; null for binary data

sourceCodePageSet

private boolean sourceCodePageSet

Test whether the CONVERT SOURCE CODEPAGE option was used, even if with unknown value.

targetCodePage

private java.lang.String targetCodePage

Target content's code page; null for binary data

Constructor Detail

LobCopy

public LobCopy(LobCopyInput source,
               LobCopyOutput target)

Constructor which accepts a source and target large object on which to perform the copy.

Parameters:

source - Source object to be copied.

target - Target object into which to copy.

Method Detail

assertParameterType

static LargeObject assertParameterType(java.lang.Object obj)

Assert that the given parameter is an instance of LargeObject.

Parameters:

obj - An object expected to be of type LargeObject.

Returns:

obj cast to LargeObject.

Throws:

ConditionException - if lob is not an instance of LargeObject and we are not in silent error mode.

getLobDefaultCodePage

static java.lang.String getLobDefaultCodePage(LargeObject lob)

Get the default code page of the given LOB. If the LOB does not itself maintain an explicit code page, the equivalent of -cpinternal is returned.

Parameters:

lob - Large object.

Returns:

Default 4GL code page name.

sourceCodePage

public LobCopy sourceCodePage(Text sourceCodePage)

Set the source's code page.

Parameters:

sourceCodePage - Source code page.

Returns:

This object instance.

sourceCodePage

public LobCopy sourceCodePage(java.lang.String sourceCodePage)

Set the source's code page.

Parameters:

sourceCodePage - Source code page.

Returns:

This object instance.

targetCodePage

public LobCopy targetCodePage(unknown unk)

Set the target's code page.

Parameters:

unk - Unknown target code page.

Returns:

This object instance.

targetCodePage

public LobCopy targetCodePage(Text targetCodePage)

Set the target's code page.

Parameters:

targetCodePage - Target code page.

Returns:

This object instance.

targetCodePage

public LobCopy targetCodePage(java.lang.String targetCodePage)

Set the target's code page.

Parameters:

targetCodePage - Target code page.

Returns:

This object instance.

run

public void run()

Perform the copy. This method should only be invoked once all configuration methods have been invoked. In the typical use pattern, this method is called at the end of the method chain which starts with new LobCopy(source, target).

getDataLengthForOverlay

private int getDataLengthForOverlay(byte[] data)

Gets data length for active 'overlay at' option. The NULL bytes are valid in this case and can be used to make new data length for array content before first NULL byte.

Parameters:

data - The byte array to process.

Returns:

The effective data length.