MatchReader

java.lang.Object
- javatools.datatypes.PeekIterator<java.util.regex.MatchResult>
- - javatools.filehandlers.MatchReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<java.util.regex.MatchResult>, java.util.Iterator<java.util.regex.MatchResult>

Direct Known Subclasses:

ByteMatchReader
```
public class MatchReader
extends PeekIterator<java.util.regex.MatchResult>
implements java.io.Closeable
```
This class is part of the Java Tools (see http://mpii.de/yago-naga/javatools). It is licensed under the Creative Commons Attribution License (see http://creativecommons.org/licenses/by/3.0) by the YAGO-NAGA team (see http://mpii.de/yago-naga). The MatchReader reads MatchResults from a file. It closes the Reader automatically if hasNext()==false. The MatchReader buffers always 1000 characters of the file, i.e. it can work with large files without caching them in total.
Example:
```
  MatchReader matchReader=new MatchReader("some Filename", "some Pattern");
  for(MatchResult matchResult : matchReader) {
    System.out.println(matchResult.group(1));
  }
```
The file is automatically closed after the last match has been read. If you do not read all matches, close the iterator manually by the method close().
A single quote (') preceded by a backslash will not match a quote in the pattern.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MatchReader.MyMatchResult
A MatchResult that undoes the quotes
- Nested classes/interfaces inherited from class javatools.datatypes.PeekIterator
  PeekIterator.ElementaryPeekIterator<T>, PeekIterator.SimplePeekIterator<T>

Nested Classes
Modifier and Type	Class and Description
`static class`	`MatchReader.MyMatchResult` A MatchResult that undoes the quotes

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.StringBuilder`	`buffer` Holds the current buffer
`int`	`BUFSIZE` Number of newly read chars
`protected long`	`chars` Char counter for Announce.progress
`protected boolean`	`crossLines` TRUE if newlines are to be replaces by spaces
`protected java.io.Reader`	`in` Holds the Reader
`protected int`	`lastMatchEnd` Points to the index of the last match
`protected java.util.regex.Matcher`	`matcher` Holds the current matcher
`int`	`MAXPATTERNLENGTH` Maximal length of a String matching a pattern
`protected java.util.regex.Pattern`	`pattern` Holds the pattern to be found
`static java.lang.String`	`QUOTE` Holds the string that quotes are replaced by

Fields inherited from class javatools.datatypes.PeekIterator
closed, EMPTY, initialized, next

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`MatchReader()` For subclasses
	`MatchReader(java.io.File f, java.util.regex.Pattern p)` Constructs a MatchReader that reads from a file
	`MatchReader(java.io.File f, java.util.regex.Pattern p, java.lang.String announceMsg)` Constructs a MatchReader that reads from a file, with progress message (main constructor)
	`MatchReader(java.io.File f, java.lang.String p)` Constructs a MatchReader that reads from a file
	`MatchReader(java.io.File f, java.lang.String p, boolean crossLines)` Constructs a MatchReader that reads from a file
	`MatchReader(java.io.File f, java.lang.String p, java.lang.String announceMsg)` Constructs a MatchReader that reads from a file, with progress message
	`MatchReader(java.io.Reader i, java.util.regex.Pattern p)` Constructs a MatchReader from a Reader and a Pattern
	`MatchReader(java.io.Reader i, java.lang.String p)` Constructs a MatchReader from a Reader and a Pattern
	`MatchReader(java.lang.String f, java.util.regex.Pattern p)` Constructs a MatchReader that reads from a file
	`MatchReader(java.lang.String f, java.util.regex.Pattern p, java.lang.String announceMsg)` Constructs a MatchReader that reads from a file, with progress message
	`MatchReader(java.lang.String f, java.lang.String p)` Constructs a MatchReader that reads from a file
	`MatchReader(java.lang.String f, java.lang.String p, java.lang.String announceMsg)` Constructs a MatchReader that reads from a file, with progress message

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the reader
`void`	`finalize()` Closes the reader
`java.util.regex.MatchResult`	`internalNext()` Returns the next MatchResult
`static void`	`main(java.lang.String[] args)` Test routine
`protected int`	`read()` Reads 1 character (simplification for subclass ByteMatchReader)

Methods inherited from class javatools.datatypes.PeekIterator
asList, asList, asSet, asSet, asSet, emptyIterator, hasNext, internalSilentNext, iterator, list, list, next, nextOrNull, numElements, numElements, peek, remove, toString, toString, toString

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Field Detail
- BUFSIZE
```
public final int BUFSIZE
```
  Number of newly read chars
  
  See Also:
  
  Constant Field Values
- MAXPATTERNLENGTH
```
public final int MAXPATTERNLENGTH
```
  Maximal length of a String matching a pattern
  
  See Also:
  
  Constant Field Values
- in
```
protected java.io.Reader in
```
  Holds the Reader
- matcher
```
protected java.util.regex.Matcher matcher
```
  Holds the current matcher
- buffer
```
protected java.lang.StringBuilder buffer
```
  Holds the current buffer
- pattern
```
protected java.util.regex.Pattern pattern
```
  Holds the pattern to be found
- chars
```
protected long chars
```
  Char counter for Announce.progress
- lastMatchEnd
```
protected int lastMatchEnd
```
  Points to the index of the last match
- QUOTE
```
public static final java.lang.String QUOTE
```
  Holds the string that quotes are replaced by
  
  See Also:
  
  Constant Field Values
- crossLines
```
protected boolean crossLines
```
  TRUE if newlines are to be replaces by spaces

Constructor Detail

MatchReader

public MatchReader(java.io.Reader i,
                   java.util.regex.Pattern p)

Constructs a MatchReader from a Reader and a Pattern

MatchReader

public MatchReader(java.io.Reader i,
                   java.lang.String p)

Constructs a MatchReader from a Reader and a Pattern

MatchReader

public MatchReader(java.io.File f,
                   java.util.regex.Pattern p,
                   java.lang.String announceMsg)
            throws java.io.FileNotFoundException

Constructs a MatchReader that reads from a file, with progress message (main constructor)

Throws:: java.io.FileNotFoundException

MatchReader

public MatchReader(java.lang.String f,
                   java.util.regex.Pattern p,
                   java.lang.String announceMsg)
            throws java.io.FileNotFoundException

Constructs a MatchReader that reads from a file, with progress message

Throws:: java.io.FileNotFoundException

MatchReader

public MatchReader(java.lang.String f,
                   java.lang.String p,
                   java.lang.String announceMsg)
            throws java.io.FileNotFoundException

Constructs a MatchReader that reads from a file, with progress message

Throws:: java.io.FileNotFoundException

MatchReader

public MatchReader(java.io.File f,
                   java.lang.String p,
                   java.lang.String announceMsg)
            throws java.io.FileNotFoundException

Constructs a MatchReader that reads from a file, with progress message

Throws:: java.io.FileNotFoundException