org.encog.neural.data.market
Class TickerSymbol

java.lang.Object
  org.encog.neural.data.market.TickerSymbol

public class TickerSymbol
extends java.lang.Object

Holds a ticker symbol and exchange. The exchange is for external use only and is not used by Encog currently.

Author:

jheaton

Constructor Summary

TickerSymbol(java.lang.String symbol)
Construct a ticker symbol with no exchange.

TickerSymbol(java.lang.String symbol, java.lang.String exchange)
Construct a ticker symbol with exchange.

Method Summary

boolean	equals(TickerSymbol other) Determine if two ticker symbols equal each other.
java.lang.String	getExchange()
java.lang.String	getSymbol()
int	hashCode() Generate a valid hash code.

Methods inherited from class java.lang.Object

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

Constructor Detail

TickerSymbol

public TickerSymbol(java.lang.String symbol)

Construct a ticker symbol with no exchange.

Parameters:

symbol - The ticker symbol.

TickerSymbol

public TickerSymbol(java.lang.String symbol,
                    java.lang.String exchange)

Construct a ticker symbol with exchange.

Parameters:

symbol - The ticker symbol.

exchange - The exchange.

Method Detail

equals

public boolean equals(TickerSymbol other)

Determine if two ticker symbols equal each other.

Parameters:

other - The other ticker symbol.

Returns:

True if the two symbols equal.

getExchange

public java.lang.String getExchange()

Returns:

the exchange

getSymbol

public java.lang.String getSymbol()

Returns:

the symbol

hashCode

public int hashCode()

Generate a valid hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code.