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

Class AbstractXmlFeatureWriter<F extends Feature>

java.lang.Object

psidev.psi.mi.jami.xml.io.writer.elements.impl.abstracts.AbstractXmlFeatureWriter<F>

All Implemented Interfaces:

PsiXmlElementWriter<F>

Direct Known Subclasses:

AbstractXmlFeatureWriter, AbstractXmlFeatureWriter

public abstract class AbstractXmlFeatureWriter<F extends Feature>
extends Object
implements PsiXmlElementWriter<F>

Abstract writer for Xml25Feature.

Since:

13/11/13

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PsiXmlElementWriter<Alias>	getAliasWriter()	Getter for the field aliasWriter.
PsiXmlElementWriter<Annotation>	getAttributeWriter()	Getter for the field attributeWriter.
PsiXmlVariableNameWriter<CvTerm>	getFeatureTypeWriter()	Getter for the field featureTypeWriter.
protected PsiXmlObjectCache	getObjectIndex()	Getter for the field objectIndex.
PsiXmlElementWriter<Range>	getRangeWriter()	Getter for the field rangeWriter.
protected XMLStreamWriter	getStreamWriter()	Getter for the field streamWriter.
PsiXmlXrefWriter	getXrefWriter()	Getter for the field xrefWriter.
protected abstract void	initialiseFeatureTypeWriter()	initialiseFeatureTypeWriter.
protected abstract void	initialiseRangeWriter()	initialiseRangeWriter.
protected abstract void	initialiseXrefWriter()	initialiseXrefWriter.
void	setAliasWriter(PsiXmlElementWriter<Alias> aliasWriter)	Setter for the field aliasWriter.
void	setAttributeWriter(PsiXmlElementWriter<Annotation> attributeWriter)	Setter for the field attributeWriter.
void	setFeatureTypeWriter(PsiXmlVariableNameWriter<CvTerm> featureTypeWriter)	Setter for the field featureTypeWriter.
void	setRangeWriter(PsiXmlElementWriter<Range> rangeWriter)	Setter for the field rangeWriter.
void	setXrefWriter(PsiXmlXrefWriter xrefWriter)	Setter for the field xrefWriter.
void	write(F object)	write.
protected void	writeAttribute(String name, String nameAc, String description)	writeAttribute.
protected void	writeAttributes(F object)	writeAttributes.
protected abstract void	writeFeatureRole(F object)	writeFeatureRole.
protected void	writeFeatureType(F object)	writeFeatureType.
protected void	writeNames(F object)	writeNames.
protected abstract void	writeOtherAttributes(F object, boolean writeAttributeList)	writeOtherAttributes.
protected abstract void	writeOtherProperties(F object)	writeOtherProperties.
protected abstract void	writeParameters(F object)	writeParameters.
protected void	writeRanges(F object)	writeRanges.
protected void	writeXrefFromFeatureIdentifiers(F object)	writeXrefFromFeatureIdentifiers.
protected void	writeXrefFromFeatureXrefs(F object)	writeXrefFromFeatureXrefs.
protected void	writeXrefs(F object)	writeXrefs.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlFeatureWriter

public AbstractXmlFeatureWriter(XMLStreamWriter writer,
                                PsiXmlObjectCache objectIndex)

Constructor for AbstractXmlFeatureWriter.

Parameters:

writer - a XMLStreamWriter object.

objectIndex - a PsiXmlObjectCache object.

Method Detail

getXrefWriter

public PsiXmlXrefWriter getXrefWriter()

Getter for the field xrefWriter.

Returns:

a PsiXmlXrefWriter object.

initialiseXrefWriter

protected abstract void initialiseXrefWriter()

initialiseXrefWriter.

setXrefWriter

public void setXrefWriter(PsiXmlXrefWriter xrefWriter)

Setter for the field xrefWriter.

Parameters:

xrefWriter - a PsiXmlXrefWriter object.

getFeatureTypeWriter

public PsiXmlVariableNameWriter<CvTerm> getFeatureTypeWriter()

Getter for the field featureTypeWriter.

Returns:

a PsiXmlVariableNameWriter object.

initialiseFeatureTypeWriter

protected abstract void initialiseFeatureTypeWriter()

initialiseFeatureTypeWriter.

setFeatureTypeWriter

public void setFeatureTypeWriter(PsiXmlVariableNameWriter<CvTerm> featureTypeWriter)

Setter for the field featureTypeWriter.

Parameters:

featureTypeWriter - a PsiXmlVariableNameWriter object.

getAttributeWriter

public PsiXmlElementWriter<Annotation> getAttributeWriter()

Getter for the field attributeWriter.

Returns:

a PsiXmlElementWriter object.

setAttributeWriter

public void setAttributeWriter(PsiXmlElementWriter<Annotation> attributeWriter)

Setter for the field attributeWriter.

Parameters:

attributeWriter - a PsiXmlElementWriter object.

getRangeWriter

public PsiXmlElementWriter<Range> getRangeWriter()

Getter for the field rangeWriter.

Returns:

a PsiXmlElementWriter object.

initialiseRangeWriter

protected abstract void initialiseRangeWriter()

initialiseRangeWriter.

setRangeWriter

public void setRangeWriter(PsiXmlElementWriter<Range> rangeWriter)

Setter for the field rangeWriter.

Parameters:

rangeWriter - a PsiXmlElementWriter object.

getAliasWriter

public PsiXmlElementWriter<Alias> getAliasWriter()

Getter for the field aliasWriter.

Returns:

a PsiXmlElementWriter object.

setAliasWriter

public void setAliasWriter(PsiXmlElementWriter<Alias> aliasWriter)

Setter for the field aliasWriter.

Parameters:

aliasWriter - a PsiXmlElementWriter object.

write

public void write(F object)
           throws MIIOException

write.

Specified by:

write in interface PsiXmlElementWriter<F extends Feature>

Parameters:

object - a T object.

Throws:

MIIOException - if any.

writeParameters

protected abstract void writeParameters(F object)
                                 throws XMLStreamException

writeParameters.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

writeFeatureRole

protected abstract void writeFeatureRole(F object)
                                  throws XMLStreamException

writeFeatureRole.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

writeOtherAttributes

protected abstract void writeOtherAttributes(F object,
                                             boolean writeAttributeList)
                                      throws XMLStreamException

writeOtherAttributes.

Parameters:

object - a F object.

writeAttributeList - a boolean.

Throws:

XMLStreamException - if any.

writeAttributes

protected void writeAttributes(F object)
                        throws XMLStreamException

writeAttributes.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

writeAttribute

protected void writeAttribute(String name,
                              String nameAc,
                              String description)
                       throws XMLStreamException

writeAttribute.

Parameters:

name - a String object.

nameAc - a String object.

description - a String object.

Throws:

XMLStreamException - if any.

writeRanges

protected void writeRanges(F object)
                    throws XMLStreamException

writeRanges.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

writeOtherProperties

protected abstract void writeOtherProperties(F object)
                                      throws XMLStreamException

writeOtherProperties.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

writeFeatureType

protected void writeFeatureType(F object)
                         throws XMLStreamException

writeFeatureType.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

writeXrefs

protected void writeXrefs(F object)
                   throws XMLStreamException

writeXrefs.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

writeXrefFromFeatureXrefs

protected void writeXrefFromFeatureXrefs(F object)
                                  throws XMLStreamException

writeXrefFromFeatureXrefs.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

writeXrefFromFeatureIdentifiers

protected void writeXrefFromFeatureIdentifiers(F object)
                                        throws XMLStreamException

writeXrefFromFeatureIdentifiers.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

writeNames

protected void writeNames(F object)
                   throws XMLStreamException

writeNames.

Parameters:

object - a F object.

Throws:

XMLStreamException - if any.

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.