SAP ABAP Class CL_ESH_XML_IMPORT_FILE_UTILS (Utilities for handling files)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_TOOLS (Package) Tools for BOS

Properties

Class	CL_ESH_XML_IMPORT_FILE_UTILS
Short Description	Utilities for handling files
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_TOOLS	Tools for BOS
Created	20081112	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_ESH_XML_IMPORT_FILE_UTILS has no forward declaration.

Interfaces

Class CL_ESH_XML_IMPORT_FILE_UTILS has no interface implemented.

Friends

Class CL_ESH_XML_IMPORT_FILE_UTILS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_FILETABLE	Instance attribute	Private	☐	Type reference (TYPE)	FILETABLE		File name table	20081112

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASK_USER_FOR_DIRECTORY	Static method	Public	Method	Present a dialog to the user for dir selection	20081112
2	GET_FILES_IN_DIR	Static method	Public	Method	Get all the files in a supplied dir ( with optional filter)	20081112
3	GET_FILETABLE	Instance method	Public	Method	Get the current list of files for this instance	20081112
4	GET_XML_FILETABLE	Instance method	Public	Method	Transform a string file table to ESH XML file table	20090116
5	GET_XML_FILE_READER	Static method	Public	Method	Get a reference to an XML file reader	20081112
6	SET_FILETABLE	Instance method	Public	Method	Set the file table class attribute (and return it)	20081112

Events

Class CL_ESH_XML_IMPORT_FILE_UTILS has no event.

Types

Class CL_ESH_XML_IMPORT_FILE_UTILS has no local type.

Method Signatures

Method ASK_USER_FOR_DIRECTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_DIR	Value transfer	☐	Type reference (TYPE)	STRING		Path to directory	20081112
2	Importing	IV_DEFAULTFOLDER	Call by reference	☑	Type reference (TYPE)	STRING			20090121

#	Exception	Resumable	Description	Created on
1	CX_ESH_FILE_HANDLE_ERROR	☐	File system handling errors	20081112

Method GET_FILES_IN_DIR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	IV_DIRECTORY	Call by reference	☐	Type reference (TYPE)	STRING		Diretory to read files from	20081112
2	Importing	IV_FILETYPE	Call by reference	☑	Type reference (TYPE)	STRING		Filter for filetype	20081112
3	Changing	RT_FILETABLE	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Files found in directory	20081112

#	Exception	Resumable	Description	Created on
1	CX_ESH_FILE_HANDLE_ERROR	☐		20081112

Method GET_FILETABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_FILETABLE	Value transfer	☐	Type reference (TYPE)	STRING_TABLE			20081112

#	Exception	Resumable	Description	Created on
1	CX_ESH_FILE_HANDLE_ERROR	☐		20081112

Method GET_XML_FILETABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_XML_IMPORT	Call by reference	☐	Object reference (TYPE REF TO)	CL_ESH_OM_XML_IMPORT		Handle import of XML files from 7.04 (templates, config, ..)	20090120
2	Importing	IT_STRINGS	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20090116
3	Importing	IV_DIR	Call by reference	☐	Type reference (TYPE)	STRING			20090116
4	Importing	IV_IS_SAP_SYSTEM	Call by reference	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20090123
5	Returning	RT_FILETABLE	Value transfer	☐	Type reference (TYPE)	ESH_T_TOOLS_XML_FILETABLE		Table for XML files to be imported	20090116

#	Exception	Resumable	Description	Created on
1	CX_ESH_FILE_HANDLE_ERROR	☐	File system handling errors	20090116

Method GET_XML_FILE_READER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FILE_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Path to the file to read	20081112
2	Returning	XML_FILE_READER	Value transfer	☐	Object reference (TYPE REF TO)	IF_SXML_READER		XML reader reference	20081112

#	Exception	Resumable	Description	Created on
1	CX_ESH_FILE_HANDLE_ERROR	☐	File system handling errors	20081112

Method SET_FILETABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	RT_FILETABLE	Value transfer	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20081112

#	Exception	Resumable	Description	Created on
1	CX_ESH_FILE_HANDLE_ERROR	☐	File system handling errors	20081112

History

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