javatools.filehandlers

Class MatchReader

java.lang.Object

javatools.datatypes.PeekIterator<MatchResult>

javatools.filehandlers.MatchReader

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<MatchResult>, Iterator<MatchResult>

Direct Known Subclasses:

ByteMatchReader

public class MatchReader
extends PeekIterator<MatchResult>
implements Closeable

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 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>

Field Summary

Fields

Modifier and Type	Field and Description
protected 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 Reader	in Holds the Reader
protected int	lastMatchEnd Points to the index of the last match
protected Matcher	matcher Holds the current matcher
int	MAXPATTERNLENGTH Maximal length of a String matching a pattern
protected Pattern	pattern Holds the pattern to be found
static String	QUOTE Holds the string that quotes are replaced by

Fields inherited from class javatools.datatypes.PeekIterator

closed, EMPTY, fetchedNextValue, next

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Closes the reader
void	finalize() Closes the reader
MatchResult	internalNext() Returns the next MatchResult
static void	main(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 Reader in

Holds the Reader

matcher

protected Matcher matcher

Holds the current matcher

buffer

protected StringBuilder buffer

Holds the current buffer

pattern

protected 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 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(Reader i,
                   Pattern p)

Constructs a MatchReader from a Reader and a Pattern

MatchReader

public MatchReader(Reader i,
                   String p)

Constructs a MatchReader from a Reader and a Pattern

MatchReader

public MatchReader(File f,
                   Pattern p,
                   String announceMsg)
            throws FileNotFoundException

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

Throws:

FileNotFoundException

MatchReader

public MatchReader(String f,
                   Pattern p,
                   String announceMsg)
            throws FileNotFoundException

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

Throws:

FileNotFoundException

MatchReader

public MatchReader(String f,
                   String p,
                   String announceMsg)
            throws FileNotFoundException

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

Throws:

FileNotFoundException

MatchReader

public MatchReader(File f,
                   String p,
                   String announceMsg)
            throws FileNotFoundException

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

Throws:

FileNotFoundException

MatchReader

public MatchReader(File f,
                   String p,
                   boolean crossLines)
            throws FileNotFoundException

Constructs a MatchReader that reads from a file

Throws:

FileNotFoundException

MatchReader

public MatchReader(File f,
                   String p)
            throws FileNotFoundException

Constructs a MatchReader that reads from a file

Throws:

FileNotFoundException

MatchReader

public MatchReader(String f,
                   String p)
            throws FileNotFoundException

Constructs a MatchReader that reads from a file

Throws:

FileNotFoundException

MatchReader

public MatchReader(String f,
                   Pattern p)
            throws FileNotFoundException

Constructs a MatchReader that reads from a file

Throws:

FileNotFoundException

MatchReader

public MatchReader(File f,
                   Pattern p)
            throws FileNotFoundException

Constructs a MatchReader that reads from a file

Throws:

FileNotFoundException

MatchReader

protected MatchReader()

For subclasses

Method Detail

read

protected int read()
            throws IOException

Reads 1 character (simplification for subclass ByteMatchReader)

Throws:

IOException

internalNext

public MatchResult internalNext()

Returns the next MatchResult

Specified by:

internalNext in class PeekIterator<MatchResult>

close

public void close()

Closes the reader

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class PeekIterator<MatchResult>

finalize

public void finalize()

Closes the reader

Overrides:

finalize in class Object

main

public static void main(String[] args)
                 throws Exception

Test routine

Throws:

Exception