com.devexperts.mdd.news.event

Class NewsEvent

java.lang.Object

com.devexperts.mdd.news.event.NewsEvent

All Implemented Interfaces:

Serializable, Comparable<NewsEvent>

public class NewsEvent
extends Object
implements Serializable, Comparable<NewsEvent>

Contains news details including time, title, news source, etc.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NewsEvent.Builder Builder class for NewsEvent.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_SYMBOL Symbol used for QD Stream Subscription.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NewsEvent(NewsEvent.Builder builder)

Method Summary

Modifier and Type	Method and Description
int	compareTo(NewsEvent o) Events are naturally ordered by their arrival time to the news storage.
boolean	equals(Object o)
String	getAction() Returns news action, or null.
String	getActionReason() Returns news action reason, or null.
String	getBody() Returns news body, or null.
NewsKey	getChainKey()
String	getExtraAttributes() Returns news extra attributes, or null.
String	getFeed() Returns news feed ID.
NewsKey	getKey() Returns news key for identifying news.
String	getNewsContent()
NewsOrigin	getOrigin() Return news origin (feed and source provider)
NewsKey	getOriginalKey()
NewsKey	getOriginalKeyOrSelf() Returns original news key if event is correction or else news id (originalKey for non-corrected news is null) .
String	getSource() Returns news source provider.
String	getSourceId() Returns external ID assigned by news provider.
String	getSourcePrefix()
String	getSourceUrl() Returns news source url.
List<String>	getSymbols() Returns set of instrument symbols for this news, or null if not present.
Map<String,List<String>>	getTags() Returns set of custom tags available for the news.
long	getTime() Returns news time.
String	getTitle() Returns news title.
int	hashCode()
static NewsEvent.Builder	newBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MESSAGE_SYMBOL

public static final String MESSAGE_SYMBOL

Symbol used for QD Stream Subscription.

See Also:

Constant Field Values

Constructor Detail

NewsEvent

protected NewsEvent(NewsEvent.Builder builder)

Method Detail

newBuilder

public static NewsEvent.Builder newBuilder()

getKey

public NewsKey getKey()

Returns news key for identifying news.

getOriginalKey

public NewsKey getOriginalKey()

getChainKey

public NewsKey getChainKey()

getOriginalKeyOrSelf

public NewsKey getOriginalKeyOrSelf()

Returns original news key if event is correction or else news id (originalKey for non-corrected news is null) .

getFeed

public String getFeed()

Returns news feed ID.

getSourceId

public String getSourceId()

Returns external ID assigned by news provider.

getSource

public String getSource()

Returns news source provider.

getSourceUrl

public String getSourceUrl()

Returns news source url.

getSourcePrefix

public String getSourcePrefix()

getOrigin

public NewsOrigin getOrigin()

Return news origin (feed and source provider)

getTime

public long getTime()

Returns news time.

getTitle

public String getTitle()

Returns news title.

getBody

public String getBody()

Returns news body, or null.

getExtraAttributes

public String getExtraAttributes()

Returns news extra attributes, or null.

getAction

public String getAction()

Returns news action, or null.

getActionReason

public String getActionReason()

Returns news action reason, or null.

getNewsContent

public String getNewsContent()

getSymbols

public List<String> getSymbols()

Returns set of instrument symbols for this news, or null if not present.

getTags

public Map<String,List<String>> getTags()

Returns set of custom tags available for the news. This set is never null but can be empty.

compareTo

public int compareTo(NewsEvent o)

Events are naturally ordered by their arrival time to the news storage.

Specified by:

compareTo in interface Comparable<NewsEvent>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object