SAP ABAP Class CL_FOX_STRUCTURED_CACHE (Cache for Structure Explosion)
Hierarchy
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   LO-PDM (Application Component) Product Data Management
     PLM_FOX (Package) Framework for hierarchy explosion
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_FOX_COMPONENT_PROVIDER Interface for Dependent Components 20010406
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_FOX_FREEABLE_OBJECT ObjeCt with Free_Data Method 20011127
3 Interface implementation (CLASS c. INTERFACES i_ref)  IF_FOX_MAP_INSTANCE_DB Conversion instances <-> DB 20010327
4 Interface implementation (CLASS c. INTERFACES i_ref)  IF_FOX_MSG_PARAMETER Parameters for FOX Messages 20020320
Properties
Class CL_FOX_STRUCTURED_CACHE  
Short Description Cache for Structure Explosion    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package PLM_FOX   Framework for hierarchy explosion 
Created 20000724   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 CL_FOX_CONSTANTS Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
2 CL_FOX_LINK_TYPES Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 CL_PTU_CONSTANTS Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
# Interface Abstract Final Description Created on
1 IF_FOX_COMPONENT_PROVIDER Interface for Dependent Components 20010406
2 IF_FOX_FREEABLE_OBJECT ObjeCt with Free_Data Method 20011127
3 IF_FOX_MAP_INSTANCE_DB Conversion instances <-> DB 20010327
4 IF_FOX_MSG_PARAMETER Parameters for FOX Messages 20020320
Friends
# Friend Modeled only Created on Description
1 CL_FOX_CONTROLLER 20011016 Control Unit for the Explosion
2 CL_FOX_FLOB_MEMORY_SELECTOR 20011016 Memory Accesses for a FOX File
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_BLOCK_SIZE Static Attribute Private Type reference (TYPE) I '50000' Dataset size 20010713
2 GC_TAG Constant Private Type reference (TYPE) PTU_TAG CL_FOX_CONSTANTS=>GC_TAG_CACHE Indicator 20000815
3 GI_FACTORY Instance attribute Private Object reference (TYPE REF TO) IF_FOX_STRUCT_OBJECT_FACTORY Factory Interface (for FOX Analysis) 20010803
4 GI_PERSISTENCE_CONTROLLER Instance attribute Private Object reference (TYPE REF TO) IF_FOX_PERSISTENCE_CONTROLLER Control of Persistence 20010327
5 GS_MSG_PARAMETERS Instance attribute Private See coding 20020320
6 GS_UTIL_IF Instance attribute Private Type reference (TYPE) PTU_UTIL_IF_S Structure with Utility Interface 20000814
7 GT_CONTEXT_LINKED_OBJECT Instance attribute Private See coding Buffer for Call Contexts 20020731
8 GT_DB_2_INSTANCE Instance attribute Private See coding 20010327
9 GT_INSTANCE_2_DB Instance attribute Private See coding 20010327
10 GT_OBJECT Instance attribute Private Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_T Table of Dependent Objects 20010326
11 GT_PARENT_OBJECT Instance attribute Private Type reference (TYPE) FOX_PARENT_CACHE_OBJECT_T Parent-Object Table for FOX Cache 20010323
12 GT_STATISTIC Instance attribute Private See coding Table for Statistics 20000817
13 GV_STRUCT_ID Instance attribute Public Type reference (TYPE) FOX_STRUCT_DB_ID ID of Database Storage from a Cache 20010327
14 SV_MSG_DUMMY Static Attribute Private Type reference (TYPE) CHAR1 Single-Character Indicator 20020322
15 SV_MSG_LINK_TYPE_EXT Static Attribute Private Type reference (TYPE) FOX_LINK_TYPE_EXT External Format of Object Relationship 20020322
16 SV_MSG_OBJ_KEY_EXT Static Attribute Private Type reference (TYPE) FOX_OBJ_KEY_EXT External Object Key (Such As Material or BOM) 20020322
17 SV_MSG_OBJ_TYPE_EXT Static Attribute Private Type reference (TYPE) FOX_OBJ_TYPE_EXT External Format of Object Type 20020322
Methods
# Method Level Visibility Method type Description Created on
1 ADD_COMPONENT Instance method Public Method Include New Component in Cache 20010323
2 ADD_COMPONENTS Instance method Public Method Include New Components in Cache 20010405
3 ADD_STRUCTURE_TO_COMPONENT Instance method Public Method Append Exploded Structure to Node 20010924
4 CLEAR_CALL_CONTEXT_BUFFER Instance method Public Method Reset Buffer for Call Context 20020731
5 CONSTRUCTOR Instance method Public Constructor Constructor 20000811
6 DELETE_DATA Instance method Public Method Delete Data from Database 20010703
7 FINISH_READ_DATA Instance method Public Method Clean Up After Import 20010403
8 FINISH_WRITE_DATA Instance method Public Method Clean Up After Writing 20010403
9 HANDLE_OBJECT_NOT_IN_CACHE Instance method Private Method Error Handling: Object Not in Cache 20000905
10 ITERATE Instance method Public Method Iteration Method Using a Toplevel Object 20010326
11 ITERATE_ONE_LEVEL Instance method Private Method Iteration Method Using a Hierarchy Level 20010326
12 MAP_INSTANCE_2_DB Instance method Private Method Return Reference to Initial Node 20010327
13 PROCESS_RESULT_MODE Instance method Private Method Prepare Return of Results 20020802
14 READ_DATA Instance method Public Method Imports the Entire Cache 20010403
15 RETURN_ALL_OBJECTS_TO_PARENT Instance method Public Method Find All Dependent Objects for an Object 20010403
16 RETURN_INSTANCES_ONE_LEVEL Instance method Private Method Return Instances of a Hierarchy Level 20010326
17 RETURN_REFERENCE_TO_STRUCTURE Instance method Public Method Return Reference to Initial Node 20010327
18 RETURN_STRUCTURE_CHECKS Instance method Private Method Checks of the Call Up Parameter 20001122
19 RETURN_STRUCTURE_INSTANCES Instance method Public Method Return Structure with Object Instances 20010323
20 SORT_OBJECTS_BY_KEY Instance method Private Method Sort List of Objects by Key 20010404
21 WRITE_STATISTIC Instance method Public Method Update Statistics 20000817
22 WRITE_TO_DB Instance method Public Method Writes Entire Cache to Database 20010327
Events
Class CL_FOX_STRUCTURED_CACHE has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TS_CONTEXT_LINKED_OBJECT Private See coding Structure of Buffer for Call Contexts 20020731
2 TS_STATISTIC Private See coding Structure for Statistics 20000817
Method Signatures

Method ADD_COMPONENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_EXPANSION_EXISTS Call by reference Type reference (TYPE) FLAG_X Auflösung schon vorhanden 20010323
2 Importing IS_OBJECT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Abhängiges Objekt 20010323
3 Importing IS_PARENT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Abhängiges Objekt 20010323

Method ADD_COMPONENT on class CL_FOX_STRUCTURED_CACHE has no exception.

Method ADD_COMPONENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_OBJECTS_REF Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_REF_T Objekt und Kantenfarbe im FOX-Cache mit Referenz 20010405
2 Importing IS_PARENT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Abhängiges Objekt 20010405

Method ADD_COMPONENTS on class CL_FOX_STRUCTURED_CACHE has no exception.

Method ADD_STRUCTURE_TO_COMPONENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EXPLODED_STRUCTURE Call by reference Object reference (TYPE REF TO) CL_FOX_MULTILEVEL_STRUCTURE Mehrstufige Objektstruktur 20010924
2 Importing IS_PARENT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Objekt und Kantenfarbe im FOX-Cache 20010924

Method ADD_STRUCTURE_TO_COMPONENT on class CL_FOX_STRUCTURED_CACHE has no exception.

Method CLEAR_CALL_CONTEXT_BUFFER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CALL_CONTEXT Call by reference Type reference (TYPE) FOX_CALL_CONTEXT Aufrufkontext 20020731

Method CLEAR_CALL_CONTEXT_BUFFER on class CL_FOX_STRUCTURED_CACHE has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing II_PERSISTENCE_CONTROLLER Call by reference Object reference (TYPE REF TO) IF_FOX_PERSISTENCE_CONTROLLER Steuerung der Persistenz 20010327
2 Importing IS_MSG_PARAMETERS Call by reference Type reference (TYPE) FOX_MSG_PARAMETER_S Parameter für FOX-Messages 20020320
3 Importing IS_UTIL_IF Call by reference Type reference (TYPE) PTU_UTIL_IF_S Struktur mit Utility-Interfaces 20000814
4 Importing IV_STRUCT_ID Call by reference Type reference (TYPE) FOX_STRUCT_DB_ID ID der Datenbankablage von einem Cache 20010327

Method CONSTRUCTOR on class CL_FOX_STRUCTURED_CACHE has no exception.

Method DELETE_DATA Signature

Method DELETE_DATA on class CL_FOX_STRUCTURED_CACHE has no parameter.
# Exception Resumable Description Created on
1 INVALID_REFERENCE ungültige Referenz 20010713

Method FINISH_READ_DATA Signature

Method FINISH_READ_DATA on class CL_FOX_STRUCTURED_CACHE has no parameter.
Method FINISH_READ_DATA on class CL_FOX_STRUCTURED_CACHE has no exception.

Method FINISH_WRITE_DATA Signature

Method FINISH_WRITE_DATA on class CL_FOX_STRUCTURED_CACHE has no parameter.
Method FINISH_WRITE_DATA on class CL_FOX_STRUCTURED_CACHE has no exception.

Method HANDLE_OBJECT_NOT_IN_CACHE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_OBJECT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Abhängiges Objekt (Typ der Beziehung, Instanz) 20010326

Method HANDLE_OBJECT_NOT_IN_CACHE on class CL_FOX_STRUCTURED_CACHE has no exception.

Method ITERATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing II_VISITOR Call by reference Object reference (TYPE REF TO) IF_FOX_OBJECT_VISITOR Besucherschnittstelle für ein FOX-Objekt 20010326
2 Importing IS_OBJECT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Toplevel-Objekt 20010326
3 Importing IV_CALL_CONTEXT Call by reference Type reference (TYPE) FOX_CALL_CONTEXT Aufrufkontext 20020730
4 Importing IV_RESULT_MODE Call by reference Type reference (TYPE) FOX_RESULT_MODE CL_FOX_CONSTANTS=>GC_RESULT_ONCE_WITH_STRUCTURE Rückgabe des Auflösungsergebnisses (siehe CL_FOX_CONSTANTS) 20020802
5 Importing IV_SORTED Call by reference Type reference (TYPE) FLAG_X Objekte nach Schlüssel sortiert 20010326
# Exception Resumable Description Created on
1 INVALID_PARAMETERS ungültige Parametrisierung 20020802
2 VISIT_INTERUPTED Besucheriteration wurde unterbrochen 20010326

Method ITERATE_ONE_LEVEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_OBJECT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_HT Tabelle der Abhängigen Objekte 20010326
2 Changing CT_OBJECT_STACK Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJ_NOSORT_T Tabelle der abhängigen Objekte (nicht sortiert) 20020802
3 Changing CV_STACK_SIZE Call by reference Type reference (TYPE) I Größe des Stack 20020802
4 Importing II_VISITOR Call by reference Object reference (TYPE REF TO) IF_FOX_OBJECT_VISITOR Besucherschnittstelle für ein FOX-Objekt 20010326
5 Importing IS_PARENT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Abhängiges Objekt (Typ der Beziehung, Instanz) 20010326
6 Importing IV_INTERNAL_CONTEXT Call by reference Type reference (TYPE) FOX_CALL_CONTEXT Aufrufkontext 20020802
7 Importing IV_INTERNAL_MODE Call by reference Type reference (TYPE) FOX_RESULT_MODE Rückgabe des Auflösungsergebnisses (siehe CL_FOX_CONSTANTS) 20020802
8 Importing IV_LEVEL Call by reference Type reference (TYPE) FOX_LEVEL Hierarchie-Tiefe des Objekts 20010326
9 Importing IV_SORTED Call by reference Type reference (TYPE) FLAG_X Objekte nach Schlüsseln sortieren 20010326
# Exception Resumable Description Created on
1 STOP_ITERATION Iteration unterbrechen 20010326

Method MAP_INSTANCE_2_DB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_OBJECT_ID Call by reference Type reference (TYPE) FOX_OBJECT_DB_ID ID vom Objekt in der Datenbankablage 20010327
2 Importing IV_INSTANCE Call by reference Type reference (TYPE) FOX_CACHE_OBJECT Abhängiges Objekt (Typ der Beziehung, Instanz) 20010327

Method MAP_INSTANCE_2_DB on class CL_FOX_STRUCTURED_CACHE has no exception.

Method PROCESS_RESULT_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_INTERNAL_CONTEXT Call by reference Type reference (TYPE) FOX_CALL_CONTEXT Aufrufkontext 20020802
2 Exporting EV_INTERNAL_MODE Call by reference Type reference (TYPE) FOX_RESULT_MODE Rückgabe des Auflösungsergebnisses (siehe CL_FOX_CONSTANTS) 20020802
3 Importing IV_CALL_CONTEXT Call by reference Type reference (TYPE) FOX_CALL_CONTEXT Aufrufkontext 20020802
4 Importing IV_RESULT_MODE Call by reference Type reference (TYPE) FOX_RESULT_MODE Rückgabe des Auflösungsergebnisses (siehe CL_FOX_CONSTANTS) 20020802
# Exception Resumable Description Created on
1 INVALID_PARAMETERS ungültige Parametrisierung 20020802

Method READ_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing II_FACTORY Call by reference Object reference (TYPE REF TO) IF_FOX_STRUCT_OBJECT_FACTORY Fabrik für Instanzen der structured Objects 20010702
2 Importing II_VIRTUAL_EXPLOSION Call by reference Object reference (TYPE REF TO) IF_FOX_VIRTUAL_STRUCT Struktur von aussen vorgeben 20010403
# Exception Resumable Description Created on
1 READ_FAILED Fehler beim Einlesen der Daten 20010403

Method RETURN_ALL_OBJECTS_TO_PARENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_OBJECTS Call by reference Type reference (TYPE) FOX_LINKED_OBJECT_NOSORT_T Objekt und Kantenfarbe für den FOX-Aufrufer 20010403
2 Importing IS_PARENT Call by reference Type reference (TYPE) FOX_LINKED_OBJECT_S Objekt und Kantenfarbe für den FOX-Aufrufer 20010403
3 Importing IV_CALL_CONTEXT Call by reference Type reference (TYPE) FOX_CALL_CONTEXT Aufrufkontext 20020801
4 Importing IV_RESULT_MODE Call by reference Type reference (TYPE) FOX_RESULT_MODE CL_FOX_CONSTANTS=>GC_RESULT_ONCE_WITH_STRUCTURE Rückgabe des Auflösungsergebnisses (siehe CL_FOX_CONSTANTS) 20020802
5 Importing IV_SORTED Call by reference Type reference (TYPE) FLAG_X Sortierungskennzeichen 20010403
# Exception Resumable Description Created on
1 INVALID_PARAMETERS ungültige Parametrisierung 20020802
2 NO_PARENT kein Objekt mitgegeben 20010403

Method RETURN_INSTANCES_ONE_LEVEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_INST_STRUCTURE Call by reference Type reference (TYPE) FOX_PARENT_OBJECT_T Parent-Objekt-Tabelle für den FOX Aufrufer 20010326
2 Changing CT_OBJECT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_HT Tabelle der Abhängigen Objekte 20010326
3 Importing IS_PARENT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Abhängiges Objekt (Typ der Beziehung, Instanz) 20010326
4 Importing IV_INTERNAL_CONTEXT Call by reference Type reference (TYPE) FOX_CALL_CONTEXT Aufrufkontext 20020802
5 Importing IV_INTERNAL_MODE Call by reference Type reference (TYPE) FOX_RESULT_MODE Rückgabe des Auflösungsergebnisses (siehe CL_FOX_CONSTANTS) 20020802
6 Importing IV_SORTED Call by reference Type reference (TYPE) FLAG_X Objekte nach Schlüssel sortiert 20010326

Method RETURN_INSTANCES_ONE_LEVEL on class CL_FOX_STRUCTURED_CACHE has no exception.

Method RETURN_REFERENCE_TO_STRUCTURE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_REFERENCE Call by reference Type reference (TYPE) FOX_PERSISTENT_ENTRY_S Referenz auf Persistente Struktur 20010327
2 Importing IS_OBJECT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Abhängiges Objekt (Typ der Beziehung, Instanz) 20010327

Method RETURN_REFERENCE_TO_STRUCTURE on class CL_FOX_STRUCTURED_CACHE has no exception.

Method RETURN_STRUCTURE_CHECKS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_PARENT_OBJECT Call by reference Type reference (TYPE) FOX_PARENT_CACHE_OBJECT_S Parent-Objekt-Struktur für den FOX Cache 20010326
2 Importing IS_OBJECT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Abhängiges Objekt (Typ der Beziehung, Instanz) 20001122

Method RETURN_STRUCTURE_CHECKS on class CL_FOX_STRUCTURED_CACHE has no exception.

Method RETURN_STRUCTURE_INSTANCES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_INST_STRUCTURE Call by reference Type reference (TYPE) FOX_PARENT_OBJECT_T Parent-Objekt-Tabelle für den FOX Aufrufer 20010323
2 Importing IS_OBJECT Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJECT_S Abhängiges Objekt (Typ der Beziehung, Instanz) 20010323
3 Importing IV_CALL_CONTEXT Call by reference Type reference (TYPE) FOX_CALL_CONTEXT Aufrufkontext 20020801
4 Importing IV_RESULT_MODE Call by reference Type reference (TYPE) FOX_RESULT_MODE CL_FOX_CONSTANTS=>GC_RESULT_ONCE_WITH_STRUCTURE Rückgabe des Auflösungsergebnisses (siehe CL_FOX_CONSTANTS) 20020802
5 Importing IV_SORTED Call by reference Type reference (TYPE) FLAG_X Kennzeichen: Sortierung der Objekte 20010323
# Exception Resumable Description Created on
1 INVALID_PARAMETERS ungültige Parametrisierung 20020802

Method SORT_OBJECTS_BY_KEY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_OBJECTS Call by reference Type reference (TYPE) FOX_LINKED_CACHE_OBJ_NOSORT_T Tabelle der abhängigen Objekte (nicht sortiert) 20010404

Method SORT_OBJECTS_BY_KEY on class CL_FOX_STRUCTURED_CACHE has no exception.

Method WRITE_STATISTIC Signature

Method WRITE_STATISTIC on class CL_FOX_STRUCTURED_CACHE has no parameter.
Method WRITE_STATISTIC on class CL_FOX_STRUCTURED_CACHE has no exception.

Method WRITE_TO_DB Signature

Method WRITE_TO_DB on class CL_FOX_STRUCTURED_CACHE has no parameter.
# Exception Resumable Description Created on
1 INVALID_REFERENCE ungültige Referenz 20010713
2 WRITE_FAILED Fehler beim Schreiben auf die Datenbank 20010403
History
Last changed by/on SAP  20130531 
SAP Release Created in 46C1