Skip Headers

PL/SQL Packages and Types Reference
10g Release 1 (10.1)

Part Number B10802-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Feedback

Go to previous page
Previous
Go to next page
Next
View PDF

136
OWA_TEXT

The OWA_TEXT package contains subprograms used by OWA_PATTERN for manipulating strings. They are externalized so you can use them directly.

See Also:

For more information about implementation of this package:

The chapter contains the following topics:


Using OWA_TEXT


Types

MULTI_LINE DATA TYPE

This data type is a PL/SQL record that holds large amounts of text. The rows field, of type OWA_TEXT.VC_ARR DATA TYPE, contains the text data in the record.

TYPE multi_line IS RECORD (
   rows           vc_arr,
   num_rows       INTEGER,
   partial_row    BOOLEAN);

ROW_LIST DATA TYPE

This is the data type for holding data to be processed.

TYPE row_list IS RECORD (
   rows           int_arr,
   num_rows       INTEGER);

int_arr IS DEFINED AS:

TYPE int_arr IS TABLE OF INTEGER INDEX BY BINARY_INTEGER;

VC_ARR DATA TYPE

This is a component of the MULTI_LINE DATA TYPE and is used for holding large amounts of text.

TYPE vc_arr IS TABLE OF VARCHAR2(32767) INDEX BY BINARY_INTEGER;

Summary of OWA_TEXT Subprograms

Table 136-1 OWA_TEXT Package Subprograms  
Subprogram Description

ADD2MULTI Procedure

Adds text to an existing multi_line type

NEW_ROW_LIST Function and Procedure

Creates a new row_list

PRINT_MULTI Procedure

Prints out the contents of a multi_list

PRINT_ROW_LIST Procedure

Prints out the contents of a row_list

STREAM2MULTI Procedure

Converts a varchar2 to a multi_line type


ADD2MULTI Procedure

This procedure adds content to an existing MULTI_LINE DATA TYPE.

Syntax

OWA_TEXT.ADD2MULTI(
   stream         IN       VARCHAR2,
   mline          IN OUT   multi_line,

   continue       IN       BOOLEAN   DEFAULT TRUE);

Parameters

Table 136-2  ADD2MULTI Procedure Parameters
Parameter Description

stream

The text to add.

mline

The OWA_TEXT.MULTI_LINE DATA TYPE. The output of this parameter contains stream.

continue

If TRUE, the procedure appends stream within the previous final row (assuming it is less than 32K). If FALSE, the procedure places stream in a new row.


NEW_ROW_LIST Function and Procedure

This function or procedure creates a new OWA_TEXT.ROW_LIST DATA TYPE. The function version uses no parameters and returns a new empty row_list. The procedure version creates the row_list data type as an output parameter.

Syntax

OWA_TEXT.NEW_ROW_LIST 
  RETURN ROW_LIST;

OWA_TEXT.NEW_ROW_LIST(
  rlist    OUT     row_list);

Parameters

Table 136-3 NEW_ROW_LIST Procedure Parameters
Parameter Description

rlist

This is an output parameter containing the new row_list data type

Return Values

The function version returns the new row_list data type.


PRINT_MULTI Procedure

This procedure uses the PRINT Procedures or the PRN Procedures to print the "rows" field of the OWA_TEXT.MULTI_LINE DATA TYPE.

Syntax

OWA_TEXT.PRINT_MULTI(
   mline       IN       multi_line);

Parameters

Table 136-4  PRINT_MULTI Procedure Parameters
Parameter Description

mline

The multi_line data type to print.

Return Values

The contents of the multi_line.


PRINT_ROW_LIST Procedure

This procedure uses PRINT Procedures or the PRN Procedures to print the "rows" field of the OWA_TEXT.ROW_LIST DATA TYPE.

Syntax

OWA_TEXT.PRINT_ROW_LIST(
   rlist       IN       multi_line);

Parameters

Table 136-5  PRINT_ROW_LIST Procedure Parameters
Parameter Description

rlist

The row_list data type to print.

Return Values

The contents of the row_list.


STREAM2MULTI Procedure

This procedure converts a string to a multi_line data type.

Syntax

OWA_TEXT.STREAM2MULTI(
   stream         IN       VARCHAR2
   mline          OUT      multi_line);

Parameters

Table 136-6  STREAM2MULTI Procedure Parameters
Parameter Description

stream

The string to convert.

mline

The stream in OWA_TEXT.MULTI_LINE DATA TYPE format