info.bioinfweb.libralign.model.io

Class AbstractDataModelEventReader<M extends DataModel>

java.lang.Object

info.bioinfweb.libralign.model.io.AbstractDataModelEventReader<M>

All Implemented Interfaces:

info.bioinfweb.jphyloio.push.JPhyloIOEventListener, DataModelEventReader<M>

Direct Known Subclasses:

CharSetEventReader

public abstract class AbstractDataModelEventReader<M extends DataModel>
extends java.lang.Object
implements DataModelEventReader<M>

Implements shared functionality for all classes reading data from JPhyloIO events into implementations of DataModel.

Since:

0.4.0

Author:

Ben Stöver

Module:

info.bioinfweb.libralign.io

Constructor Summary

Constructors

Constructor and Description
AbstractDataModelEventReader(AlignmentDataReader mainReader, DataModelFactory<M> factory) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
MultiValuedMap<DataModelKey,M>	getCompletedModels() Returns the model objects that have been read from the underlying JPhyloIO event stream until now.
DataModelFactory<M>	getFactory() Returns the factory used to create new data models in this instance.
M	getFirstCompletedModel(DataModelKey key)
protected java.util.Map<DataModelKey,M>	getLoadingModels()
AlignmentDataReader	getMainReader() Returns the instance of the main reader (for reading alignment and data models) which uses this data model reader.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.bioinfweb.jphyloio.push.JPhyloIOEventListener

processEvent

Constructor Detail

AbstractDataModelEventReader

public AbstractDataModelEventReader(AlignmentDataReader mainReader,
                                    DataModelFactory<M> factory)

Creates a new instance of this class.

Parameters:

mainReader - the associates main reader instance forwarding to this reader

factory - the factory to be used to create new data model instance during reading

Method Detail

getMainReader

public AlignmentDataReader getMainReader()

Description copied from interface: DataModelEventReader

Returns the instance of the main reader (for reading alignment and data models) which uses this data model reader.

Specified by:

getMainReader in interface DataModelEventReader<M extends DataModel>

Returns:

the parent alignment and data reader

getFactory

public DataModelFactory<M> getFactory()

Description copied from interface: DataModelEventReader

Returns the factory used to create new data models in this instance.

Specified by:

getFactory in interface DataModelEventReader<M extends DataModel>

Returns:

the factory (never null)

getLoadingModels

protected java.util.Map<DataModelKey,M> getLoadingModels()

getFirstCompletedModel

public M getFirstCompletedModel(DataModelKey key)

getCompletedModels

public MultiValuedMap<DataModelKey,M> getCompletedModels()

Description copied from interface: DataModelEventReader

Returns the model objects that have been read from the underlying JPhyloIO event stream until now. The list may be modified by application classes (e.g. to remove consumed objects), but this may change the future behavior of some implementations.

Specified by:

getCompletedModels in interface DataModelEventReader<M extends DataModel>

Returns:

the associated model