com.dukascopy.api
Interface IFXSentimentIndexBar

All Superinterfaces:
IFXTimedSentimentIndex

public interface IFXSentimentIndexBar
extends IFXTimedSentimentIndex

Forex Sentiment Index.
Aggregation over Forex Sentiment Indices' long values which shows the percentage of longs in the overall amount of open trades in the most popular currencies and currency pairs consolidated by liquidity consumers.
The index reflects the distribution of the current market conditions and is updated every 30 minutes.

See Also:
SWFX Sentiment Index

Method Summary
 double getClose()
          Returns closing price of the bar
 double getHigh()
          Returns the highest price of the bar
 long getIndexTime()
          The time of the oldest index in the aggregation.
 double getLow()
          Returns the lowest price of the bar
 double getOpen()
          Returns opening price of the bar
 long getTime()
          Returns the start time of the sentiment index aggregation bar.
 

Method Detail

getIndexTime

long getIndexTime()
The time of the oldest index in the aggregation. If there are no indices in the database over the given timespan then the value is less than getTime()

Specified by:
getIndexTime in interface IFXTimedSentimentIndex
Returns:
Returns a settlement time of current index.

getTime

long getTime()
Returns the start time of the sentiment index aggregation bar. If the bar is aggregation over 0 indices (i.e. there were no indices over the bar's timespan in the database), then it is larger than getIndexTime()

Returns:
the start time of the sentiment index aggregation bar.

getOpen

double getOpen()
Returns opening price of the bar

Returns:
opening price

getClose

double getClose()
Returns closing price of the bar

Returns:
closing price

getLow

double getLow()
Returns the lowest price of the bar

Returns:
the lowest price

getHigh

double getHigh()
Returns the highest price of the bar

Returns:
the highest price