Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> oro >> text >> [ regex overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.apache.oro.text.regex
Class PatternMatcherInput  

java.lang.Object
  org.apache.oro.text.regex.PatternMatcherInput

---

public final class PatternMatcherInput

extends java.lang.Object

The PatternMatcherInput class is used to preserve state across calls to the contains() methods of PatternMatcher instances. It is also used to specify that only a subregion of a string should be used as input when looking for a pattern match. All that is meant by preserving state is that the end offset of the last match is remembered, so that the next match is performed from that point where the last match left off. This offset can be accessed from the getCurrentOffset() 55 method and can be set with the setCurrentOffset(int) 55 method.

You would use a PatternMatcherInput object when you want to search for more than just the first occurrence of a pattern in a string, or when you only want to search a subregion of the string for a match. An example of its most common use is:

 PatternMatcher matcher;
 PatternCompiler compiler;
 Pattern pattern;
 PatternMatcherInput input;
 MatchResult result;

 compiler = new Perl5Compiler();
 matcher  = new Perl5Matcher();

 try {
   pattern = compiler.compile(somePatternString);
 } catch(MalformedPatternException e) {
   System.out.println("Bad pattern.");
   System.out.println(e.getMessage());
   return;
 }

 input   = new PatternMatcherInput(someStringInput);

 while(matcher.contains(input, pattern)) {
   result = matcher.getMatch();  
   // Perform whatever processing on the result you want.
 }
 // Suppose we want to start searching from the beginning again with
 // a different pattern.
 // Just set the current offset to the begin offset.
 input.setCurrentOffset(input.getBeginOffset());

 // Second search omitted

 // Suppose we're done with this input, but want to search another string.
 // There's no need to create another PatternMatcherInput instance.
 // We can just use the setInput() method.
 input.setInput(aNewInputString);

 

Since:

1.0

Version:

@version@

---

Field Summary
(package private)  int	_beginOffset
(package private)  int	_currentOffset
(package private)  int	_endOffset
(package private)  int	_matchBeginOffset
(package private)  int	_matchEndOffset
(package private)  char[]	_originalBuffer
(package private)  char[]	_originalCharInput
(package private)  java.lang.String	_originalStringInput
(package private)  char[]	_toLowerBuffer

 

Constructor Summary

PatternMatcherInput(char[] input)           Like calling:

PatternMatcherInput(char[] input, int begin, int length)           Creates a PatternMatcherInput object, associating a region of a string (represented as a char[]) as input to be used for pattern matching by PatternMatcher objects.

PatternMatcherInput(java.lang.String input)           Like calling

PatternMatcherInput(java.lang.String input, int begin, int length)           Creates a PatternMatcherInput object, associating a region of a String as input to be used for pattern matching by PatternMatcher objects.

 

Method Summary
char	charAt(int offset)           Returns the character at a particular offset relative to the begin offset of the input.
boolean	endOfInput()           Returns whether or not the end of the input has been reached.
int	getBeginOffset()
char[]	getBuffer()           Retrieves the char[] buffer to be used used as input by PatternMatcher implementations to look for matches.
int	getCurrentOffset()
int	getEndOffset()
java.lang.Object	getInput()           Retrieves the original input used to initialize the PatternMatcherInput instance.
int	getMatchBeginOffset()           Returns the offset marking the beginning of the match found by contains().
int	getMatchEndOffset()           Returns the offset marking the end of the match found by contains().
int	length()
java.lang.String	match()           A convenience method returning the part of the input corresponding to the last match found by a call to a Perl5Matcher contains 55 method.
java.lang.String	postMatch()           A convenience method returning the part of the input occurring after the last match found by a call to a Perl5Matcher contains 55 method.
java.lang.String	preMatch()           A convenience method returning the part of the input occurring before the last match found by a call to a Perl5Matcher contains 55 method.
void	setBeginOffset(int offset)           Sets the offset of the input that should be considered the start of the region to be considered as input by PatternMatcher methods.
void	setCurrentOffset(int offset)           Sets the offset of the input that should be considered the current offset where PatternMatcher methods should start looking for matches.
void	setEndOffset(int offset)           Sets the offset of the input that should be considered the end of the region to be considered as input by PatternMatcher methods.
void	setInput(char[] input)           This method is identical to calling:
void	setInput(char[] input, int begin, int length)           Associates a region of a string (represented as a char[]) as input to be used for pattern matching by PatternMatcher objects.
void	setInput(java.lang.String input)           This method is identical to calling:
void	setInput(java.lang.String input, int begin, int length)           Associates a region of a String as input to be used for pattern matching by PatternMatcher objects.
void	setMatchOffsets(int matchBeginOffset, int matchEndOffset)           This method is intended for use by PatternMatcher implementations.
java.lang.String	substring(int beginOffset)           Returns a new string that is a substring of the PatternMatcherInput instance.
java.lang.String	substring(int beginOffset, int endOffset)           Returns a new string that is a substring of the PatternMatcherInput instance.
java.lang.String	toString()           Returns the string representation of the input, where the input is considered to start from the begin offset and end at the end offset.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

_originalStringInput

java.lang.String _originalStringInput

---

_originalCharInput

char[] _originalCharInput

---

_originalBuffer

char[] _originalBuffer

---

_toLowerBuffer

char[] _toLowerBuffer

---

_beginOffset

int _beginOffset

---

_endOffset

int _endOffset

---

_currentOffset

int _currentOffset

---

_matchBeginOffset

int _matchBeginOffset

---

_matchEndOffset

int _matchEndOffset

Constructor Detail

PatternMatcherInput

public PatternMatcherInput(java.lang.String input,
                           int begin,
                           int length)

Creates a PatternMatcherInput object, associating a region of a String as input to be used for pattern matching by PatternMatcher objects. A copy of the string is not made, therefore you should not modify the string unless you know what you are doing. The current offset of the PatternMatcherInput is set to the begin offset of the region.

---

PatternMatcherInput

public PatternMatcherInput(java.lang.String input)

Like calling

 PatternMatcherInput(input, 0, input.length());
 

---

PatternMatcherInput

public PatternMatcherInput(char[] input,
                           int begin,
                           int length)

Creates a PatternMatcherInput object, associating a region of a string (represented as a char[]) as input to be used for pattern matching by PatternMatcher objects. A copy of the string is not made, therefore you should not modify the string unless you know what you are doing. The current offset of the PatternMatcherInput is set to the begin offset of the region.

---

PatternMatcherInput

public PatternMatcherInput(char[] input)

Like calling:

 PatternMatcherInput(input, 0, input.length);
 

Method Detail

length

public int length()

---

setInput

public void setInput(java.lang.String input,
                     int begin,
                     int length)

Associates a region of a String as input to be used for pattern matching by PatternMatcher objects. The current offset of the PatternMatcherInput is set to the begin offset of the region.

---

setInput

public void setInput(java.lang.String input)

This method is identical to calling:

 setInput(input, 0, input.length());
 

---

setInput

public void setInput(char[] input,
                     int begin,
                     int length)

Associates a region of a string (represented as a char[]) as input to be used for pattern matching by PatternMatcher objects. A copy of the string is not made, therefore you should not modify the string unless you know what you are doing. The current offset of the PatternMatcherInput is set to the begin offset of the region.

---

setInput

public void setInput(char[] input)

This method is identical to calling:

 setInput(input, 0, input.length);
 

---

charAt

public char charAt(int offset)

Returns the character at a particular offset relative to the begin offset of the input.

---

substring

public java.lang.String substring(int beginOffset,
                                  int endOffset)

Returns a new string that is a substring of the PatternMatcherInput instance. The substring begins at the specified beginOffset relative to the begin offset and extends to the specified endOffset - 1 relative to the begin offset of the PatternMatcherInput instance.

---

substring

public java.lang.String substring(int beginOffset)

Returns a new string that is a substring of the PatternMatcherInput instance. The substring begins at the specified beginOffset relative to the begin offset and extends to the end offset of the PatternMatcherInput.

---

getInput

public java.lang.Object getInput()

Retrieves the original input used to initialize the PatternMatcherInput instance. If a String was used, the String instance will be returned. If a char[] was used, a char instance will be returned. This violates data encapsulation and hiding principles, but it is a great convenience for the programmer.

---

getBuffer

public char[] getBuffer()

Retrieves the char[] buffer to be used used as input by PatternMatcher implementations to look for matches. This array should be treated as read only by the programmer.

---

endOfInput

public boolean endOfInput()

Returns whether or not the end of the input has been reached.

---

getBeginOffset

public int getBeginOffset()

---

getEndOffset

public int getEndOffset()

---

getCurrentOffset

public int getCurrentOffset()

---

setBeginOffset

public void setBeginOffset(int offset)

Sets the offset of the input that should be considered the start of the region to be considered as input by PatternMatcher methods. In other words, everything before this offset is ignored by a PatternMatcher.

---

setEndOffset

public void setEndOffset(int offset)

Sets the offset of the input that should be considered the end of the region to be considered as input by PatternMatcher methods. This offset is actually 1 plus the last offset that is part of the input region.

---

setCurrentOffset

public void setCurrentOffset(int offset)

Sets the offset of the input that should be considered the current offset where PatternMatcher methods should start looking for matches. Also resets all match offset information to -1. By calling this method, you invalidate all previous match information. Therefore a PatternMatcher implementation must call this method before setting match offset information.

---

toString

public java.lang.String toString()

Returns the string representation of the input, where the input is considered to start from the begin offset and end at the end offset.

---

preMatch

public java.lang.String preMatch()

A convenience method returning the part of the input occurring before the last match found by a call to a Perl5Matcher contains 55 method.

---

postMatch

public java.lang.String postMatch()

A convenience method returning the part of the input occurring after the last match found by a call to a Perl5Matcher contains 55 method.

---

match

public java.lang.String match()

A convenience method returning the part of the input corresponding to the last match found by a call to a Perl5Matcher contains 55 method. The method is not called getMatch() so as not to confuse it with Perl5Matcher's getMatch() which returns a MatchResult instance and also for consistency with preMatch() and postMatch().

---

setMatchOffsets

public void setMatchOffsets(int matchBeginOffset,
                            int matchEndOffset)

This method is intended for use by PatternMatcher implementations. It is necessary to record the location of the previous match so that consecutive contains() matches involving null string matches are properly handled. If you are not implementing a PatternMatcher, forget this method exists. If you use it outside of its intended context, you will only disrupt the stored state.

As a note, the preMatch(), postMatch(), and match() methods are provided as conveniences because PatternMatcherInput must store match offset information to completely preserve state for consecutive PatternMatcher contains() matches.

---

getMatchBeginOffset

public int getMatchBeginOffset()

Returns the offset marking the beginning of the match found by contains().

---

getMatchEndOffset

public int getMatchEndOffset()

Returns the offset marking the end of the match found by contains().

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> apache >> oro >> text >> [ regex overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---