SAP ABAP Class CL_ADS2KIPUPL_FILE_READER (Base Class for reading SPEC2000 Files)
Hierarchy
ECC-DIMP (Software Component) DIMP
   IS-AD-SPC (Application Component) Specification 2000
     ADS2KIPUPL_AL (Package) SPEC 2000 Initial Provisioning Upload: File Readers/Parsers
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_ADS2KIPUPL_FILE_READER_S Class for reading SPEC2000 Files (S type) 20020219
2 Inheritance (c INHERITING FROM c_ref)  CL_ADS2KIPUPL_FILE_READER_T Class for reading SPEC2000 Files ( T type) 20020219
3 Inheritance (c INHERITING FROM c_ref)  CL_ADS2KIPUPL_FILE_READER_V Class for reading SPEC2000 Files ( V type) 20020219
Properties
Class CL_ADS2KIPUPL_FILE_READER  
Short Description Base Class for reading SPEC2000 Files    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package ADS2KIPUPL_AL   SPEC 2000 Initial Provisioning Upload: File Readers/Parsers 
Created 20020219   SAP 
Last change 20050301   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ADUPL Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_ADS2KIPUPL_FILE_READER has no interface implemented.
Friends
Class CL_ADS2KIPUPL_FILE_READER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 C_MSG_CLASS Constant Public Type reference (TYPE) SY-MSGID 'ADS2KIPUPL_AL' Message Class 20020222
2 MR_FRONT_END_FILE Instance attribute Protected Object reference (TYPE REF TO) DATA Reference to Front end File Line in MST_FRONT_END_FILES 20020327
3 MST_FRONT_END_FILES Static Attribute Public Type reference (TYPE) ADS2KIPUPL_FRONTEND_FILE_TABLE Front End Files opened so far 20020222
4 MS_UPLOAD_OPTIONS Instance attribute Public Type reference (TYPE) ADS2KIPUPL_UPLOAD_OPTIONS Upload Options 20020222
5 MT_DEBUG_BREAKPOINT_LINES Instance attribute Public Type reference (TYPE) ADUPL_TABIX_RANGE Lines where to stop 20020222
6 MT_MESSAGES Instance attribute Protected Type reference (TYPE) ADS2KIPUPL_MSG_COMM_O_TABLE Table of Message Communication (Nested) Structure 20020405
7 M_CURRENT_COL_POSITION Instance attribute Protected Type reference (TYPE) SYTABIX 0 Current Column Position 20020222
8 M_CURRENT_LINE Instance attribute Protected Type reference (TYPE) STRING Current Line 20020222
9 M_CURRENT_LINE_NOT_USED Instance attribute Protected Type reference (TYPE) BOOLE_D ADUPL_BOOLEAN-NO Current Line Content Not Used 20020222
10 M_CURRENT_LINE_NUMBER Instance attribute Protected Type reference (TYPE) SYTABIX 0 Current Line Number 20020222
11 M_CURRENT_LINE_WIDTH Instance attribute Protected Type reference (TYPE) SYTABIX 0 Width of Current Line 20020222
12 M_CURR_REC_SPANS_OVER_NEXT_LIN Instance attribute Protected Type reference (TYPE) BOOLE_D ADUPL_BOOLEAN-NO Current Record Spans Over the Next Line 20020304
13 M_DEBUG Static Attribute Public Type reference (TYPE) BOOLE_D ADUPL_BOOLEAN-NO Debug On/Off 20020222
14 M_DELETE_AFTER_READING Instance attribute Protected Type reference (TYPE) BOOLE_D ADUPL_BOOLEAN-NO Front End Files: Delete Input Line after reading from ITAB 20020401
15 M_FILE_OPENED Instance attribute Protected Type reference (TYPE) BOOLE_D ADUPL_BOOLEAN-NO File Opened? 20020222
16 M_FILE_PATH Instance attribute Public Type reference (TYPE) STRING Input File Path 20020222
17 M_HEADER_FOUND Instance attribute Protected Type reference (TYPE) BOOLE_D ADUPL_BOOLEAN-NO Header Found ? 20020222
18 M_SIMPLE_READING Instance attribute Protected Type reference (TYPE) BOOLE_D ADUPL_BOOLEAN-NO Do simple reading - Don't analyse the data 20020401
Methods
# Method Level Visibility Method type Description Created on
1 BREAK_FILEPATH_TO_MESSAGE_VARS Static method Public Method Break File Path to Message Variables 20020327
2 CHECK_FILE_EXISTENCE Static method Public Method Check Existence of Input File 20020304
3 CLEAR_FRONT_END_FILES_BUFFER Static method Public Method Clear the Front End Files Buffer 20020222
4 CLOSE_FILE Instance method Protected Method Close the Input File 20020222
5 CREATE_READER Static method Public Method Create File Reader Object for the given File Identifier Code 20020222
6 CURRENT_LINE Instance method Public Method Get the Current Line Number 20020330
7 DETECT_FILE Static method Public Method Detect the type of Input File 20020222
8 GET_FILE_CLOSED_MESSAGE Static method Public Method Get File Closed Message 20020327
9 GET_FILE_OPENED_MESSAGE Static method Public Method Get File Opened Message 20020327
10 INIT Instance method Public Method Act as Constructor 20020304
11 LINE_CONTENT_FOR_SPEC_MESSAGE Instance method Protected Method Line Content For SPEC2000 Messages 20020306
12 LOG_MESSAGE Instance method Protected Method Log Error Message 20020405
13 OPEN_FILE Instance method Protected Method Open the Input File 20020222
14 READ_HEADER Instance method Public Method Read the Header of the Input File 20020222
15 READ_LINE Instance method Protected Method Read line from file and initialize instance variables 20020222
16 READ_PART Instance method Public Method Read One Part from the Input File 20020222
17 SKIP_N_LINES Instance method Public Method Skip N Number of lines 20020330
Events
Class CL_ADS2KIPUPL_FILE_READER has no event.
Types
Class CL_ADS2KIPUPL_FILE_READER has no local type.
Method Signatures

Method BREAK_FILEPATH_TO_MESSAGE_VARS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_MSG Call by reference Type reference (TYPE) BAPIRET2 Rückgabeparameter 20020327
2 Importing I_FILE_PATH Value transfer Type reference (TYPE) STRING Dateipfad 20020327

Method BREAK_FILEPATH_TO_MESSAGE_VARS on class CL_ADS2KIPUPL_FILE_READER has no exception.

Method CHECK_FILE_EXISTENCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting E_RESULT Call by reference Type reference (TYPE) CHAR1 File Existence Check Result 20020304
2 Importing I_FILE_PATH Call by reference Type reference (TYPE) STRING Dateipfad 20020304
3 Importing I_FILE_TYPE Call by reference Type reference (TYPE) CHAR1 File Type(A/P) 20020304
# Exception Resumable Description Created on
1 INPUT_FILE_DOES_NOT_EXIST Input File does not exist 20020304

Method CLEAR_FRONT_END_FILES_BUFFER Signature

Method CLEAR_FRONT_END_FILES_BUFFER on class CL_ADS2KIPUPL_FILE_READER has no parameter.
Method CLEAR_FRONT_END_FILES_BUFFER on class CL_ADS2KIPUPL_FILE_READER has no exception.

Method CLOSE_FILE Signature

Method CLOSE_FILE on class CL_ADS2KIPUPL_FILE_READER has no parameter.
Method CLOSE_FILE on class CL_ADS2KIPUPL_FILE_READER has no exception.

Method CREATE_READER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ER_FILE_READER Call by reference Object reference (TYPE REF TO) CL_ADS2KIPUPL_FILE_READER File Reader Object 20020222
2 Importing IS_UPLOAD_OPTIONS Call by reference Type reference (TYPE) ADS2KIPUPL_UPLOAD_OPTIONS Upload Options 20020304
3 Importing I_FIC Call by reference Type reference (TYPE) ADSPC_FIC File Identifier Code 20020222
4 Importing I_FILE_PATH Call by reference Type reference (TYPE) STRING Input File Path 20020222
# Exception Resumable Description Created on
1 INPUT_FILE_DOES_NOT_EXIST Eingabedatei nicht vorhanden 20020222
2 INVALID_FILE_IDENTIFIER_CODE Invalid File Identifier Code 20020304

Method CURRENT_LINE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_CURRENT_LINE Value transfer Type reference (TYPE) I Current Line Number 20020330

Method CURRENT_LINE on class CL_ADS2KIPUPL_FILE_READER has no exception.

Method DETECT_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CS_UPLOAD_OPTIONS Call by reference Type reference (TYPE) ADS2KIPUPL_UPLOAD_OPTIONS Upload Options 20020222
2 Changing CT_MESSAGES Call by reference Type reference (TYPE) ADS2KIPUPL_MSG_COMM_O_TABLE SPEC2000 IP Upload: Table of Message Communication Structure 20020307
3 Exporting ER_FILE_READER Call by reference Object reference (TYPE REF TO) CL_ADS2KIPUPL_FILE_READER File Reader Object 20020222
4 Exporting ES_SPCIPHDR Call by reference Type reference (TYPE) API_SPCIPHDR Header Record of the Input File 20020222
5 Exporting ET_EXTENSION Call by reference Type reference (TYPE) API_T_SPCIPEXTN SPEC2000 Initial Provisioning: Extensions 20020422
6 Importing I_FILE_PATH Call by reference Type reference (TYPE) STRING Input File Path 20020222
# Exception Resumable Description Created on
1 END_OF_FILE End of File Reached 20020222
2 INPUT_FILE_DOES_NOT_EXIST Eingabedatei nicht vorhanden 20020222
3 INVALID_INPUT_FILE Ungültige Eingabedatei 20020222
4 REJECT_FILE Datei abgel. 20020307

Method GET_FILE_CLOSED_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_MSG Call by reference Type reference (TYPE) BAPIRET2 Rückgabeparameter 20020327
2 Importing I_FILE_PATH Value transfer Type reference (TYPE) STRING Dateipfad 20020327

Method GET_FILE_CLOSED_MESSAGE on class CL_ADS2KIPUPL_FILE_READER has no exception.

Method GET_FILE_OPENED_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_MSG Call by reference Type reference (TYPE) BAPIRET2 Rückgabeparameter 20020327
2 Importing I_FILE_PATH Value transfer Type reference (TYPE) STRING Dateipfad 20020327

Method GET_FILE_OPENED_MESSAGE on class CL_ADS2KIPUPL_FILE_READER has no exception.

Method INIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_UPLOAD_OPTIONS Call by reference Type reference (TYPE) ADS2KIPUPL_UPLOAD_OPTIONS SPEC2000 IP Upload: Struktur für Upload-Optionen 20020304
2 Importing I_FILE_PATH Call by reference Type reference (TYPE) STRING Input File Path 20020304
# Exception Resumable Description Created on
1 INPUT_FILE_DOES_NOT_EXIST Eingabedatei nicht vorhanden 20020304

Method LINE_CONTENT_FOR_SPEC_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning R_RETURN_LINE Value transfer Type reference (TYPE) STRING Return SPEC2000 Message Line (161 Chars) 20020308

Method LINE_CONTENT_FOR_SPEC_MESSAGE on class CL_ADS2KIPUPL_FILE_READER has no exception.

Method LOG_MESSAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_COLUMN_NO Value transfer Type reference (TYPE) ANY Column No 20020405
2 Importing I_CSN Value transfer Type reference (TYPE) ANY Location 20020405
3 Importing I_DM_LEVEL Value transfer Type reference (TYPE) ADS2KIPUPL_DM_LEVEL ADUPL_MESSAGE_DATA_MODEL_LEVEL-NONE Datenmodellebene 20020405
4 Importing I_EIM Value transfer Type reference (TYPE) ANY End Item Manufacturer 20020405
5 Importing I_EIP Value transfer Type reference (TYPE) ANY End Item Part 20020405
6 Importing I_LINE_NO Value transfer Type reference (TYPE) ANY ZeileNr 20020405
7 Importing I_MFR Value transfer Type reference (TYPE) ANY Manufacturer Code 20020405
8 Importing I_MSGCAT Value transfer Type reference (TYPE) ADS2KIPUPL_MSG_COMM-MSG_CATEGORY ADUPL_MSG_CATEGORY-REJECT_ELEMENT Nachrichtenkategorie 20020405
9 Importing I_MSGID Value transfer Type reference (TYPE) SYMSG-MSGID C_MSG_CLASS Messageidentifikation 20020405
10 Importing I_MSGNO Value transfer Type reference (TYPE) SYMSG-MSGNO Nachrichtennummer 20020405
11 Importing I_MSGTY Value transfer Type reference (TYPE) SYMSG-MSGTY ADUPL_MESSAGE_TYPE-WARNING Nachrichtentyp 20020405
12 Importing I_MSGV1 Value transfer Type reference (TYPE) ANY MessageVariable 1 20020405
13 Importing I_MSGV2 Value transfer Type reference (TYPE) ANY MessageVariable 2 20020405
14 Importing I_MSGV3 Value transfer Type reference (TYPE) ANY MessageVariable 3 20020405
15 Importing I_MSGV4 Value transfer Type reference (TYPE) ANY MessageVariable 4 20020405
16 Importing I_PNR Value transfer Type reference (TYPE) ANY Part Number 20020405
17 Importing I_PROB_CLASS Value transfer Type reference (TYPE) ADS2KIPUPL_MSG_COMM-PROB_CLASS ADUPL_PROBLEM_CLASS-NONE Problem Class 20020405
18 Importing I_SPEC_MESSAGE Value transfer Type reference (TYPE) ANY SPEC2000-Nachricht 20020405
19 Importing I_SPL Value transfer Type reference (TYPE) ANY Supplier Code 20020405

Method LOG_MESSAGE on class CL_ADS2KIPUPL_FILE_READER has no exception.

Method OPEN_FILE Signature

Method OPEN_FILE on class CL_ADS2KIPUPL_FILE_READER has no parameter.
# Exception Resumable Description Created on
1 INPUT_FILE_DOES_NOT_EXIST Eingabedatei nicht vorhanden 20020222

Method READ_HEADER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_MESSAGES Call by reference Type reference (TYPE) ADS2KIPUPL_MSG_COMM_O_TABLE Fehler-Meldungen 20020307
2 Exporting ES_SPCIPHDR Call by reference Type reference (TYPE) API_SPCIPHDR Header Record of the Input File 20020222
3 Exporting ET_EXTENSION Call by reference Type reference (TYPE) API_T_SPCIPEXTN SPEC2000 Initial Provisioning: Extensions 20020422
# Exception Resumable Description Created on
1 END_OF_FILE End of File Reached 20020222
2 INVALID_INPUT_FILE Ungültige Eingabedatei 20020222
3 REJECT_FILE Datei abgel. 20020222

Method READ_LINE Signature

Method READ_LINE on class CL_ADS2KIPUPL_FILE_READER has no parameter.
# Exception Resumable Description Created on
1 EMPTY_LINE Empty line in the Input File 20020222
2 EOF_REACHED End of File Reached 20020222

Method READ_PART Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CT_MESSAGES Call by reference Type reference (TYPE) ADS2KIPUPL_MSG_COMM_O_TABLE Fehler-Meldungen 20020308
2 Exporting ES_PART_KEY Call by reference Type reference (TYPE) ADS2KIPUPL_PART_KEY Part Key 20020222
3 Exporting ET_ENCODED_DATA Call by reference Type reference (TYPE) SPTA_INDXTAB File-type specific data (encoded) 20020222
4 Exporting ET_ENCODED_DATA_C Call by reference Type reference (TYPE) SPTA_INDXTAB File-type specific Customer data (encoded) 20020419
5 Exporting E_EOF Call by reference Type reference (TYPE) BOOLE_D End of File Reached 20020222
6 Exporting E_FILE_LINES_REJECTED Call by reference Type reference (TYPE) BOOLE_D File Lines Rejected; Part data is not read/returned 20020222
7 Exporting E_PART_REJECTED Call by reference Type reference (TYPE) BOOLE_D Part is rejected 20020222
8 Exporting E_SOME_RECORDS_REJECTED Call by reference Type reference (TYPE) BOOLE_D Some Records were rejected 20020222
9 Exporting E_SOME_SEGMENTS_REJECTED Call by reference Type reference (TYPE) BOOLE_D Some Segments were rejected 20020222
# Exception Resumable Description Created on
1 END_OF_FILE End of File Reached 20020222

Method SKIP_N_LINES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_NR_LINES_TO_SKIP Call by reference Type reference (TYPE) I Number of lines to skip 20020330
# Exception Resumable Description Created on
1 END_OF_FILE End of File Reached 20020330
History
Last changed by/on SAP  20050301 
SAP Release Created in 470