com.whitestein.lsps.stdlib.function

Interface DataFunctions

All Known Implementing Classes:

DataFunctionsImpl

public interface DataFunctions

Author:

rba

Method Summary

Modifier and Type	Method and Description
RecordHolder	createBinaryHandle(ExecutionContext context, java.lang.String fileName, java.lang.String description, java.lang.String content) Creates binary handle.
RecordHolder	createBinaryHandle(ExecutionContext context, java.lang.String fileName, java.lang.String description, java.lang.String content, java.lang.String mime, java.lang.String charset) Creates binary handle.
RecordHolder	getBinaryHandle(ExecutionContext context, Decimal id) Returns a binary handle of the specified identifier.
RecordHolder	resource(ExecutionContext context, java.lang.String module, java.lang.String path) Creates a binary handle from a module's resource located at the specified path.
Decimal	size(ExecutionContext ctx, BinaryHolder binary) Returns the size of the binary data in bytes.
BinaryHolder	toBinary(ExecutionContext ctx, java.lang.String str) Converts the specified string to binary.
java.lang.String	toString(ExecutionContext ctx, BinaryHolder binary, java.lang.String charset) Converts binary to string.

Method Detail

resource

RecordHolder resource(ExecutionContext context,
                      java.lang.String module,
                      java.lang.String path)
               throws ErrorException

Creates a binary handle from a module's resource located at the specified path.

Parameters:

context -

module - name of module

path - path to binary content

Returns:

a binary handle from a module's resource located at the specified path

Throws:

ErrorException

getBinaryHandle

RecordHolder getBinaryHandle(ExecutionContext context,
                             Decimal id)
                      throws ErrorException

Returns a binary handle of the specified identifier.

Parameters:

context -

id -

Returns:

a binary handle of the specified identifier

Throws:

ErrorException

createBinaryHandle

RecordHolder createBinaryHandle(ExecutionContext context,
                                java.lang.String fileName,
                                java.lang.String description,
                                java.lang.String content)
                         throws ErrorException

Creates binary handle.

Parameters:

context -

fileName -

description -

content -

Returns:

created binary handle

Throws:

ErrorException

createBinaryHandle

RecordHolder createBinaryHandle(ExecutionContext context,
                                java.lang.String fileName,
                                java.lang.String description,
                                java.lang.String content,
                                java.lang.String mime,
                                java.lang.String charset)
                         throws ErrorException

Creates binary handle.

Parameters:

context -

fileName -

description -

content -

mime -

charset -

Returns:

created binary handle

Throws:

ErrorException

toBinary

BinaryHolder toBinary(ExecutionContext ctx,
                      java.lang.String str)

Converts the specified string to binary.

Parameters:

ctx -

str -

Returns:

binary holder

toString

java.lang.String toString(ExecutionContext ctx,
                          BinaryHolder binary,
                          java.lang.String charset)
                   throws ErrorException

Converts binary to string.

Parameters:

ctx -

binary -

charset -

Returns:

string

Throws:

ErrorException

size

Decimal size(ExecutionContext ctx,
             BinaryHolder binary)
      throws ErrorException

Returns the size of the binary data in bytes.

Parameters:

ctx -

binary -

Returns:

size of the binary

Throws:

ErrorException