OracleOciLob (Resin 4.0.s170329)

java.lang.Object
- com.caucho.quercus.lib.db.OracleOciLob

public class OracleOciLob
extends java.lang.Object

Quercus Oracle OCI-Lob object oriented API.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`append(Env env, OracleOciLob lobFrom)` Appends data from the large object to another large object
`boolean`	`close(Env env)` Closes LOB descriptor
`boolean`	`eof(Env env)` Tests for end-of-file on a large object's descriptor
`LongValue`	`erase(Env env, long offset, long length)` Erases a specified portion of the internal LOB data
`boolean`	`export(Env env, Path file, long start, long length)` Exports LOB's contents to a file
`boolean`	`flush(Env env, int flag)` Flushes/writes buffer of the LOB to the server
`boolean`	`free(Env env)` Frees resources associated with the LOB descriptor
`boolean`	`getBuffering(Env env)` Returns current state of buffering for the large object
`java.lang.Object`	`load(Env env)` Returns large object's contents
`boolean`	`q_import(Env env, Path file)` Imports file data to the LOB
`java.lang.Object`	`read(Env env, long length)` Reads part of the large object
`boolean`	`rewind(Env env)` Moves the internal pointer to the beginning of the large object
`boolean`	`save(Env env, java.lang.String data, long offset)` Saves data to the large object
`boolean`	`saveFile(Env env, Path file)` Alias of import()
`boolean`	`seek(Env env, long offset, int whence)` Sets the internal pointer of the large object
`boolean`	`setBuffering(Env env, boolean onOff)` Changes current state of buffering for the large object
`protected void`	`setLob(java.lang.Object lob)` Sets the underlying LOB
`LongValue`	`size(Env env)` Returns size of large object
`LongValue`	`tell(Env env)` Returns current position of internal pointer of large object
`java.lang.String`	`toString()`
`boolean`	`truncate(Env env, long length)` Truncates large object
`LongValue`	`write(Env env, java.lang.String data, long length)` Writes data to the large object
`boolean`	`writeTemporary(Env env, java.lang.String data, int lobType)` Writes temporary large object
`boolean`	`writeToFile(Env env, Path file, long start, long length)` Alias of export()

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

append

public boolean append(Env env,
                      OracleOciLob lobFrom)

Appends data from the large object to another large object

close
```
public boolean close(Env env)
```
Closes LOB descriptor

eof
```
public boolean eof(Env env)
```
Tests for end-of-file on a large object's descriptor

erase
```
public LongValue erase(Env env,
                       long offset,
                       long length)
```
Erases a specified portion of the internal LOB data

Returns:

the actual number of characters/bytes erased or FALSE in case of error.

export

public boolean export(Env env,
                      Path file,
                      long start,
                      long length)

Exports LOB's contents to a file

flush

public boolean flush(Env env,
                     int flag)

Flushes/writes buffer of the LOB to the server

free
```
public boolean free(Env env)
```
Frees resources associated with the LOB descriptor

getBuffering
```
public boolean getBuffering(Env env)
```
Returns current state of buffering for the large object

q_import

public boolean q_import(Env env,
                        Path file)

Imports file data to the LOB

load

public java.lang.Object load(Env env)

Returns large object's contents

read

public java.lang.Object read(Env env,
                             long length)

Reads part of the large object

rewind
```
public boolean rewind(Env env)
```
Moves the internal pointer to the beginning of the large object

save

public boolean save(Env env,
                    java.lang.String data,
                    long offset)

Saves data to the large object

saveFile

public boolean saveFile(Env env,
                        Path file)

Alias of import()

seek

public boolean seek(Env env,
                    long offset,
                    int whence)

Sets the internal pointer of the large object

setBuffering

public boolean setBuffering(Env env,
                            boolean onOff)

Changes current state of buffering for the large object

setLob

protected void setLob(java.lang.Object lob)

Sets the underlying LOB

size
```
public LongValue size(Env env)
```
Returns size of large object

tell
```
public LongValue tell(Env env)
```
Returns current position of internal pointer of large object

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

truncate

public boolean truncate(Env env,
                        long length)

Truncates large object

write

public LongValue write(Env env,
                       java.lang.String data,
                       long length)

Writes data to the large object

writeTemporary

public boolean writeTemporary(Env env,
                              java.lang.String data,
                              int lobType)

Writes temporary large object

writeToFile

public boolean writeToFile(Env env,
                           Path file,
                           long start,
                           long length)

Alias of export()

Class OracleOciLob

Method Summary

Methods inherited from class java.lang.Object

Method Detail

append

close

eof

erase