org.openimaj.twitter.finance

Class YahooFinanceData

java.lang.Object

org.openimaj.twitter.finance.YahooFinanceData

All Implemented Interfaces:

Cachable, CachableASCII, ReadableASCII, ReadWriteableASCII, WriteableASCII

public class YahooFinanceData
extends Object
implements CachableASCII

A class which doesn't belong here, but I need it so here it lives!

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
YahooFinanceData()
YahooFinanceData(String product, org.joda.time.DateTime start, org.joda.time.DateTime end) Query the yahoo finance api for the product from the start date (inclusive) till the end date (inclusive)
YahooFinanceData(String product, String start, String end, String format)

Method Summary

Methods

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
boolean	equals(Object obj)
String	identifier()
Set<String>	labels()
boolean	loadedFromAPI()
void	readASCII(Scanner in) Read internal state from in.
Map<String,double[]>	results()
String	resultsString()
DoubleTimeSeries	seriesByName(String name)
Map<String,DoubleTimeSeries>	seriesMap()
Map<String,DoubleTimeSeries>	seriesMapInerp(long delta) Interpolated finance results from the beggining time till the end in perscribed delta
Map<String,DoubleTimeSeries>	seriesMapInerp(long[] times)
long[]	timeperiods()
String	toString()
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.

Methods inherited from class java.lang.Object

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

Constructor Detail

YahooFinanceData

public YahooFinanceData()

YahooFinanceData

public YahooFinanceData(String product,
                org.joda.time.DateTime start,
                org.joda.time.DateTime end)

Query the yahoo finance api for the product from the start date (inclusive) till the end date (inclusive)

Parameters:

product - a stock ticker name e.g. AAPL

start - the start date

end - the end date

YahooFinanceData

public YahooFinanceData(String product,
                String start,
                String end,
                String format)

Parameters:

product -

start -

end -

format - yoda format

Method Detail

resultsString

public String resultsString()
                     throws IOException

Returns:

obtain the underlying data

Throws:

IOException

results

public Map<String,double[]> results()
                             throws IOException

Returns:

obtain the underlying data

Throws:

IOException

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

timeperiods

public long[] timeperiods()
                   throws IOException

Returns:

the timeperiods actually retrieved

Throws:

IOException

seriesByName

public DoubleTimeSeries seriesByName(String name)
                              throws IOException

Parameters:

name -

Returns:

stocks time series by name

Throws:

IOException

seriesMap

public Map<String,DoubleTimeSeries> seriesMap()
                                       throws IOException

Returns:

stocks time series for each name

Throws:

IOException

seriesMapInerp

public Map<String,DoubleTimeSeries> seriesMapInerp(long[] times)
                                            throws IOException

Parameters:

times - times to interpolate stocks to

Returns:

stocks time series for each name interpolated to the times

Throws:

IOException

labels

public Set<String> labels()

Returns:

all available data for each date

seriesMapInerp

public Map<String,DoubleTimeSeries> seriesMapInerp(long delta)
                                            throws IOException

Interpolated finance results from the beggining time till the end in perscribed delta

Parameters:

delta -

Returns:

a map of stock components to time series

Throws:

IOException

identifier

public String identifier()

Specified by:

identifier in interface Cachable

Returns:

a unique name for the instance

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

loadedFromAPI

public boolean loadedFromAPI()

Returns:

Whether this data instance was actually loaded from the API or from a saved instance