info.bioinfweb.libralign.model.io

Interface DataModelEventReader<M extends DataModel>

Type Parameters:

M - the type of data model to read by this reader

All Superinterfaces:

info.bioinfweb.jphyloio.push.JPhyloIOEventListener

All Known Implementing Classes:

AbstractDataModelEventReader, CharSetEventReader

public interface DataModelEventReader<M extends DataModel>
extends info.bioinfweb.jphyloio.push.JPhyloIOEventListener

Interface to be implemented by all readers that process JPhyloIO events to read data to be stored in implementations of DataModel.

All implementations should accept an instance of DataModel as a constructor parameter that will than be returned by #getModels(). Implementing classes should not allow to change the model during runtime, since changing the model between two calls of JPhyloIOEventListener.processEvent(info.bioinfweb.jphyloio.JPhyloIOEventReader, info.bioinfweb.jphyloio.events.JPhyloIOEvent) should be avoided.

Since:

0.4.0

Author:

Ben Stöver

Module:

info.bioinfweb.libralign.io

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.
AlignmentDataReader	getMainReader() Returns the instance of the main reader (for reading alignment and data models) which uses this data model reader.

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

processEvent

Method Detail

getMainReader

AlignmentDataReader getMainReader()

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

Returns:

the parent alignment and data reader

getCompletedModels

MultiValuedMap<DataModelKey,M> getCompletedModels()

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.

Returns:

the associated model

getFactory

DataModelFactory<M> getFactory()

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

Returns:

the factory (never null)