Package org.smyld.text

Class StringNavigator

java.lang.Object

org.smyld.text.StringNavigator

All Implemented Interfaces:

StringReader

Direct Known Subclasses:

EncodedStringNavigator

public class StringNavigator
extends Object
implements StringReader

This class will navigate through given text in serial order and will provide all the necessary methodes for reading the given text in parts

Version:

1.0

Author:

Mohammed Jameel

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_DATA_BLOCK_DELIM_SIZE
static int	DEFAULT_DATA_BLOCK_SIZE	/ Reads the text and fetchs the characters according to the given charachters no also the pointer is advanced accordingly @param charNo Number of characters to be read @return The resulted string and null if any error occured public String getText(int charNo){ if (charNo>0){ filePointer += charNo; String part = null; // Detecting the end of the available text if ((pointer+charNo) >= getText().length()){ residualText = getText().substring(pointer,getText().length()); // The case of variable amount of text to be read if (!FixedBlockRead){ int newBlockPart = charNo - residualText.length(); pointer = newBlockPart; if ((doReadData())&&(pointer==0)){ filePointer -= newBlockPart; return residualText + getText(newBlockPart); } }else{ EndOfText = true; } return residualText; } if (pointer<0) { int rsidualLength = residualText.length(); String leftPart = residualText.substring(rsidualLength+pointer); charNo += pointer; pointer=0; part = leftPart + getText().substring(pointer,pointer+charNo) ; }else{ part = getText().substring(pointer,pointer+charNo); } if ((pointer+charNo)== getText().length()) { doReadData(); }else{ updatePointer(charNo); } return part; } return ""; }

Constructor Summary

Constructors

Constructor	Description
StringNavigator(File textFile)	Constructs the class with the given file
StringNavigator(File textFile, int dataBlockSize)	Constructs the class with the given file and will read the information according to the provided data block size
StringNavigator(InputStream dataStream, int dataBlockSize)	Constructs the class with the given file and will read the information according to the provided data block size
StringNavigator(String Text)	Constructs the class with the given text

Method Summary

Modifier and Type	Method	Description
int	availableCharacters()	Returns the number of available characters in the buffer
void	close()
boolean	EndOfValue()
int	getDataBlockDelimiterSize()
int	getDataBlockSize()
String	getLastReadText()
long	getPosition()
String	getText()	Returns the text
String	getText(int charNo)	Reads the text and fetchs the characters according to the given charachters no also the pointer is advanced accordingly
String	getText(int charNo, int code)
boolean	isWithDelimiter()
void	jump(int stepNo)	The pointer is advanced with the given position number
void	reset()
void	setDataBlockDelimiterSize(int newDelimiterSize)
void	setDataBlockSize(int newBlockSize)
void	setText(String newText)	Sets the text
void	setWithDelimiter(boolean WithDelimiter)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DATA_BLOCK_SIZE

public static final int DEFAULT_DATA_BLOCK_SIZE

/ Reads the text and fetchs the characters according to the given charachters no also the pointer is advanced accordingly @param charNo Number of characters to be read @return The resulted string and null if any error occured public String getText(int charNo){ if (charNo>0){ filePointer += charNo; String part = null; // Detecting the end of the available text if ((pointer+charNo) >= getText().length()){ residualText = getText().substring(pointer,getText().length()); // The case of variable amount of text to be read if (!FixedBlockRead){ int newBlockPart = charNo - residualText.length(); pointer = newBlockPart; if ((doReadData())&&(pointer==0)){ filePointer -= newBlockPart; return residualText + getText(newBlockPart); } }else{ EndOfText = true; } return residualText; } if (pointer<0) { int rsidualLength = residualText.length(); String leftPart = residualText.substring(rsidualLength+pointer); charNo += pointer; pointer=0; part = leftPart + getText().substring(pointer,pointer+charNo) ; }else{ part = getText().substring(pointer,pointer+charNo); } if ((pointer+charNo)== getText().length()) { doReadData(); }else{ updatePointer(charNo); } return part; } return ""; }

See Also:

Constant Field Values

DEFAULT_DATA_BLOCK_DELIM_SIZE

public static final int DEFAULT_DATA_BLOCK_DELIM_SIZE

See Also:

Constant Field Values

Constructor Detail

StringNavigator

public StringNavigator(String Text)

Constructs the class with the given text

Parameters:

Text - the text for navigation

StringNavigator

public StringNavigator(File textFile)
                throws IOException

Constructs the class with the given file

Parameters:

textFile - the file that contains the text for navigation

Throws:

IOException - if the file does not exist or any error occured while reading it

StringNavigator

public StringNavigator(File textFile,
                       int dataBlockSize)
                throws IOException

Constructs the class with the given file and will read the information according to the provided data block size

Parameters:

textFile - the file that contains the text for navigation

Throws:

IOException - if the file does not exist or any error occured while reading it

StringNavigator

public StringNavigator(InputStream dataStream,
                       int dataBlockSize)
                throws IOException

Constructs the class with the given file and will read the information according to the provided data block size

Parameters:

textFile - the file that contains the text for navigation

Throws:

IOException - if the file does not exist or any error occured while reading it

Method Detail

close

public void close()
           throws Exception

Throws:

Exception

getText

public String getText(int charNo,
                      int code)

Specified by:

getText in interface StringReader

getText

public String getText(int charNo)

Reads the text and fetchs the characters according to the given charachters no also the pointer is advanced accordingly

Specified by:

getText in interface StringReader

Parameters:

charNo - Number of characters to be read

Returns:

The resulted string and null if any error occured

jump

public void jump(int stepNo)

The pointer is advanced with the given position number

Specified by:

jump in interface StringReader

Parameters:

stepsNo - Number of positions to jumb it can be negative to make the pointer move in the reverese direction

EndOfValue

public boolean EndOfValue()

availableCharacters

public int availableCharacters()

Returns the number of available characters in the buffer

Returns:

the left available characters

getText

public String getText()

Returns the text

Specified by:

getText in interface StringReader

setText

public void setText(String newText)

Sets the text

Parameters:

newText - the new text to be processed

reset

public void reset()

getPosition

public long getPosition()

setDataBlockSize

public void setDataBlockSize(int newBlockSize)

setDataBlockDelimiterSize

public void setDataBlockDelimiterSize(int newDelimiterSize)

setWithDelimiter

public void setWithDelimiter(boolean WithDelimiter)

getDataBlockSize

public int getDataBlockSize()

getDataBlockDelimiterSize

public int getDataBlockDelimiterSize()

isWithDelimiter

public boolean isWithDelimiter()

getLastReadText

public String getLastReadText()