OpenMAMA
Wombat::MamdaNewsMetaData Class Referenceabstract

MamdaNewsMetaData represents information about many types of attributes associated with the news headline. More...

#include <MamdaNewsMetaData.h>

Inheritance diagram for Wombat::MamdaNewsMetaData:
Wombat::MamdaBasicEvent Wombat::MamdaNewsHeadline

Public Member Functions

virtual const char * getHeadlineText () const =0
 
virtual const char * getNewsSourceId () const =0
 
virtual const char * getNewsOrigSourceId () const =0
 
virtual const char * getLanguageId () const =0
 
virtual void getNativeCodes (const char **&codes, mama_size_t &numCodes) const =0
 Get an array of native meta-data codes associated with this news story. More...
 
virtual void getNativeRelatedSymbols (const char **&symbols, mama_size_t &numSymbols) const =0
 Get an array of native feed symbol codes associated with this news story. More...
 
virtual void getIndustries (const char **&industries, mama_size_t &numIndustries) const =0
 Get an array of normalized industry codes associated with this news story. More...
 
virtual void getMarketSectors (const char **&marketSectors, mama_size_t &numMarketSectors) const =0
 Get an array of normalized market sector codes associated with this news story. More...
 
virtual void getRegions (const char **&regions, mama_size_t &numRegions) const =0
 Get an array of normalized region codes associated with this news story. More...
 
virtual void getCountries (const char **&countries, mama_size_t &numCountries) const =0
 Get an array of ISO country codes associated with this news story. More...
 
virtual void getTopics (const char **&topics, mama_size_t &numTopics) const =0
 Get an array of normalized topic (or "subject") codes associated with this news story. More...
 
virtual void getProducts (const char **&products, mama_size_t &numProducts) const =0
 Get an array of normalized product codes associated with this news story. More...
 
virtual void getMiscCodes (const char **&miscCodes, mama_size_t &numMiscCodes) const =0
 Get an array of normalized miscellaneous codes associated with this news story. More...
 
virtual void getRelatedSymbols (const char **&symbols, mama_size_t &numSymbols) const =0
 Get an array of normalized symbol codes associated with this news story. More...
 
virtual MamdaNewsPriority getNewsPriority () const =0
 
virtual mama_u16_t getNewsStoryRevNumber () const =0
 
virtual const MamaDateTime & getNewsOrigStoryTime () const =0
 
virtual ~MamdaNewsMetaData ()
 
- Public Member Functions inherited from Wombat::MamdaBasicEvent
virtual const char * getSymbol () const =0
 Get the instruments string symbol. More...
 
virtual MamdaFieldState getSymbolFieldState () const =0
 Get the string symbol field state. More...
 
virtual const char * getPartId () const =0
 Get the participant identifier. More...
 
virtual MamdaFieldState getPartIdFieldState () const =0
 Get the participant identifier field state. More...
 
virtual mama_seqnum_t getEventSeqNum () const =0
 Get the event sequence number. More...
 
virtual MamdaFieldState getEventSeqNumFieldState () const =0
 Get the event sequence number field state. More...
 
virtual const MamaDateTime & getEventTime () const =0
 Get the event time. More...
 
virtual MamdaFieldState getEventTimeFieldState () const =0
 Get the event time field state. More...
 
virtual const MamaDateTime & getSrcTime () const =0
 Get the source time. More...
 
virtual MamdaFieldState getSrcTimeFieldState () const =0
 Get the source time field state. More...
 
virtual const MamaDateTime & getActivityTime () const =0
 Get the activity time. More...
 
virtual MamdaFieldState getActivityTimeFieldState () const =0
 Get the activity time field state. More...
 
virtual const MamaDateTime & getLineTime () const =0
 Get the line time. More...
 
virtual MamdaFieldState getLineTimeFieldState () const =0
 Get the line time of the update. More...
 
virtual const MamaDateTime & getSendTime () const =0
 Get the send time. More...
 
virtual MamdaFieldState getSendTimeFieldState () const =0
 Get the send time field state. More...
 
virtual const MamaMsgQual & getMsgQual () const =0
 Get the message qualifier. More...
 
virtual MamdaFieldState getMsgQualFieldState () const =0
 Get the message qualifier field state. More...
 
virtual ~MamdaBasicEvent ()
 Destructor. More...
 

Detailed Description

MamdaNewsMetaData represents information about many types of attributes associated with the news headline.

Note that some information is inherited from the MamdaBasicEvent, including the source time (the time the data source sent the headline) and the event time (the time the article was actually published). Depending upon the richness of information provided by a particular data source, the source time and event time may be the same.

Constructor & Destructor Documentation

◆ ~MamdaNewsMetaData()

virtual Wombat::MamdaNewsMetaData::~MamdaNewsMetaData ( )
virtual
159 {};

Member Function Documentation

◆ getHeadlineText()

virtual const char* Wombat::MamdaNewsMetaData::getHeadlineText ( ) const
pure virtual
Returns
The text of the headline for the story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getNewsSourceId()

virtual const char* Wombat::MamdaNewsMetaData::getNewsSourceId ( ) const
pure virtual
Returns
The data source ID of the news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getNewsOrigSourceId()

virtual const char* Wombat::MamdaNewsMetaData::getNewsOrigSourceId ( ) const
pure virtual
Returns
The original data source ID of the news story (e.g., if the story was provided by a news aggregator).

Implemented in Wombat::MamdaNewsHeadline.

◆ getLanguageId()

virtual const char* Wombat::MamdaNewsMetaData::getLanguageId ( ) const
pure virtual
Returns
The ANSI language ID of the news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getNativeCodes()

virtual void Wombat::MamdaNewsMetaData::getNativeCodes ( const char **&  codes,
mama_size_t &  numCodes 
) const
pure virtual

Get an array of native meta-data codes associated with this news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getNativeRelatedSymbols()

virtual void Wombat::MamdaNewsMetaData::getNativeRelatedSymbols ( const char **&  symbols,
mama_size_t &  numSymbols 
) const
pure virtual

Get an array of native feed symbol codes associated with this news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getIndustries()

virtual void Wombat::MamdaNewsMetaData::getIndustries ( const char **&  industries,
mama_size_t &  numIndustries 
) const
pure virtual

Get an array of normalized industry codes associated with this news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getMarketSectors()

virtual void Wombat::MamdaNewsMetaData::getMarketSectors ( const char **&  marketSectors,
mama_size_t &  numMarketSectors 
) const
pure virtual

Get an array of normalized market sector codes associated with this news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getRegions()

virtual void Wombat::MamdaNewsMetaData::getRegions ( const char **&  regions,
mama_size_t &  numRegions 
) const
pure virtual

Get an array of normalized region codes associated with this news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getCountries()

virtual void Wombat::MamdaNewsMetaData::getCountries ( const char **&  countries,
mama_size_t &  numCountries 
) const
pure virtual

Get an array of ISO country codes associated with this news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getTopics()

virtual void Wombat::MamdaNewsMetaData::getTopics ( const char **&  topics,
mama_size_t &  numTopics 
) const
pure virtual

Get an array of normalized topic (or "subject") codes associated with this news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getProducts()

virtual void Wombat::MamdaNewsMetaData::getProducts ( const char **&  products,
mama_size_t &  numProducts 
) const
pure virtual

Get an array of normalized product codes associated with this news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getMiscCodes()

virtual void Wombat::MamdaNewsMetaData::getMiscCodes ( const char **&  miscCodes,
mama_size_t &  numMiscCodes 
) const
pure virtual

Get an array of normalized miscellaneous codes associated with this news story.

Miscellaneous codes are those not categorized as industry, market sector, region, country or product codes.

Implemented in Wombat::MamdaNewsHeadline.

◆ getRelatedSymbols()

virtual void Wombat::MamdaNewsMetaData::getRelatedSymbols ( const char **&  symbols,
mama_size_t &  numSymbols 
) const
pure virtual

Get an array of normalized symbol codes associated with this news story.

Implemented in Wombat::MamdaNewsHeadline.

◆ getNewsPriority()

virtual MamdaNewsPriority Wombat::MamdaNewsMetaData::getNewsPriority ( ) const
pure virtual
Returns
Whether the feed provider has designated this story as with normal priority or "hot" (important) priority.

Implemented in Wombat::MamdaNewsHeadline.

◆ getNewsStoryRevNumber()

virtual mama_u16_t Wombat::MamdaNewsMetaData::getNewsStoryRevNumber ( ) const
pure virtual
Returns
The revision number. Note: the value returned is zero if the data source does not provide revision numbers.

Implemented in Wombat::MamdaNewsHeadline.

◆ getNewsOrigStoryTime()

virtual const MamaDateTime& Wombat::MamdaNewsMetaData::getNewsOrigStoryTime ( ) const
pure virtual
Returns
The original publish time of the news story.

Implemented in Wombat::MamdaNewsHeadline.


The documentation for this class was generated from the following file:


© 2012 Linux Foundation