SAP ABAP Class CL_ABAP_DB_C_LOCATOR (Locator for a Character-like LOB)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ SABP_STREAMS_AND_LOCATORS (Package) Streams and Locators

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ABAP_CLOSE_RESOURCE	Close Resource	20080416
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ABAP_DB_CLOB_HANDLE	CLOB Column of a Database Column	20080416
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_ABAP_DB_LOB_HANDLE	LOB Column of a Database Table	20080416

Properties

Class	CL_ABAP_DB_C_LOCATOR
Short Description	Locator for a Character-like LOB
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SABP_STREAMS_AND_LOCATORS	Streams and Locators
Created	20071108	SAP
Last change	20090618	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_ABAP_CLOSE_RESOURCE	☐	☑	Close Resource	20080416
2	IF_ABAP_DB_CLOB_HANDLE	☐	☑	CLOB Column of a Database Column	20080416
3	IF_ABAP_DB_LOB_HANDLE	☐	☑	LOB Column of a Database Table	20080416

Friends

Class CL_ABAP_DB_C_LOCATOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CLOSED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Locator Closed (Yes/No)	20071108
2	LOB_HDL	Instance attribute	Private	☐	Type reference (TYPE)	LOB_HANDLE_ATTR		Lob Handle Attribute	20071108

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE	Instance method	Public	Method		20071218
2	DESTRUCTOR	Instance method	Public	Method		20080201
3	FIND	Instance method	Public	Method	Searchs for a Search String in a LOB	20080311
4	GET_LENGTH	Instance method	Public	Method	Returns Length of LOB in Characters	20071108
5	GET_SUBSTRING	Instance method	Public	Method	Creates a Subsequence of a LOB	20071108
6	IS_CLOSED	Instance method	Public	Method		20071218

Events

Class CL_ABAP_DB_C_LOCATOR has no event.

Types

Class CL_ABAP_DB_C_LOCATOR has no local type.

Method Signatures

Method CLOSE Signature

Method CLOSE on class CL_ABAP_DB_C_LOCATOR has no parameter.
Method CLOSE on class CL_ABAP_DB_C_LOCATOR has no exception.

Method DESTRUCTOR Signature

Method DESTRUCTOR on class CL_ABAP_DB_C_LOCATOR has no parameter.
Method DESTRUCTOR on class CL_ABAP_DB_C_LOCATOR has no exception.

Method FIND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	MATCH_OFFSET	Value transfer	☐	Type reference (TYPE)	ABAP_MSIZE			20080311
2	Importing	PATTERN	Call by reference	☐	Type reference (TYPE)	STRING			20080311
3	Importing	START_OFFSET	Call by reference	☐	Type reference (TYPE)	ABAP_MSIZE	0		20080311

#	Exception	Resumable	Description	Created on
1	CX_LOB_SQL_ERROR	☐		20080311
2	CX_PARAMETER_INVALID_RANGE	☐	Parameter mit ungültigem Wertebereich	20080311
3	CX_RESOURCE_ALREADY_CLOSED	☐	Ressource bereits geschlossen	20080311
4	CX_SY_RANGE_OUT_OF_BOUNDS	☐	System-Exceptions bei Teilfeldzugriff außerhalb der Grenzen	20080415

Method GET_LENGTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	LENGTH	Value transfer	☐	Type reference (TYPE)	ABAP_MSIZE		Länge der CLOB-Spalte	20071108

#	Exception	Resumable	Description	Created on
1	CX_LOB_SQL_ERROR	☐		20080118
2	CX_RESOURCE_ALREADY_CLOSED	☐	Ressource bereits geschlossen	20080116

Method GET_SUBSTRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LENGTH	Call by reference	☑	Type reference (TYPE)	ABAP_MSIZE		Länge des Substrings	20071108
2	Importing	OFFSET	Call by reference	☐	Type reference (TYPE)	ABAP_MSIZE		Offset des ersten Zeichens des zu lesenden Substrings	20080115
3	Returning	STR	Value transfer	☐	Type reference (TYPE)	STRING		Der Inhalt des Substrings	20071108

#	Exception	Resumable	Description	Created on
1	CX_LOB_SQL_ERROR	☐		20080118
2	CX_PARAMETER_INVALID_RANGE	☐	Parameter mit ungültigem Wertebereich	20071128
3	CX_RESOURCE_ALREADY_CLOSED	☐	Ressource bereits geschlossen	20080116
4	CX_SY_RANGE_OUT_OF_BOUNDS	☐	System-Exceptions bei Teilfeldzugriff außerhalb der Grenzen	20080415

Method IS_CLOSED Signature

Method IS_CLOSED on class CL_ABAP_DB_C_LOCATOR has no parameter.
Method IS_CLOSED on class CL_ABAP_DB_C_LOCATOR has no exception.

History

Last changed by/on	SAP	20090618
SAP Release Created in	711