FileControl Interface

com.bea.control
FileControl Interface

public interface FileControl

    extends Control

File Control base interface


All Superinterfaces
Control, Control, Serializable

Nested Class Summary

 
Nested classes from interface com.bea.control.Control
Control.Callback
 

Field Summary

public static final String
ATTR_ARCHIVE_DIR
String
public static final String
ATTR_CREATE_MODE
String
public static final String
ATTR_CREATE_MODE_OVERWRITE
String
public static final String
ATTR_CREATE_MODE_RENAME
String
public static final String
ATTR_CURRENT_DIR
String
public static final String
ATTR_DELIMITER
String
public static final String
ATTR_DELIMITER_CHECKBOX
String
public static final String
ATTR_ENCODING
String
public static final String
ATTR_ERROR_DIR
String
public static final String
ATTR_FILE_CONTENT
String
public static final String
ATTR_FILE_MASK
String
public static final String
ATTR_FTP_HOST_NAME
String
public static final String
ATTR_FTP_LOCAL_DIR
String
public static final String
ATTR_FTP_USER_NAME
String
public static final String
ATTR_IO_TYPE
String
public static final String
ATTR_IO_TYPE_APPEND
String
public static final String
ATTR_IO_TYPE_READ
String
public static final String
ATTR_IO_TYPE_READLINE
String
public static final String
ATTR_IO_TYPE_WRITE
String
public static final String
ATTR_POST_READ
String
public static final String
ATTR_POST_READ_ARCHIVE
String
public static final String
ATTR_POST_READ_DELETE
String
public static final String
ATTR_RECORD_SIZE
String
public static final String
ATTR_SUFFIX_NAME
String
public static final String
ATTR_SUFFIX_TYPE
String
public static final String
ATTR_SUFFIX_TYPE_INDEX
String
public static final String
ATTR_SUFFIX_TYPE_TIMESTAMP
String
public static final String
DYNAMIC_PROPERTIES_TAG
String
public static final long
serialVersionUID
long
public static final String
TAG_FILE
The file tag is used to define file control attributes
public static final String
TAG_FILE_OPERATION
The @jc:file-operation tag is used to annotate a JBCX method that provides a convenient template for the operations on files such as Read, Write and Append.
 

Method Summary

public void
copy(String fileName)
Copy the current file to the specified file name.
public void
delete()
Delete the current file.
public FileControlFileListDocument
getFiles()
Returns Iterator for the File objects matching the specified file mask in the current directory.
public FileControlPropertiesDocument
getProperties()
Get the dynamic properties for the control
public void
rename(String fileName)
Rename the current file to the specified file name.
public void
reset()
Reset the file control by closing any in-progress operations such as: readLine, readRecord and append.
public void
setProperties(FileControlPropertiesDocument xmlProp)
Set the dynamic properties for the control

Field Detail

ATTR_ARCHIVE_DIR

public static final String ATTR_ARCHIVE_DIR


ATTR_CREATE_MODE

public static final String ATTR_CREATE_MODE


ATTR_CREATE_MODE_OVERWRITE

public static final String ATTR_CREATE_MODE_OVERWRITE


ATTR_CREATE_MODE_RENAME

public static final String ATTR_CREATE_MODE_RENAME


ATTR_CURRENT_DIR

public static final String ATTR_CURRENT_DIR


ATTR_DELIMITER

public static final String ATTR_DELIMITER


ATTR_DELIMITER_CHECKBOX

public static final String ATTR_DELIMITER_CHECKBOX


ATTR_ENCODING

public static final String ATTR_ENCODING


ATTR_ERROR_DIR

public static final String ATTR_ERROR_DIR


ATTR_FILE_CONTENT

public static final String ATTR_FILE_CONTENT


ATTR_FILE_MASK

public static final String ATTR_FILE_MASK


ATTR_FTP_HOST_NAME

public static final String ATTR_FTP_HOST_NAME


ATTR_FTP_LOCAL_DIR

public static final String ATTR_FTP_LOCAL_DIR


ATTR_FTP_USER_NAME

public static final String ATTR_FTP_USER_NAME


ATTR_IO_TYPE

public static final String ATTR_IO_TYPE


ATTR_IO_TYPE_APPEND

public static final String ATTR_IO_TYPE_APPEND


ATTR_IO_TYPE_READ

public static final String ATTR_IO_TYPE_READ


ATTR_IO_TYPE_READLINE

public static final String ATTR_IO_TYPE_READLINE


ATTR_IO_TYPE_WRITE

public static final String ATTR_IO_TYPE_WRITE


ATTR_POST_READ

public static final String ATTR_POST_READ


ATTR_POST_READ_ARCHIVE

public static final String ATTR_POST_READ_ARCHIVE


ATTR_POST_READ_DELETE

public static final String ATTR_POST_READ_DELETE


ATTR_RECORD_SIZE

public static final String ATTR_RECORD_SIZE


ATTR_SUFFIX_NAME

public static final String ATTR_SUFFIX_NAME


ATTR_SUFFIX_TYPE

public static final String ATTR_SUFFIX_TYPE


ATTR_SUFFIX_TYPE_INDEX

public static final String ATTR_SUFFIX_TYPE_INDEX


ATTR_SUFFIX_TYPE_TIMESTAMP

public static final String ATTR_SUFFIX_TYPE_TIMESTAMP


DYNAMIC_PROPERTIES_TAG

public static final String DYNAMIC_PROPERTIES_TAG


serialVersionUID

public static final long serialVersionUID


TAG_FILE

public static final String TAG_FILE
The file tag is used to define file control attributes


TAG_FILE_OPERATION

public static final String TAG_FILE_OPERATION
The @jc:file-operation tag is used to annotate a JBCX method that provides a convenient template for the operations on files such as Read, Write and Append.

 

Method Detail

copy(String) Method

public void copy(String fileName)
throws FileNotFoundException, IOException, SecurityException, IllegalArgumentException
Copy the current file to the specified file name.

Parameters

fileName
name of the file name to be copied to

Exceptions

FileNotFoundException
if the file is not present
IOException
reading the file
SecurityException
reading the file
IllegalArgumentException
if invalid file name is specified

delete() Method

public void delete()
throws FileNotFoundException, IOException, SecurityException
Delete the current file.

Exceptions

FileNotFoundException
if the file is not present
IOException
reading the file
SecurityException
reading the file

getFiles() Method

public FileControlFileListDocument getFiles()
Returns Iterator for the File objects matching the specified file mask in the current directory.

Returns

an iterator for the File objects for the files in the current directory matching the file mask

getProperties() Method

public FileControlPropertiesDocument getProperties()
Get the dynamic properties for the control

Returns

a FileControlPropertiesDocument object

rename(String) Method

public void rename(String fileName)
throws FileNotFoundException, IOException, SecurityException, IllegalArgumentException
Rename the current file to the specified file name.

Parameters

fileName
name of the file to be renamed to

Exceptions

FileNotFoundException
if the file is not present
IOException
reading the file
SecurityException
reading the file
IllegalArgumentException
if invalid file name is specified

reset() Method

public void reset()
Reset the file control by closing any in-progress operations such as: readLine, readRecord and append.


setProperties(FileControlPropertiesDocument) Method

public void setProperties(FileControlPropertiesDocument xmlProp)
throws IllegalArgumentException
Set the dynamic properties for the control

Parameters

xmlProp
the dynamic properties for the control

Exceptions

IllegalArgumentException
if invalid properties are specified