global

Class ExtractedString

java.lang.Object

global.ExtractedString

public class ExtractedString
extends java.lang.Object

Offers methods for extracting sub strings.

Author:

Andreas Fender

Constructor Summary

Constructors

Constructor and Description
ExtractedString()
ExtractedString(java.lang.String sourceString)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Float	asFloat() Returns the extracted string as a float.
java.lang.Integer	asInteger() Returns the extracted string as an integer.
boolean	endOfString() Tells, whether or not the extraction ends at the end of the source string, that is, no next extraction is possible.
ExtractedString	extract(int startPos, char terminalChar) Initializes the extraction.
ExtractedString	extract(int startPos, char[] terminalChars) Initializes the extraction.
ExtractedString	extract(int startPos, char[] terminalChars, int charMinCheckIndex) Initializes the extraction.
ExtractedString	extract(int startPos, char[] terminalChars, int charMinCheckIndex, char openBracket, char closeBracket) Initializes the extraction.
ExtractedString	extract(int startPos, char terminalChar, char openBracket, char closeBracket) Initializes the extraction.
ExtractedString	extract(int startPos, int endPos) Initializes the extraction.
char	getEndChar() Returns the character of the end of the extraction, which is usually a terminal character and not included in the extracted string.
int	getExLength() Returns the length of the extracted sub string.
java.lang.String	getExtracted() Returns the extracted string.
int	getNextPos() Returns the next position for example to begin the next extraction.
int	getNextPos(char spaceChar) Returns the next position for example to begin the next extraction and skips all characters which are equal to the given one.
int	getNextPos(char[] spaceChars) Returns the next position for example to begin the next extraction and skips all characters contained in the given array.
int	getStringEnd() Returns the position of the end of the extraction.
int	getStringStart() Returns the position of the start of the extraction.
boolean	hasFoundChar() Tells whether or not the extraction was stopped by a terminating character.
java.lang.String	restString(char spaceChar) Returns the sub string of the next position to the end of the source string.
void	setSource(java.lang.String string)
void	skipSpace(char[] spaceChars)
static int	skipSpace(java.lang.String sourceString, int startPos, char[] spaceChars) Returns the position of the next word in the given string according to the given start position.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExtractedString

public ExtractedString()

ExtractedString

public ExtractedString(java.lang.String sourceString)

Method Detail

extract

public ExtractedString extract(int startPos,
                      int endPos)

Initializes the extraction.

Parameters:

sourceString - the string from which to extract.

startPos - the start position from where to extract.

endPos - the end position until where to extract.

Returns:

this instance.

extract

public ExtractedString extract(int startPos,
                      char[] terminalChars,
                      int charMinCheckIndex,
                      char openBracket,
                      char closeBracket)

Initializes the extraction.

Parameters:

sourceString - the string from which to extract.

startPos - the start position from where to start the extraction.

terminalChars - the characters at where to end the extraction. Once one of the characters appear, the extraction is stopped.

charMinCheckIndex - the offset for the terminalChars array. Characters with index below this argument will not be checked.

openBracket - the opening bracket. The extraction never stops between an opening and a closing bracket.

closeBracket - the closing bracket. The extraction never stops between an opening and a closing bracket.

Returns:

this instance.

extract

public ExtractedString extract(int startPos,
                      char terminalChar,
                      char openBracket,
                      char closeBracket)

Initializes the extraction.

Parameters:

sourceString - the string from which to extract.

startPos - the start position from where to start the extraction.

terminalChar - the character at where to end the extraction.

openBracket - the opening bracket. The extraction never stops between an opening and a closing bracket.

closeBracket - the closing bracket. The extraction never stops between an opening and a closing bracket.

Returns:

this instance.

extract

public ExtractedString extract(int startPos,
                      char[] terminalChars,
                      int charMinCheckIndex)

Initializes the extraction.

Parameters:

sourceString - the string to extract from.

startPos - the start position of the extraction.

terminalChars - the characters at which to stop the extraction. That is, the extraction stops, if one of the given characters occurs, beginning at charMinCheckIndex.

charMinCheckIndex - an offset for the terminalChars array. All indices below charMinCheckIndex will be ignored.

Returns:

this instance.

extract

public ExtractedString extract(int startPos,
                      char[] terminalChars)

Initializes the extraction.

Parameters:

sourceString - the string to extract from.

startPos - the start position of the extraction.

terminalChars - the characters at which to stop the extraction. That is, the extraction stops, if one of the given characters occurs.

Returns:

this instance.

extract

public ExtractedString extract(int startPos,
                      char terminalChar)

Initializes the extraction.

Parameters:

sourceString - the string to extract from.

startPos - the start position of the extraction.

terminalChar - the character at where to stop the extraction.

Returns:

this instance.

skipSpace

public static int skipSpace(java.lang.String sourceString,
            int startPos,
            char[] spaceChars)

Returns the position of the next word in the given string according to the given start position.

Parameters:

sourceString - the string to get the next position of.

startPos - the minimum position.

spaceChars - the characters to skip.

Returns:

the position of the next occurrence of a character which is not contained in spaceChars.

restString

public java.lang.String restString(char spaceChar)

Returns the sub string of the next position to the end of the source string.

Parameters:

spaceChar - the character to skip when finding the next position.

Returns:

the rest sub string.

endOfString

public boolean endOfString()

Tells, whether or not the extraction ends at the end of the source string, that is, no next extraction is possible.

Returns:

true, if and only if, the end position of the extraction is larger or equal to the length of the source string minus one.

getStringStart

public int getStringStart()

Returns the position of the start of the extraction.

Returns:

the position of the start of the extraction.

getStringEnd

public int getStringEnd()

Returns the position of the end of the extraction.

Returns:

the position of the end of the extraction.

getEndChar

public char getEndChar()

Returns the character of the end of the extraction, which is usually a terminal character and not included in the extracted string.

Returns:

the character of the end of the extraction.

getExtracted

public java.lang.String getExtracted()

Returns the extracted string.

Returns:

the extracted string.

getNextPos

public int getNextPos(char[] spaceChars)

Returns the next position for example to begin the next extraction and skips all characters contained in the given array.

Parameters:

spaceChars - the characters to skip.

Returns:

the next position which is the first character not contained in spaceChars beginning at the current position. The length of the string, if there is no such character.

skipSpace

public void skipSpace(char[] spaceChars)

getNextPos

public int getNextPos(char spaceChar)

Returns the next position for example to begin the next extraction and skips all characters which are equal to the given one.

Parameters:

spaceChar - the character which is to be skipped.

Returns:

the next position which is the first character not equal to spaceChar beginning at the current position. The length of the string, if there is no such character.

getNextPos

public int getNextPos()

Returns the next position for example to begin the next extraction.

Returns:

the next position.

hasFoundChar

public boolean hasFoundChar()

Tells whether or not the extraction was stopped by a terminating character.

Returns:

true, if the extraction was stopped by a terminating character. False, otherwise.

getExLength

public int getExLength()

Returns the length of the extracted sub string.

Returns:

the length of the extracted sub string.

asFloat

public java.lang.Float asFloat()

Returns the extracted string as a float.

Returns:

the extracted string as a float or null, if it could not be parsed.

asInteger

public java.lang.Integer asInteger()

Returns the extracted string as an integer.

Returns:

the extracted string as an integer or null, if it could not be parsed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setSource

public void setSource(java.lang.String string)