com.dxfeed.event.market
Class Summary

java.lang.Object
  extended by com.dxfeed.event.market.MarketEvent
      extended by com.dxfeed.event.market.Summary
All Implemented Interfaces:
LastingEvent, Serializable

public final class Summary
extends MarketEvent
implements LastingEvent

Summary information snapshot about the trading session including session highs, lows, etc. It represents the most recent information that is available about the trading session in the market at any given moment of time.

Implementation details

This event is implemented on top of QDS records Summary and Summary&X for regional exchange trading session summaries.

See Also:
Serialized Form

Constructor Summary
Summary()
          Creates new summary with default values.
Summary(String eventSymbol)
          Creates new summary with the specified event symbol.
 
Method Summary
 double getDayClosePrice()
          Returns the last (close) price for the day.
 PriceType getDayClosePriceType()
          Returns the price type of the last (close) price for the day.
 double getDayHighPrice()
          Returns the maximal (high) price for the day.
 int getDayId()
          Returns identifier of the day that this summary represents.
 double getDayLowPrice()
          Returns the minimal (low) price for the day.
 double getDayOpenPrice()
          Returns the first (open) price for the day.
 int getFlags()
          Returns implementation-specific flags.
 long getOpenInterest()
          Returns open interest of the symbol as the number of open contracts.
 double getPrevDayClosePrice()
          Returns the last (close) price for the previous day.
 PriceType getPrevDayClosePriceType()
          Returns the price type of the last (close) price for the previous day.
 int getPrevDayId()
          Returns identifier of the previous day that this summary represents.
 void setDayClosePrice(double dayClosePrice)
          Changes the last (close) price for the day.
 void setDayClosePriceType(PriceType type)
          Changes the price type of the last (close) price for the day.
 void setDayHighPrice(double dayHighPrice)
          Changes the maximal (high) price for the day.
 void setDayId(int dayId)
          Changes identifier of the day that this summary represents.
 void setDayLowPrice(double dayLowPrice)
          Changes the minimal (low) price for the day.
 void setDayOpenPrice(double dayOpenPrice)
          Changes the first (open) price for the day.
 void setFlags(int flags)
          Changes implementation-specific flags.
 void setOpenInterest(long openInterest)
          Changes open interest of the symbol as the number of open contracts.
 void setPrevDayClosePrice(double prevDayClosePrice)
          Changes the last (close) price for the previous day.
 void setPrevDayClosePriceType(PriceType type)
          Changes the price type of the last (close) price for the previous day.
 void setPrevDayId(int prevDayId)
          Changes identifier of the previous day that this summary represents.
 String toString()
          Returns string representation of this summary event.
 
Methods inherited from class com.dxfeed.event.market.MarketEvent
getEventSymbol, setEventSymbol
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Summary

public Summary()
Creates new summary with default values.


Summary

public Summary(String eventSymbol)
Creates new summary with the specified event symbol.

Parameters:
eventSymbol - event symbol.
Method Detail

getDayId

public int getDayId()
Returns identifier of the day that this summary represents. Identifier of the day is the number of days passed since January 1, 1970.

Returns:
identifier of the day that this summary represents.

setDayId

public void setDayId(int dayId)
Changes identifier of the day that this summary represents. Identifier of the day is the number of days passed since January 1, 1970.

Parameters:
dayId - identifier of the day that this summary represents.

getDayOpenPrice

public double getDayOpenPrice()
Returns the first (open) price for the day.

Returns:
the first (open) price for the day.

setDayOpenPrice

public void setDayOpenPrice(double dayOpenPrice)
Changes the first (open) price for the day.

Parameters:
dayOpenPrice - the first (open) price for the day.

getDayHighPrice

public double getDayHighPrice()
Returns the maximal (high) price for the day.

Returns:
the maximal (high) price for the day.

setDayHighPrice

public void setDayHighPrice(double dayHighPrice)
Changes the maximal (high) price for the day.

Parameters:
dayHighPrice - the maximal (high) price for the day.

getDayLowPrice

public double getDayLowPrice()
Returns the minimal (low) price for the day.

Returns:
the minimal (low) price for the day.

setDayLowPrice

public void setDayLowPrice(double dayLowPrice)
Changes the minimal (low) price for the day.

Parameters:
dayLowPrice - the minimal (low) price for the day.

getDayClosePrice

public double getDayClosePrice()
Returns the last (close) price for the day.

Returns:
the last (close) price for the day.

setDayClosePrice

public void setDayClosePrice(double dayClosePrice)
Changes the last (close) price for the day.

Parameters:
dayClosePrice - the last (close) price for the day.

getDayClosePriceType

public PriceType getDayClosePriceType()
Returns the price type of the last (close) price for the day.

Returns:
the price type of the last (close) price for the day.

setDayClosePriceType

public void setDayClosePriceType(PriceType type)
Changes the price type of the last (close) price for the day.

Parameters:
type - the price type of the last (close) price for the day.

getPrevDayId

public int getPrevDayId()
Returns identifier of the previous day that this summary represents. Identifier of the day is the number of days passed since January 1, 1970.

Returns:
identifier of the previous day that this summary represents.

setPrevDayId

public void setPrevDayId(int prevDayId)
Changes identifier of the previous day that this summary represents. Identifier of the day is the number of days passed since January 1, 1970.

Parameters:
prevDayId - identifier of the previous day that this summary represents.

getPrevDayClosePrice

public double getPrevDayClosePrice()
Returns the last (close) price for the previous day.

Returns:
the last (close) price for the previous day.

setPrevDayClosePrice

public void setPrevDayClosePrice(double prevDayClosePrice)
Changes the last (close) price for the previous day.

Parameters:
prevDayClosePrice - the last (close) price for the previous day.

getPrevDayClosePriceType

public PriceType getPrevDayClosePriceType()
Returns the price type of the last (close) price for the previous day.

Returns:
the price type of the last (close) price for the previous day.

setPrevDayClosePriceType

public void setPrevDayClosePriceType(PriceType type)
Changes the price type of the last (close) price for the previous day.

Parameters:
type - the price type of the last (close) price for the previous day.

getOpenInterest

public long getOpenInterest()
Returns open interest of the symbol as the number of open contracts.

Returns:
open interest of the symbol as the number of open contracts.

setOpenInterest

public void setOpenInterest(long openInterest)
Changes open interest of the symbol as the number of open contracts.

Parameters:
openInterest - open interest of the symbol as the number of open contracts.

getFlags

public int getFlags()
Returns implementation-specific flags. Do not use this method directly. It may be removed or changed in the future versions.

Returns:
flags.

setFlags

public void setFlags(int flags)
Changes implementation-specific flags. Do not use this method directly. It may be removed or changed in the future versions.

Parameters:
flags - flags.

toString

public String toString()
Returns string representation of this summary event.

Overrides:
toString in class Object
Returns:
string representation of this summary event.


Copyright © 2013 Devexperts. All Rights Reserved.