fr.ifremer.isisfish.logging.io
Class LineReader

java.lang.Object
  fr.ifremer.isisfish.logging.io.LineReader

Direct Known Subclasses:

LineReaderUtil.LevelLineReader, LineReaderUtil.LevelsLineReader, LineReaderUtil.PatternLineReader

public class LineReader
extends java.lang.Object

A lineReader reads lines from a file using a RandomAccessFile.

To perfrom efficient io operations, we use a OffsetReader to obtain the offset of the first char of a line.

You can create a new LineReader from a previous one, the matchings lines of the new LineReader will all match the parent one (subset LineReader).

Author:

chemit

Field Summary

protected java.io.File	file
protected java.lang.String	id an identifier for the reader
protected long	lastModified last modified time of the file after last synchronization
protected long	length size of the file after last synchronization
protected static org.apache.commons.logging.Log	log
protected OffsetReader	offstReader offset reader used
protected LineReader	parent parent LineReader
protected java.io.RandomAccessFile	reader file reader

Constructor Summary

LineReader(java.io.File file, OffsetReader offstReader)

LineReader(LineReader parent, OffsetReader offstReader)

Method Summary

void	close() Close the reader.
protected void	ensureOpen()
protected void	finalize()
java.io.File	getFile()
java.lang.String	getId()
long	getNbLines()
OffsetReader	getOffsetReader()
LineReader	getParent()
boolean	isOpen()
boolean	isUpToDate()
boolean	match(java.lang.String line) Matcher of line for this reader.
void	open() method we must inovke before any access to lines
java.lang.String	readLine(long position) Read a line from a given position.
java.lang.String[]	readLine(long position, int length) Read some line(s) from a given position.
java.lang.String	readLine2(long position) Read a line from a given position.
java.lang.String[]	readLine2(long position, int length) Read some line(s) from a given position.
void	setId(java.lang.String id)
java.lang.String	toString()
void	update() check if reader is up to date, and if not perform an update.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

file

protected java.io.File file

reader

protected java.io.RandomAccessFile reader

file reader

length

protected long length

size of the file after last synchronization

lastModified

protected long lastModified

last modified time of the file after last synchronization

parent

protected LineReader parent

parent LineReader

offstReader

protected OffsetReader offstReader

offset reader used

id

protected java.lang.String id

an identifier for the reader

Constructor Detail

LineReader

public LineReader(LineReader parent,
                  OffsetReader offstReader)

LineReader

public LineReader(java.io.File file,
                  OffsetReader offstReader)

Method Detail

open

public void open()
          throws java.io.IOException

method we must inovke before any access to lines

Throws:

java.io.IOException - if any probem while opening reader

close

public void close()
           throws java.io.IOException

Close the reader.

Throws:

java.io.IOException - if any problem while closing reader

readLine2

public java.lang.String readLine2(long position)
                           throws java.io.IOException

Read a line from a given position.

Parameters:

position - position of the line in the file

Returns:

the line found, or null

Throws:

java.io.IOException - if any problem while reading

readLine2

public java.lang.String[] readLine2(long position,
                                    int length)
                             throws java.io.IOException

Read some line(s) from a given position.

Parameters:

position - position of the line in the file

length - the number of lines we want

Returns:

the array of lines required, or null if eof

Throws:

java.io.IOException - if any problem while reading

readLine

public java.lang.String readLine(long position)
                          throws java.io.IOException

Read a line from a given position.

Parameters:

position - position of the line in the file

Returns:

the line found, or null

Throws:

java.io.IOException - if any problem while reading

readLine

public java.lang.String[] readLine(long position,
                                   int length)
                            throws java.io.IOException

Read some line(s) from a given position.

Parameters:

position - position of the line in the file

length - the number of lines we want

Returns:

the array of lines required, or null if eof

Throws:

java.io.IOException - if any problem while reading

update

public void update()
            throws java.io.IOException

check if reader is up to date, and if not perform an update.

Throws:

java.io.IOException - if any problem while updating

match

public boolean match(java.lang.String line)

Matcher of line for this reader.

Parameters:

line - the line to be accepted by this line reader

Returns:

true if the line must be used,false otherwise

getNbLines

public long getNbLines()

Returns:

the number of lines found in the file

getFile

public java.io.File getFile()

Returns:

the file used to read lines

getOffsetReader

public OffsetReader getOffsetReader()

Returns:

the offset reader used to obtain offsets.

getParent

public LineReader getParent()

Returns:

the parent LineReader, or null if none

isUpToDate

public boolean isUpToDate()

Returns:

true if file is up to date,false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

ensureOpen

protected void ensureOpen()

isOpen

public boolean isOpen()

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)