org.safs.text

Class FileProcessor

java.lang.Object

org.safs.text.FileProcessor

public class FileProcessor
extends java.lang.Object

Functions to process files for specific text.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	status

Constructor Summary

Constructors

Constructor and Description
FileProcessor()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getEmbeddedSubstrings(java.lang.String file, java.lang.String regexStart, java.lang.String regexStop) Attempts to open the file and process each line in the file with the StringProcessor.getEmbeddedSubstring method.
java.lang.String	getTextFileContents(java.lang.String file) Read the contents of a text file line-by-line.
int	returnStatus() returns the status code of the last function called.
int	writeStringToFile(java.lang.String filename, java.lang.String text) Opens the file for writing, write the text, and close the file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

status

protected int status

Constructor Detail

FileProcessor

public FileProcessor()

Method Detail

getEmbeddedSubstrings

public java.lang.String[] getEmbeddedSubstrings(java.lang.String file,
                                                java.lang.String regexStart,
                                                java.lang.String regexStop)

Attempts to open the file and process each line in the file with the StringProcessor.getEmbeddedSubstring method. The substrings to be extracted are those in between but not including the expressions that define the start and end of the target substring.

Example string: "abcdefghi"

regexStart="abc"
regexStop ="ghi"

returned substring="def"

It returns a String[] of all the matching substrings.

Limitations: this method only returns the first match in a line. Subsequent matches appearing in the same line are ignored.

Parameters:

file - case-insensitive full absolute path to the file to process. The file is assumed to be in the default System codepage format. However, if the file contains valid UTF-8 marker bytes (239, 187, 191) then it will be opened as a UTF-8 file.

regexStart - regular expression that identifies the characters immediately before the substring to be extracted.

regexStop - regular expression that identifies the characters immediately following the substring to be extracted.

Returns:

String[] of each matching substring, one per line max.

See Also:

StringProcessor.getEmbeddedSubstring(String, String, String), FileUtilities.isFileUTF8(String)

returnStatus

public int returnStatus()

returns the status code of the last function called. The status codes are STAF return codes.

The following codes are implemented:
0 - Success
17 - File Open Error
18 - File Read Error
6 - Unknown Error

getTextFileContents

public java.lang.String getTextFileContents(java.lang.String file)

Read the contents of a text file line-by-line. Lines are retained in the returned text String with a single '\n' character.

Parameters:

file - case-insensitive full absolute path to the file to process. The file is assumed to be in the default System codepage format. However, if the file contains valid UTF-8 marker bytes (239, 187, 191) then it will be opened as a UTF-8 file.

Returns:

String contents of the file.

See Also:

FileUtilities.isFileUTF8(String)

writeStringToFile

public int writeStringToFile(java.lang.String filename,
                             java.lang.String text)

Opens the file for writing, write the text, and close the file.

Parameters:

filename - case-insensitive full absolute path to the file to process. The file is assumed to be in the default System codepage format.

text - String to write to the output file. The text will be written in the default System codepage format.

Returns:

0 on success; 1 on failure.