Package psidev.psi.mi.jami.xml.io.writer.elements.impl.abstracts

Class AbstractXmlParameterWriter

java.lang.Object

psidev.psi.mi.jami.xml.io.writer.elements.impl.abstracts.AbstractXmlParameterWriter

All Implemented Interfaces:

PsiXmlElementWriter<Parameter>, PsiXmlParameterWriter

Direct Known Subclasses:

XmlModelledParameterWriter, XmlParameterWriter, XmlParameterWriter

public abstract class AbstractXmlParameterWriter
extends Object
implements PsiXmlParameterWriter

Abstract XML writer of a parameter

Since:

14/11/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Constructor Summary

Constructors

Constructor	Description
AbstractXmlParameterWriter(XMLStreamWriter writer, PsiXmlObjectCache objectIndex)	Constructor for AbstractXmlParameterWriter.

Method Summary

Modifier and Type	Method	Description
Experiment	getDefaultExperiment()	The default experiment that will be used to write a valid XML file but is not a real experiment attached to the interaction.
protected PsiXmlObjectCache	getObjectIndex()	Getter for the field objectIndex.
protected XMLStreamWriter	getStreamWriter()	Getter for the field streamWriter.
void	setDefaultExperiment(Experiment exp)	Sets the default experiment that will be used to write a valid XML file even if the interaction does not have any valid experiment
void	write(Parameter object)	write.
protected abstract void	writeOtherProperties(Parameter object)	writeOtherProperties.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlParameterWriter

public AbstractXmlParameterWriter(XMLStreamWriter writer,
                                  PsiXmlObjectCache objectIndex)

Constructor for AbstractXmlParameterWriter.

Parameters:

writer - a XMLStreamWriter object.

objectIndex - a PsiXmlObjectCache object.

Method Detail

write

public void write(Parameter object)
           throws MIIOException

write.

Specified by:

write in interface PsiXmlElementWriter<Parameter>

Parameters:

object - a T object.

Throws:

MIIOException - if any.

writeOtherProperties

protected abstract void writeOtherProperties(Parameter object)
                                      throws XMLStreamException

writeOtherProperties.

Parameters:

object - a Parameter object.

Throws:

XMLStreamException - if any.

getDefaultExperiment

public Experiment getDefaultExperiment()

The default experiment that will be used to write a valid XML file but is not a real experiment attached to the interaction.

Specified by:

getDefaultExperiment in interface PsiXmlParameterWriter

Returns:

a Experiment object.

setDefaultExperiment

public void setDefaultExperiment(Experiment exp)

Sets the default experiment that will be used to write a valid XML file even if the interaction does not have any valid experiment

Specified by:

setDefaultExperiment in interface PsiXmlParameterWriter

Parameters:

exp - a Experiment object.

getStreamWriter

protected XMLStreamWriter getStreamWriter()

Getter for the field streamWriter.

Returns:

a XMLStreamWriter object.

getObjectIndex

protected PsiXmlObjectCache getObjectIndex()

Getter for the field objectIndex.

Returns:

a PsiXmlObjectCache object.