/usr/include/mamda/MamdaNewsHeadline.h is in libmamda-dev 2.2.2.1-10.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 | /* $Id$
*
* OpenMAMA: The open middleware agnostic messaging API
* Copyright (C) 2011 NYSE Technologies, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef MamdaNewsHeadlineH
#define MamdaNewsHeadlineH
#include <mamda/MamdaOptionalConfig.h>
#include <mamda/MamdaNewsMetaData.h>
#include <mama/mamacpp.h>
namespace Wombat
{
class MamdaSubscription;
class MamdaSource;
class MamaQueue;
/**
* MamdaNewsHeadline represents a news headline and includes
* information about many types of meta-data attributes associated
* with the headline.
*
* Note on story IDs: all headlines have a story ID, even though no
* story may exist for the headline. The story ID is generated in
* order to be able to index together all revisions of a
* headline/story over time.
*/
class MAMDAOPTExpDLL MamdaNewsHeadline : public MamdaNewsMetaData
{
public:
/**
* Default constructor.
*/
MamdaNewsHeadline ();
/**
* Copy constructor.
*/
MamdaNewsHeadline (const MamdaNewsHeadline& copy);
/**
* Destructor.
*/
virtual ~MamdaNewsHeadline ();
/**
* Assignment operator.
*/
virtual MamdaNewsHeadline& operator= (const MamdaNewsHeadline& rhs);
/**
* @return The text of the headline for the story.
*/
virtual const char* getHeadlineText() const;
/**
* @return The headline ID for this headline.
*/
virtual MamdaNewsHeadlineId getHeadlineId() const;
/**
* @return The NYSE Technologies ID of the news story.
*/
virtual MamdaNewsStoryId getNewsStoryId() const;
/**
* @return The data source story ID for this news story.
*/
virtual MamdaNewsStoryId getNewsOrigStoryId() const;
/**
* @return Whether the headline has an associated story at this time.
*/
virtual bool getNewsHasStory() const;
/**
* @return The data source of the news story.
*/
virtual const char* getNewsSourceId() const;
/**
* @return The original data source of the news story (e.g., if
* the story was provided by a news aggregator).
*/
virtual const char* getNewsOrigSourceId() const;
/**
* @return The ANSI language ID of the news story.
*/
virtual const char* getLanguageId() const;
/**
* Get an array of native meta-data codes associated with this
* news story.
*/
virtual void getNativeCodes (const char**& codes,
mama_size_t& numCodes) const;
/**
* Get an array of native feed symbol codes associated with this
* news story.
*/
virtual void getNativeRelatedSymbols (const char**& symbols,
mama_size_t& numSymbols) const;
/**
* Get an array of normalized industry codes associated with this
* news story.
*/
virtual void getIndustries (const char**& industries,
mama_size_t& numIndustries) const;
/**
* Get an array of normalized market sector codes associated with this
* news story.
*/
virtual void getMarketSectors (const char**& marketSectors,
mama_size_t& numMarketSectors) const;
/**
* Get an array of normalized region codes associated with this
* news story.
*/
virtual void getRegions (const char**& regions,
mama_size_t& numRegions) const;
/**
* Get an array of ISO country codes associated with this
* news story.
*/
virtual void getCountries (const char**& countries,
mama_size_t& numCountries) const;
/**
* Get an array of normalized product codes associated with this
* news story.
*/
virtual void getProducts (const char**& products,
mama_size_t& numProducts) const;
/**
* Get an array of normalized topic (or "subject") codes
* associated with this news story.
*/
virtual void getTopics (const char**& topics,
mama_size_t& numTopics) const;
/**
* 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.
*/
virtual void getMiscCodes (const char**& miscCodes,
mama_size_t& numMiscCodes) const;
/**
* Get an array of normalized symbol codes associated
* with this news story.
*/
virtual void getRelatedSymbols (const char**& symbols,
mama_size_t& numSymbols) const;
/**
* @return Whether the feed provider has designated this story as
* with normal priority or "hot" (important) priority.
*/
virtual MamdaNewsPriority getNewsPriority() const;
/**
* @return The revision number. Note: the value returned is zero
* if the data source does not provide revision numbers.
*/
virtual mama_u16_t getNewsStoryRevNumber() const;
/**
* @return The original publish time of the news story.
*/
virtual const MamaDateTime& getNewsOrigStoryTime() const;
// Inherited from MamdaBasicEvent:
virtual const char* getSymbol () const;
virtual const char* getPartId () const;
virtual const MamaDateTime& getSrcTime () const;
virtual const MamaDateTime& getActivityTime () const;
virtual const MamaDateTime& getLineTime () const;
virtual const MamaDateTime& getSendTime () const;
virtual const MamaMsgQual& getMsgQual () const;
virtual const MamaDateTime& getEventTime () const;
virtual mama_seqnum_t getEventSeqNum () const;
MamdaFieldState getSymbolFieldState () const;
MamdaFieldState getPartIdFieldState () const;
MamdaFieldState getSrcTimeFieldState () const;
MamdaFieldState getActivityTimeFieldState () const;
MamdaFieldState getLineTimeFieldState () const;
MamdaFieldState getSendTimeFieldState () const;
MamdaFieldState getMsgQualFieldState () const;
MamdaFieldState getEventTimeFieldState () const;
MamdaFieldState getEventSeqNumFieldState () const;
void setHeadlineText (const char* headlineText);
void setHeadlineId (const char* headlineId);
void setStoryId (const char* storyId);
void setHasStory (bool hasStory);
void setSourceId (const char* source);
void setOrigStoryId (const char* storyId);
void setOrigSourceId (const char* origSourceId);
void setLanguageId (const char* langId);
void setNativeCodes (const char** codes,
mama_size_t numCodes);
void setNativeRelatedSymbols (const char** symbols,
mama_size_t numSymbols);
void setIndustries (const char** industries,
mama_size_t numIndustries);
void setMarketSectors (const char** marketSectors,
mama_size_t numMarketSectors);
void setRegions (const char** regions,
mama_size_t numRegions);
void setCountries (const char** countries,
mama_size_t numCountries);
void setProducts (const char** products,
mama_size_t numProducts);
void setTopics (const char** topics,
mama_size_t numTopics);
void setMiscCodes (const char** codes,
mama_size_t numCodes);
void setRelatedSymbols (const char** symbols,
mama_size_t numSymbols);
void setPriority (MamdaNewsPriority priority);
void setStoryRevNumber (mama_u16_t storyRevNum);
void setEventSeqNum (mama_seqnum_t seqNum);
void setEventTime (const MamaDateTime& eventTime);
void setOrigStoryTime (const MamaDateTime& storyTime);
void setSrcTime (const MamaDateTime& srcTime);
void setActivityTime (const MamaDateTime& actTime);
void setLineTime (const MamaDateTime& lineTime);
void setSendTime (const MamaDateTime& sendTime);
void setMsgQual (const MamaMsgQual& msgQualifier);
void clear ();
public:
/**
* Implementation: save the subscription info for the
* headline (so we know where to request stories from).
*/
void setSubscriptionInfo (MamdaSubscription* subsc);
void setSubscInfo (MamaQueue* queue,
MamaSource* source);
/**
* Implementation: get the subscription info for the
* headline.
*/
MamaQueue* getQueue () const;
MamaSource* getSource () const;
private:
struct MamdaNewsHeadlineImpl;
MamdaNewsHeadlineImpl& mImpl;
};
} // namespace
#endif // MamdaNewsHeadlineH
|