Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes

MzIdentMLHandler Class Reference

XML handler for MzIdentMLFile. More...

#include <OpenMS/FORMAT/HANDLERS/MzIdentMLHandler.h>

Inheritance diagram for MzIdentMLHandler:
XMLHandler DefaultHandler

List of all members.

Public Member Functions

virtual void endElement (const XMLCh *const , const XMLCh *const , const XMLCh *const qname)
 Parsing method for closing tags.
virtual void startElement (const XMLCh *const , const XMLCh *const , const XMLCh *const qname, const xercesc::Attributes &attributes)
 Parsing method for opening tags.
virtual void characters (const XMLCh *const chars, const XMLSize_t length)
 Parsing method for character data.
virtual void writeTo (std::ostream &os)
 Writes the contents to a stream.
Constructors and destructor

 MzIdentMLHandler (const Identification &id, const String &filename, const String &version, const ProgressLogger &logger)
 Constructor for a write-only handler.
 MzIdentMLHandler (const std::vector< ProteinIdentification > &pro_id, const std::vector< PeptideIdentification > &pep_id, const String &filename, const String &version, const ProgressLogger &logger)
 Constructor for a write-only handler for internal identification structures.
 MzIdentMLHandler (Identification &id, const String &filename, const String &version, const ProgressLogger &logger)
 Constructor for a read-only handler.
 MzIdentMLHandler (std::vector< ProteinIdentification > &pro_id, std::vector< PeptideIdentification > &pep_id, const String &filename, const String &version, const ProgressLogger &logger)
 Constructor for a read-only handler for internal identification structures.
virtual ~MzIdentMLHandler ()
 Destructor.

Protected Member Functions

void handleCVParam_ (const String &parent_parent_tag, const String &parent_tag, const String &accession, const xercesc::Attributes &attributes, const String &cv_ref)
 Handles CV terms.
void handleUserParam_ (const String &parent_parent_tag, const String &parent_tag, const String &name, const String &type, const String &value)
 Handles user terms.
void writeUserParam_ (std::ostream &os, const MetaInfoInterface &meta, UInt indent) const
 Writes user terms.
ControlledVocabulary::CVTerm getChildWithName_ (const String &parent_accession, const String &name) const
 Looks up a child CV term of parent_accession with the name name. If no such term is found, an empty term is returned.

Protected Attributes

const ProgressLoggerlogger_
 Progress logger.
ControlledVocabulary cv_
 Controlled vocabulary (psi-ms from OpenMS/share/OpenMS/CV/psi-ms.obo).
ControlledVocabulary unimod_
 Controlled vocabulary for modifications (unimod from OpenMS/share/OpenMS/CV/unimod.obo).
String tag_
 XML tag parse element.
Identificationid_
 Identification Item.
std::vector
< ProteinIdentification > * 
pro_id_
 internal Identification Item for proteins
std::vector
< PeptideIdentification > * 
pep_id_
 Identification Item for peptides.
const Identificationcid_
const std::vector
< ProteinIdentification > * 
cpro_id_
const std::vector
< PeptideIdentification > * 
cpep_id_
SpectrumIdentification current_spectrum_id_
 SpectrumIdentification Item.
IdentificationHit current_id_hit_
 IdentificationHit Item.

Private Member Functions

 MzIdentMLHandler ()
 Helper method that writes a source file.
 MzIdentMLHandler (const MzIdentMLHandler &rhs)
MzIdentMLHandleroperator= (const MzIdentMLHandler &rhs)

Private Attributes

Map< String, AASequencepep_sequences_
AASequence actual_peptide_
Int current_mod_location_
ProteinHit actual_protein_

Detailed Description

XML handler for MzIdentMLFile.

Note:
Do not use this class. It is only needed in MzIdentMLFile.

Constructor & Destructor Documentation

MzIdentMLHandler ( const Identification id,
const String filename,
const String version,
const ProgressLogger logger 
)

Constructor for a write-only handler.

MzIdentMLHandler ( const std::vector< ProteinIdentification > &  pro_id,
const std::vector< PeptideIdentification > &  pep_id,
const String filename,
const String version,
const ProgressLogger logger 
)

Constructor for a write-only handler for internal identification structures.

MzIdentMLHandler ( Identification id,
const String filename,
const String version,
const ProgressLogger logger 
)

Constructor for a read-only handler.

MzIdentMLHandler ( std::vector< ProteinIdentification > &  pro_id,
std::vector< PeptideIdentification > &  pep_id,
const String filename,
const String version,
const ProgressLogger logger 
)

Constructor for a read-only handler for internal identification structures.

virtual ~MzIdentMLHandler (  )  [virtual]

Destructor.

MzIdentMLHandler (  )  [private]

Helper method that writes a source file.

MzIdentMLHandler ( const MzIdentMLHandler rhs  )  [private]

Member Function Documentation

virtual void characters ( const XMLCh *const   chars,
const XMLSize_t  length 
) [virtual]

Parsing method for character data.

Reimplemented from XMLHandler.

virtual void endElement ( const XMLCh *  uri,
const XMLCh *  localname,
const XMLCh *const   qname 
) [virtual]

Parsing method for closing tags.

Reimplemented from XMLHandler.

ControlledVocabulary::CVTerm getChildWithName_ ( const String parent_accession,
const String name 
) const [protected]

Looks up a child CV term of parent_accession with the name name. If no such term is found, an empty term is returned.

void handleCVParam_ ( const String parent_parent_tag,
const String parent_tag,
const String accession,
const xercesc::Attributes &  attributes,
const String cv_ref 
) [protected]

Handles CV terms.

void handleUserParam_ ( const String parent_parent_tag,
const String parent_tag,
const String name,
const String type,
const String value 
) [protected]

Handles user terms.

MzIdentMLHandler& operator= ( const MzIdentMLHandler rhs  )  [private]
virtual void startElement ( const XMLCh *  uri,
const XMLCh *  localname,
const XMLCh *const   qname,
const xercesc::Attributes &  attrs 
) [virtual]

Parsing method for opening tags.

Reimplemented from XMLHandler.

virtual void writeTo ( std::ostream &   )  [virtual]

Writes the contents to a stream.

Reimplemented from XMLHandler.

void writeUserParam_ ( std::ostream &  os,
const MetaInfoInterface meta,
UInt  indent 
) const [protected]

Writes user terms.


Member Data Documentation

const Identification* cid_ [protected]
const std::vector<PeptideIdentification>* cpep_id_ [protected]
const std::vector<ProteinIdentification>* cpro_id_ [protected]

Controlled vocabulary (psi-ms from OpenMS/share/OpenMS/CV/psi-ms.obo).

Identification* id_ [protected]
const ProgressLogger& logger_ [protected]

Progress logger.

std::vector<PeptideIdentification>* pep_id_ [protected]

Identification Item for peptides.

std::vector<ProteinIdentification>* pro_id_ [protected]

internal Identification Item for proteins

String tag_ [protected]

XML tag parse element.

Controlled vocabulary for modifications (unimod from OpenMS/share/OpenMS/CV/unimod.obo).


OpenMS / TOPP release 1.10.0 Documentation generated on Thu Mar 7 2013 09:43:00 using doxygen 1.7.1