com.goldencode.p2j.util

Class SourceLobFile

java.lang.Object

com.goldencode.p2j.util.LobCopyInput

com.goldencode.p2j.util.SourceLobFile

All Implemented Interfaces:

LobCopyParameter

public class SourceLobFile
extends LobCopyInput

An object which represents a client-side file which is the source of a converted COPY-LOB statement.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	myFile The name of the actual file.
private boolean	opened Marks the attempt to open the stream was performed.
private Stream	stream File stream for input file, which is a remote resource

Fields inherited from class com.goldencode.p2j.util.LobCopyInput

offset

Fields inherited from interface com.goldencode.p2j.util.LobCopyParameter

TYPE_BLOB, TYPE_CHAR_BIT, TYPE_CLOB, TYPE_FIELD_BIT, TYPE_FILE, TYPE_LONGCHAR, TYPE_MEMPTR, TYPE_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
SourceLobFile(character filename) Constructor which accepts a filename.
SourceLobFile(java.lang.String filename) Constructor which accepts a filename.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFileName() Obtain the name of the file.
private static java.lang.String	getFilename(character filename) Extract the filename from the given parameter.
int	getObjectType() Obtain the type of the object wrapped by this parameter
protected int	getSize() Get the size of the object to be copied.
private boolean	openStream() Opens the stream if not already open.
byte[]	readBytes() Read a specific number of bytes from the file, starting at this parameter's offset.
java.lang.String	readString(java.lang.String codePage) Read a specific number of characters from the file, starting at this parameter's offset.
boolean	validateOffset(int targetType) Checks if the optional offset is valid.

Methods inherited from class com.goldencode.p2j.util.LobCopyInput

getLength, getOffset, length, length, offset, offset, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.util.LobCopyParameter

getCodePage, isCharacterData, isLargeObject

Field Detail

stream

private Stream stream

File stream for input file, which is a remote resource

opened

private boolean opened

Marks the attempt to open the stream was performed. If it was successful, stream != null.

myFile

private final java.lang.String myFile

The name of the actual file.

Constructor Detail

SourceLobFile

public SourceLobFile(java.lang.String filename)

Constructor which accepts a filename.

Parameters:

filename - Name of file from which to copy.

SourceLobFile

public SourceLobFile(character filename)

Constructor which accepts a filename.

Parameters:

filename - Name of file from which to copy. Must not be unknown.

Method Detail

getObjectType

public int getObjectType()

Obtain the type of the object wrapped by this parameter

Returns:

Always LobCopyParameter.TYPE_FILE.

readString

public java.lang.String readString(java.lang.String codePage)

Read a specific number of characters from the file, starting at this parameter's offset.

Specified by:

readString in class LobCopyInput

Parameters:

codePage - Name of the character set to be used to encode the read string. If null, the default charset will be used.

Returns:

String read from the file.

readBytes

public byte[] readBytes()

Read a specific number of bytes from the file, starting at this parameter's offset.

Specified by:

readBytes in class LobCopyInput

Returns:

Byte array read from the file.

getFileName

public java.lang.String getFileName()

Obtain the name of the file.

Returns:

the name of the file.

validateOffset

public boolean validateOffset(int targetType)

Checks if the optional offset is valid.

Parameters:

targetType - The type of the target object. The error messages are different in some cases (ignored?).

Returns:

true if the optional offset is valid.

getSize

protected int getSize()

Get the size of the object to be copied.

Specified by:

getSize in class LobCopyInput

Returns:

Size of object, in bytes or characters, as appropriate to the object type.

openStream

private boolean openStream()

Opens the stream if not already open. Otherwise nothing is performed.

Returns:

true if the stream can be used (ie. stream != null).

getFilename

private static java.lang.String getFilename(character filename)

Extract the filename from the given parameter. Raises an error if the specified object is unknown value.

Parameters:

filename - File name.

Returns:

String value of file name.