com.dxfeed.event.market

Class MarketEvent

java.lang.Object

com.dxfeed.event.market.MarketEvent

All Implemented Interfaces:

EventType<String>, Serializable

Direct Known Subclasses:

Greeks, OptionSale, OrderBase, Profile, Quote, Series, Summary, TheoPrice, TimeAndSale, TradeBase, Underlying

public abstract class MarketEvent
extends Object
implements EventType<String>

Abstract base class for all market events. All market events are plain java objects that extend this class. Market event classes are simple beans with setter and getter methods for their properties and minimal business logic. All market events have eventSymbol property that is defined by this class.

Event symbol for a market event is a market symbol String. See MarketEventSymbols class for a description of market event symbology.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MarketEvent() Protected constructor for concrete implementation classes.
protected	MarketEvent(String eventSymbol) Protected constructor for concrete implementation classes that initializes eventSymbol property.

Method Summary

Modifier and Type	Method and Description
String	getEventSymbol() Returns symbol of this event.
long	getEventTime() Returns time when event was created or zero when time is not available.
void	setEventSymbol(String eventSymbol) Changes symbol of this event.
void	setEventTime(long eventTime) Changes event creation time.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarketEvent

protected MarketEvent()

Protected constructor for concrete implementation classes.

MarketEvent

protected MarketEvent(String eventSymbol)

Protected constructor for concrete implementation classes that initializes eventSymbol property.

Parameters:

eventSymbol - the event symbol.

Method Detail

getEventSymbol

public String getEventSymbol()

Returns symbol of this event.

Specified by:

getEventSymbol in interface EventType<String>

Returns:

symbol of this event.

setEventSymbol

public void setEventSymbol(String eventSymbol)

Changes symbol of this event.

Specified by:

setEventSymbol in interface EventType<String>

Parameters:

eventSymbol - symbol of this event.

getEventTime

public long getEventTime()

Returns time when event was created or zero when time is not available.

This event time is available only when the corresponding DXEndpoint is created with DXENDPOINT_EVENT_TIME_PROPERTY and the data source has embedded event times. This is typically true only for data events that are read from historical tape files and from OnDemandService. Events that are coming from a network connections do not have an embedded event time information and this method will return zero for them, meaning that event was received just now.

Specified by:

getEventTime in interface EventType<String>

Returns:

the difference, measured in milliseconds, between the event creation time and midnight, January 1, 1970 UTC or zero when time is not available.

setEventTime

public void setEventTime(long eventTime)

Changes event creation time.

Specified by:

setEventTime in interface EventType<String>

Parameters:

eventTime - the difference, measured in milliseconds, between the event creation time and midnight, January 1, 1970 UTC.