Package chemaxon.marvin.plugin

Class PluginMDocSource

java.lang.Object

chemaxon.marvin.io.MDocSource

chemaxon.marvin.plugin.PluginMDocSource

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Molecule>

@PublicApi
public class PluginMDocSource
extends MDocSource

Multimolecular result source object based on result MDocument Iterator.

Since:

Marvin 5.0, 02/22/2007

Constructor Summary

Constructors

Constructor	Description
PluginMDocSource(Iterator iterator, int maxCount)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	estimateNumRecords()	Estimates the total number of records.
int	getRecordCount()	Gets the current record number.
int	getRecordCountMax()	Gets the total number of records.
boolean	isEndReached()	Tests whether the end of input is already reached.
boolean	isRewindable()	Tests whether rewinding (seeking backwards) is possible.
void	limitRecordCount(int limit)	Limits the number of result docs.
MDocument	nextDoc()	Produces the next document.
void	seekRecord(int k, MProgressMonitor pmon)	Seeks the specified record.
protected void	seekVisitedRecord(int k)	Seeks an already visited position in case of rewindable input.
boolean	skipRecord()	Skips the next document.

Methods inherited from class chemaxon.marvin.io.MDocSource

close, getDocLabel, getMDocumentStream, getMoleculeIterator, getMolStream, iterator, seekForward, seekRecordAtFraction, skipRecords

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

PluginMDocSource

public PluginMDocSource(Iterator iterator,
 int maxCount)

Constructor. Sets the enumerator.

Parameters:

iterator - the document iterator

maxCount - the number of result docs

Method Details

limitRecordCount

public void limitRecordCount(int limit)

Limits the number of result docs.

Parameters:

limit - the max number of result docs

nextDoc

public MDocument nextDoc()
                  throws IOException

Produces the next document.

Specified by:

nextDoc in class MDocSource

Returns:

the document or null at end of file

Throws:

IOException - If I/O error occurred

skipRecord

public boolean skipRecord()
                   throws IOException

Skips the next document.

Specified by:

skipRecord in class MDocSource

Returns:

true if the end of the next document is found, false if there is no chance to continue

Throws:

IOException - If I/O error occurred

isRewindable

public boolean isRewindable()

Tests whether rewinding (seeking backwards) is possible.

Specified by:

isRewindable in class MDocSource

Returns:

false

See Also:

• MDocSource.seekRecord(int, MProgressMonitor)
• MDocSource.seekRecordAtFraction(double, int, int, int, MProgressMonitor)

seekRecord

public void seekRecord(int k,
 MProgressMonitor pmon)
                throws IOException

Description copied from class: MDocSource

Seeks the specified record. Backward seeking (rewinding) in the stream is only possible if the underlying input stream is seekable. Forward seeking is always possible. Seeking terminates before reaching the specified position if the user cancels the progress dialog.

Specified by:

seekRecord in class MDocSource

Parameters:

k - position

pmon - progress monitor or null

Throws:

IOException - if read error occurred

See Also:

• MDocSource.isRewindable()
• MDocSource.seekRecordAtFraction(double, int, int, int, MProgressMonitor)

seekVisitedRecord

protected void seekVisitedRecord(int k)
                          throws IOException

Description copied from class: MDocSource

Seeks an already visited position in case of rewindable input.

Specified by:

seekVisitedRecord in class MDocSource

Parameters:

k - the record index

Throws:

IOException - if read error occurred

isEndReached

public boolean isEndReached()

Tests whether the end of input is already reached.

Specified by:

isEndReached in class MDocSource

Returns:

true if the end was reached, false otherwise

getRecordCount

public int getRecordCount()

Gets the current record number.

Specified by:

getRecordCount in class MDocSource

Returns:

the record number

getRecordCountMax

public int getRecordCountMax()

Gets the total number of records.

Specified by:

getRecordCountMax in class MDocSource

Returns:

the number of records

estimateNumRecords

public int estimateNumRecords()

Estimates the total number of records.

Specified by:

estimateNumRecords in class MDocSource

Returns:

estimated number of records or -1