Package psidev.psi.mi.jami.datasource

Interface MIDataSource

All Known Subinterfaces:

BinaryInteractionEvidenceSource, BinaryInteractionEvidenceStream, BinaryInteractionSource<T>, BinaryInteractionStream<T>, ComplexSource, ComplexStream, CsvSource<I>, CsvStreamSource<I>, CvTermStream, ExperimentStream, InteractionEvidenceSource<T>, InteractionEvidenceStream<T>, InteractionSource<T>, InteractionStream<T>, InteractorStream<T>, MIFileDataSource, MitabSource<I>, MitabStreamSource<I>, ModelledBinaryInteractionSource, ModelledBinaryInteractionStream, ModelledInteractionSource<T>, ModelledInteractionStream<T>, OrganismStream, PsiXmlSource<I>, PsiXmlStreamSource<I>, PublicationStream

All Known Implementing Classes:

AbstractCsvSource, AbstractCsvStreamSource, AbstractMitabSource, AbstractMitabStreamSource, AbstractPsiXmlBinarySource, AbstractPsiXmlBinaryStream, AbstractPsiXmlSource, AbstractPsiXmlStream, CsvBinaryEvidenceSource, CsvBinaryEvidenceStreamSource, CsvEvidenceSource, CsvEvidenceStreamSource, CsvMixedEvidenceSource, CsvNaryEvidenceSource, DefaultMitabSource, DefaultMitabStreamSource, DefaultPsiXmlSource, DefaultPsiXmlStreamSource, LightMitabBinarySource, LightMitabBinaryStreamSource, LightMitabSource, LightMitabStreamSource, LightXmlBinarySource, LightXmlBinaryStreamSource, LightXmlSource, LightXmlStreamSource, MitabBinaryEvidenceSource, MitabBinaryEvidenceStreamSource, MitabEvidenceSource, MitabEvidenceStreamSource, MitabModelledBinarySource, MitabModelledBinaryStreamSource, MitabModelledSource, MitabModelledStreamSource, XmlBinaryEvidenceSource, XmlBinaryEvidenceStreamSource, XmlBinarySource, XmlBinaryStreamSource, XmlComplexSource, XmlComplexStreamSource, XmlEvidenceSource, XmlEvidenceStreamSource, XmlModelledBinarySource, XmlModelledBinaryStreamSource, XmlModelledSource, XmlModelledStreamSource, XmlSource, XmlStreamSource

public interface MIDataSource

A data Source in JAMI. A MIDataSource can initialise itself with a map of options. Some dataSources (file dataSources mainly) need to be closed. Some MIDataSource can be reset and re-initialised

Since:

01/03/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Method Summary

Modifier and Type	Method	Description
void	close()	This method close the file data source and all opened streams and readers
void	initialiseContext(Map<String,Object> options)	Initialise the context of the MIDataSource given a map of options
void	reset()	This method will reset the data sources from all loaded options.

Method Detail

initialiseContext

void initialiseContext(Map<String,Object> options)

Initialise the context of the MIDataSource given a map of options

Parameters:

options - : the options provided by the user

close

void close()
    throws MIIOException

This method close the file data source and all opened streams and readers

Throws:

MIIOException - if the dataSource cannot be closed

reset

void reset()
    throws MIIOException

This method will reset the data sources from all loaded options. The data source will be back to what is was before the initialiseContext was called. To re-use the data source after calling the reset() method, the data source needs to be re-initialised with initialiseContext. Any provided inputStream or reader will not be closed and will have to be closed separately.

Throws:

MIIOException - if the dataSource cannot be reset