SAP ABAP Class CL_TREX_STRUCTURE (Structure Abstraction)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-TRX-API (Application Component) TREX ABAP + JAVA API
     ⤷ STREX (Package) TREX ABAP client

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_TREX_SERIALIZABLE_STRUCTURE	Serializable Structure Metadata	20060406
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_TREX_STRUCTURE_META	Metadata Interface to Structure	20051019

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_TREX_TABLE_META	Table Metadata	20060515

Properties

Class	CL_TREX_STRUCTURE
Short Description	Structure Abstraction
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	STREX	TREX ABAP client
Created	20051019	SAP
Last change	20110908	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_TREX_SERIALIZABLE_STRUCTURE	☐	☐	Serializable Structure Metadata	20060406
2	IF_TREX_STRUCTURE_META	☐	☐	Metadata Interface to Structure	20051019

Friends

#	Friend	Modeled only	Created on	Description
1	CL_TREX_FACTORY	☐	20060405	Factory

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ATTRIBUTE_MAP	Instance attribute	Public	☑	Type reference (TYPE)	T_ATTRIBUTE_MAP			20060220
2	IGNORE_COLUMNS	Instance attribute	Private	☐	Type reference (TYPE)	T_IGNORE_COLUMNS			20060706
3	OVERRIDDEN_ATTRIBUTE_TYPES	Instance attribute	Private	☐	Type reference (TYPE)	T_ATTRIBUTE_NAME_TYPE_MAP			20051207
4	STRUCTDESCR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20060105

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AB_COMPDESCR_TO_ATTR_DEF	Instance method	Private	Method		20051101
2	AB_COMPDESCR_TO_COMP_DESCR	Instance method	Private	Method		20051101
3	AB_TABLEDESCR_TO_AB_COMPDESCR	Static method	Private	Method		20051101
4	AB_TABLEDESCR_TO_COMP_DESCR	Instance method	Private	Method		20051109
5	AB_TYPE_TO_ATTRIBUTE_TYPE	Static method	Private	Method		20070424
6	ATTR_DEF_TO_AB_COMPDESCR	Static method	Public	Method		20060130
7	CHECK_CS_TYPE_FOR_TIMESTAMP	Instance method	Public	Method		20101209
8	COLUMN_METAS_TO_RED_COMP_DESCR	Static method	Public	Method		20070301
9	COMP_DESCR_TO_AB_COMPDESCR	Static method	Public	Method		20060130
10	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20060221
11	CREATE_STRUCTURE	Instance method	Private	Method		20060221
12	CREATE_STRUCTURE_BY_COMP_DESCR	Static method	Public	Method		20060515
13	CREATE_STRUCTURE_BY_DATA	Static method	Public	Method		20060515
14	CREATE_STRUCTURE_BY_NAME	Static method	Public	Method		20060515
15	CREATE_STRUCTURE_BY_TABLE_DATA	Static method	Public	Method		20060629
16	GET_ABAP_COMPDESCR	Instance method	Private	Method		20060221
17	GET_ABAP_STRUCTDESCR	Instance method	Private	Method		20060221
18	GET_ATTRIBUTE_DEFINITIONS	Instance method	Public	Method		20051021
19	GET_COLUMNS_FOR_ATTRIBUTES	Instance method	Private	Method		20060221
20	GET_COLUMN_METAS	Instance method	Public	Method		20061026
21	GET_COLUMN_TYPES	Instance method	Public	Method		20060623
22	GET_COMPONENT_DESCRIPTOR	Instance method	Public	Method		20051021
23	GET_REDUCED_COMP_DESCR	Instance method	Public	Method		20070301
24	LOG_COMP_DESCR_MISMATCHES	Instance method	Public	Method		20070713
25	LOG_RED_COMP_DESCR_MISMATCHES	Instance method	Public	Method		20070301
26	MAP_ATTRIBUTE	Instance method	Public	Method		20060221
27	MAP_ATTRIBUTES_WITH_COMP_DESCR	Instance method	Public	Method		20060629
28	RED_COMP_DESCR_TO_COLUMN_METAS	Static method	Public	Method		20070301
29	SERIALIZE_ATTRIBUTE_MAP	Instance method	Private	Method		20060629
30	SERIALIZE_COLUMN_TYPES	Instance method	Private	Method		20060629
31	SET_ATTRIBUTE_TYPE	Instance method	Public	Method		20051208
32	SET_IGNORE_COLUMN	Instance method	Public	Method		20060706

Events

Class CL_TREX_STRUCTURE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_ATTRIBUTE_COLUMN	Public	See coding			20060623	begin of t_attribute_column , attribute type trexd_attr_name , column type name_komp , end of t_attribute_column
2	T_ATTRIBUTE_MAP	Public	See coding			20060623	T_ATTRIBUTE_MAP type hashed table of t_attribute_column with unique key column
3	T_ATTRIBUTE_NAME_TYPE	Private	See coding			20051207	begin of t_attribute_name_type , name type string , type type trexd_attr_type , end of t_attribute_name_type
4	T_ATTRIBUTE_NAME_TYPE_MAP	Private	See coding			20051207	t_attribute_name_type_map type hashed table of t_attribute_name_type with unique key name
5	T_COLUMN_META	Public	See coding			20061026	begin of t_column_meta , name type abap_compname , type type abap_typekind , domain type domname , end of t_column_meta
6	T_COLUMN_METAS	Public	See coding			20061026	t_column_metas type standard table of t_column_meta with non-unique key name
7	T_COLUMN_NAMES	Private	Attribute reference (LIKE)			20060221
8	T_COLUMN_TYPE	Public	See coding			20060623	begin of t_column_type , name type abap_compname , type type abap_typekind , end of t_column_type
9	T_COLUMN_TYPES	Public	See coding			20060623	t_column_types type standard table of t_column_type with non-unique key name
10	T_IGNORE_COLUMNS	Private	See coding			20060706	t_ignore_columns type standard table of string

Method Signatures

Method AB_COMPDESCR_TO_ATTR_DEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPDESCR	Call by reference	☐	Type reference (TYPE)	ABAP_COMPDESCR			20051101
2	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	TREXS_ATTR_DEF		Attribute Definition	20051101

Method AB_COMPDESCR_TO_ATTR_DEF on class CL_TREX_STRUCTURE has no exception.

Method AB_COMPDESCR_TO_COMP_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMPDESCR	Call by reference	☐	Type reference (TYPE)	ABAP_COMPDESCR			20051101
2	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	TREXS_COMP_DESCR		Description of the components	20051101
3	Importing	SET_DEFAULT_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Take field name as attr name, if attr name is initial	20060816

Method AB_COMPDESCR_TO_COMP_DESCR on class CL_TREX_STRUCTURE has no exception.

Method AB_TABLEDESCR_TO_AB_COMPDESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	ABAP_COMPNAME			20051101
2	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	ABAP_COMPDESCR			20051101
3	Importing	TABLEDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_TABLEDESCR		Runtime Type Services	20051101

Method AB_TABLEDESCR_TO_AB_COMPDESCR on class CL_TREX_STRUCTURE has no exception.

Method AB_TABLEDESCR_TO_COMP_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	ABAP_COMPNAME			20051109
2	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	TREXS_COMP_DESCR		Description of the components	20051109
3	Importing	SET_DEFAULT_ATTR_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Take field name as attr name, if attr name is initial	20060816
4	Importing	TABLEDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_TABLEDESCR		Runtime Type Services	20051109

Method AB_TABLEDESCR_TO_COMP_DESCR on class CL_TREX_STRUCTURE has no exception.

Method AB_TYPE_TO_ATTRIBUTE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AB_TYPE	Call by reference	☐	Type reference (TYPE)	ABAP_TYPEKIND			20070424
2	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	TREXD_ATTR_TYPE		Attribute type	20070424

Method AB_TYPE_TO_ATTRIBUTE_TYPE on class CL_TREX_STRUCTURE has no exception.

Method ATTR_DEF_TO_AB_COMPDESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ATTR_DEF	Call by reference	☐	Type reference (TYPE)	TREXS_ATTR_DEF		Attribute Definition	20060130
2	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	ABAP_COMPONENTDESCR			20060130

Method ATTR_DEF_TO_AB_COMPDESCR on class CL_TREX_STRUCTURE has no exception.

Method CHECK_CS_TYPE_FOR_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		X: needs to check CS types for SQL generation	20101209

Method CHECK_CS_TYPE_FOR_TIMESTAMP on class CL_TREX_STRUCTURE has no exception.

Method COLUMN_METAS_TO_RED_COMP_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COLUMN_METAS	Call by reference	☐	Type reference (TYPE)	T_COLUMN_METAS			20070301
2	Exporting	RVAL	Call by reference	☐	Type reference (TYPE)	TREXT_REDUCED_COMP_DESCR		Description of the Components	20070301

Method COLUMN_METAS_TO_RED_COMP_DESCR on class CL_TREX_STRUCTURE has no exception.

Method COMP_DESCR_TO_AB_COMPDESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTOR	Call by reference	☐	Type reference (TYPE)	TREXS_COMP_DESCR		Description of the components	20060130
2	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	ABAP_COMPONENTDESCR			20060130

#	Exception	Resumable	Description	Created on
1	CX_TREX_BAD_STRUCTURE	☐	TREX: Bad structure.	20070503

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20060221

Method CONSTRUCTOR on class CL_TREX_STRUCTURE has no exception.

Method CREATE_STRUCTURE Signature

Method CREATE_STRUCTURE on class CL_TREX_STRUCTURE has no parameter.
Method CREATE_STRUCTURE on class CL_TREX_STRUCTURE has no exception.

Method CREATE_STRUCTURE_BY_COMP_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTOR	Call by reference	☐	Type reference (TYPE)	TREXT_COMP_DESCR		Description of the components	20060515
2	Returning	RVAL	Value transfer	☐	Object reference (TYPE REF TO)	CL_TREX_STRUCTURE		Structure Abstraction	20060515

#	Exception	Resumable	Description	Created on
1	CX_TREX_BAD_STRUCTURE	☐	TREX: Bad structure.	20070504

Method CREATE_STRUCTURE_BY_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATA	Call by reference	☐	Type reference (TYPE)	DATA			20060515
2	Returning	RVAL	Value transfer	☐	Object reference (TYPE REF TO)	CL_TREX_STRUCTURE			20060515

#	Exception	Resumable	Description	Created on
1	CX_TREX_BAD_REQUEST	☐	Unexpected data received from application.	20080825

Method CREATE_STRUCTURE_BY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAME	Call by reference	☐	Type reference (TYPE)	CLIKE			20060515
2	Returning	RVAL	Value transfer	☐	Object reference (TYPE REF TO)	CL_TREX_STRUCTURE		Structure Abstraction	20060515

#	Exception	Resumable	Description	Created on
1	CX_TREX_BAD_REQUEST	☐	Unexpected data received from application.	20080825

Method CREATE_STRUCTURE_BY_TABLE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20060629
2	Returning	RVAL	Value transfer	☐	Object reference (TYPE REF TO)	CL_TREX_STRUCTURE			20060629

#	Exception	Resumable	Description	Created on
1	CX_TREX_BAD_REQUEST	☐	Unexpected data received from application.	20080825

Method GET_ABAP_COMPDESCR Signature

Method GET_ABAP_COMPDESCR on class CL_TREX_STRUCTURE has no parameter.
Method GET_ABAP_COMPDESCR on class CL_TREX_STRUCTURE has no exception.

Method GET_ABAP_STRUCTDESCR Signature

Method GET_ABAP_STRUCTDESCR on class CL_TREX_STRUCTURE has no parameter.
Method GET_ABAP_STRUCTDESCR on class CL_TREX_STRUCTURE has no exception.

Method GET_ATTRIBUTE_DEFINITIONS Signature

Method GET_ATTRIBUTE_DEFINITIONS on class CL_TREX_STRUCTURE has no parameter.
Method GET_ATTRIBUTE_DEFINITIONS on class CL_TREX_STRUCTURE has no exception.

Method GET_COLUMNS_FOR_ATTRIBUTES Signature

Method GET_COLUMNS_FOR_ATTRIBUTES on class CL_TREX_STRUCTURE has no parameter.
Method GET_COLUMNS_FOR_ATTRIBUTES on class CL_TREX_STRUCTURE has no exception.

Method GET_COLUMN_METAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	T_COLUMN_METAS			20061026

Method GET_COLUMN_METAS on class CL_TREX_STRUCTURE has no exception.

Method GET_COLUMN_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	T_COLUMN_TYPES			20060623

Method GET_COLUMN_TYPES on class CL_TREX_STRUCTURE has no exception.

Method GET_COMPONENT_DESCRIPTOR Signature

Method GET_COMPONENT_DESCRIPTOR on class CL_TREX_STRUCTURE has no parameter.
Method GET_COMPONENT_DESCRIPTOR on class CL_TREX_STRUCTURE has no exception.

Method GET_REDUCED_COMP_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RVAL	Value transfer	☐	Type reference (TYPE)	TREXT_REDUCED_COMP_DESCR		Description of the components	20070301

Method GET_REDUCED_COMP_DESCR on class CL_TREX_STRUCTURE has no exception.

Method LOG_COMP_DESCR_MISMATCHES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMP_DESCR	Call by reference	☐	Type reference (TYPE)	TREXT_COMP_DESCR		Description of the Components	20070713

Method LOG_COMP_DESCR_MISMATCHES on class CL_TREX_STRUCTURE has no exception.

Method LOG_RED_COMP_DESCR_MISMATCHES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMP_DESCR	Call by reference	☐	Type reference (TYPE)	TREXT_REDUCED_COMP_DESCR		Description of the Components	20070301

Method LOG_RED_COMP_DESCR_MISMATCHES on class CL_TREX_STRUCTURE has no exception.

Method MAP_ATTRIBUTE Signature

Method MAP_ATTRIBUTE on class CL_TREX_STRUCTURE has no parameter.
Method MAP_ATTRIBUTE on class CL_TREX_STRUCTURE has no exception.

Method MAP_ATTRIBUTES_WITH_COMP_DESCR Signature

Method MAP_ATTRIBUTES_WITH_COMP_DESCR on class CL_TREX_STRUCTURE has no parameter.
Method MAP_ATTRIBUTES_WITH_COMP_DESCR on class CL_TREX_STRUCTURE has no exception.

Method RED_COMP_DESCR_TO_COLUMN_METAS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	COMP_DESCR	Call by reference	☐	Type reference (TYPE)	TREXT_REDUCED_COMP_DESCR		Description of the Components	20070301
2	Exporting	RVAL	Call by reference	☐	Type reference (TYPE)	T_COLUMN_METAS			20070301

Method RED_COMP_DESCR_TO_COLUMN_METAS on class CL_TREX_STRUCTURE has no exception.

Method SERIALIZE_ATTRIBUTE_MAP Signature

Method SERIALIZE_ATTRIBUTE_MAP on class CL_TREX_STRUCTURE has no parameter.
Method SERIALIZE_ATTRIBUTE_MAP on class CL_TREX_STRUCTURE has no exception.

Method SERIALIZE_COLUMN_TYPES Signature

Method SERIALIZE_COLUMN_TYPES on class CL_TREX_STRUCTURE has no parameter.
Method SERIALIZE_COLUMN_TYPES on class CL_TREX_STRUCTURE has no exception.

Method SET_ATTRIBUTE_TYPE Signature

Method SET_ATTRIBUTE_TYPE on class CL_TREX_STRUCTURE has no parameter.
Method SET_ATTRIBUTE_TYPE on class CL_TREX_STRUCTURE has no exception.

Method SET_IGNORE_COLUMN Signature

Method SET_IGNORE_COLUMN on class CL_TREX_STRUCTURE has no parameter.
Method SET_IGNORE_COLUMN on class CL_TREX_STRUCTURE has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	710