org.otfeed.command
Class ListSymbolsCommand

java.lang.Object
  org.otfeed.command.ListSymbolsCommand

All Implemented Interfaces:

ICommand

public final class ListSymbolsCommand
extends java.lang.Object
implements ICommand

Retrieves list of symbols traded on an exchange.

Allows to get a full list, or search symbols by prefix or substring.

Generates symbol events.

Nested Class Summary

static class

ListSymbolsCommand.MatchStyleEnum Type of string matching: prefix or contains.

Constructor Summary

ListSymbolsCommand()
Default constructor.

ListSymbolsCommand(java.lang.String exchangeCode, IDataDelegate<OTSymbol> dataDelegate)
Creates new list symbols command for all symbol types, with wildcard value for the symbolCodePattern property.

ListSymbolsCommand(java.lang.String exchangeCode, ListSymbolEnum type, IDataDelegate<OTSymbol> dataDelegate)
Creates new list symbols command for a single symbol type, with wildcard value for the symbolCodePattern property.

ListSymbolsCommand(java.lang.String exchangeCode, ListSymbolEnum type, ListSymbolsCommand.MatchStyleEnum matchStyle, IDataDelegate<OTSymbol> dataDelegate)
Creates new list symbols command for a single symbol type, with wildcard value for the symbolCodePattern property.

ListSymbolsCommand(java.lang.String exchangeCode, java.lang.String symbolCodePattern, IDataDelegate<OTSymbol> dataDelegate)
Creates new list symbols command for all symbol types.

ListSymbolsCommand(java.lang.String exchangeCode, java.lang.String symbolCodePattern, ListSymbolEnum type, IDataDelegate<OTSymbol> dataDelegate)
Creates new list symbols command for a single symbol type.

ListSymbolsCommand(java.lang.String exchangeCode, java.lang.String symbolCodePattern, ListSymbolEnum type, ListSymbolsCommand.MatchStyleEnum matchStyle, IDataDelegate<OTSymbol> dataDelegate)
Creates new list symbols command for a single symbol type.

ListSymbolsCommand(java.lang.String exchangeCode, java.lang.String symbolCodePattern, ListSymbolsCommand.MatchStyleEnum matchStyle, IDataDelegate<OTSymbol> dataDelegate)
Creates new list symbols command for all symbol types.

ListSymbolsCommand(java.lang.String exchangeCode, java.lang.String symbolCodePattern, java.util.Set<ListSymbolEnum> types, IDataDelegate<OTSymbol> dataDelegate)
Creates new list symbols command for a given set of symbol types, exchangeCode, and symbolCodePattern.

ListSymbolsCommand(java.lang.String exchangeCode, java.lang.String symbolCodePattern, java.util.Set<ListSymbolEnum> types, ListSymbolsCommand.MatchStyleEnum matchStyle, IDataDelegate<OTSymbol> dataDelegate)
Creates new list symbols command, initializing all its properties.

Method Summary

ICompletionDelegate	getCompletionDelegate() Option delegate to watch stream completion event.
IDataDelegate<OTSymbol>	getDataDelegate() Delegate to receive OTSymbol events.
java.lang.String	getExchangeCode() Exchange code.
ListSymbolsCommand.MatchStyleEnum	getMatchStyle() Determines how symbolCodePattern is treated.
java.lang.String	getSymbolCodePattern() Symbol code.
java.util.Set<ListSymbolEnum>	getTypes() Types of symbols to request.
void	setCompletionDelegate(ICompletionDelegate val) Sets completion delegate.
void	setDataDelegate(IDataDelegate<OTSymbol> dataDelegate) Sets delegate.
void	setExchangeCode(java.lang.String exchangeCode) Sets the exchange code.
void	setMatchStyle(ListSymbolsCommand.MatchStyleEnum val) Sets match style.
void	setSymbolCodePattern(java.lang.String val) Sets symbol code.
void	setTypes(java.util.Set<ListSymbolEnum> val) Sets types of symbols.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListSymbolsCommand

public ListSymbolsCommand(java.lang.String exchangeCode,
                          java.lang.String symbolCodePattern,
                          java.util.Set<ListSymbolEnum> types,
                          ListSymbolsCommand.MatchStyleEnum matchStyle,
                          IDataDelegate<OTSymbol> dataDelegate)

Creates new list symbols command, initializing all its properties.

Parameters:

exchangeCode - exchange code.

symbolCodePattern - symbol pattern.

types - set of types.

matchStyle - matching style (e.g. PREFIX or CONTAINS).

dataDelegate - delegate.

ListSymbolsCommand

public ListSymbolsCommand()

Default constructor. Initializes types property to the default value of ALL. Initializes symbolCodePattern property to the default value of blank (which means "any symbol code"). You must set other properties explicitly before using this command object.

ListSymbolsCommand

public ListSymbolsCommand(java.lang.String exchangeCode,
                          java.lang.String symbolCodePattern,
                          ListSymbolEnum type,
                          ListSymbolsCommand.MatchStyleEnum matchStyle,
                          IDataDelegate<OTSymbol> dataDelegate)

Creates new list symbols command for a single symbol type.

Parameters:

exchangeCode - exchange code.

symbolCodePattern - symbol pattern.

type - instrument type.

matchStyle - matching style (e.g. PREFIX or CONTAINS).

dataDelegate - data delegate.

ListSymbolsCommand

public ListSymbolsCommand(java.lang.String exchangeCode,
                          ListSymbolEnum type,
                          ListSymbolsCommand.MatchStyleEnum matchStyle,
                          IDataDelegate<OTSymbol> dataDelegate)

Creates new list symbols command for a single symbol type, with wildcard value for the symbolCodePattern property.

Parameters:

exchangeCode - exchange code.

type - instrument type.

matchStyle - matching style (e.g. PREFIX, or CONTAINS).

dataDelegate - delegate.

ListSymbolsCommand

public ListSymbolsCommand(java.lang.String exchangeCode,
                          java.lang.String symbolCodePattern,
                          ListSymbolsCommand.MatchStyleEnum matchStyle,
                          IDataDelegate<OTSymbol> dataDelegate)

Creates new list symbols command for all symbol types.

Parameters:

exchangeCode - exchange code.

symbolCodePattern - symbol pattern.

matchStyle - matching style (e.g. PREFIX or CONTAINS).

dataDelegate - delegate.

ListSymbolsCommand

public ListSymbolsCommand(java.lang.String exchangeCode,
                          java.lang.String symbolCodePattern,
                          java.util.Set<ListSymbolEnum> types,
                          IDataDelegate<OTSymbol> dataDelegate)

Creates new list symbols command for a given set of symbol types, exchangeCode, and symbolCodePattern. Match type is "prefix".

Parameters:

exchangeCode - exchange code.

symbolCodePattern - symbol pattern.

types - set of types.

dataDelegate - delegate.

ListSymbolsCommand

public ListSymbolsCommand(java.lang.String exchangeCode,
                          java.lang.String symbolCodePattern,
                          ListSymbolEnum type,
                          IDataDelegate<OTSymbol> dataDelegate)

Creates new list symbols command for a single symbol type. Match type is "prefix".

Parameters:

exchangeCode - exchange code.

symbolCodePattern - symbol pattern.

type - instrument type.

dataDelegate - delegate.

ListSymbolsCommand

public ListSymbolsCommand(java.lang.String exchangeCode,
                          ListSymbolEnum type,
                          IDataDelegate<OTSymbol> dataDelegate)

Creates new list symbols command for a single symbol type, with wildcard value for the symbolCodePattern property.

Parameters:

exchangeCode - exchange code.

type - instrument type.

dataDelegate - data delegate.

ListSymbolsCommand

public ListSymbolsCommand(java.lang.String exchangeCode,
                          java.lang.String symbolCodePattern,
                          IDataDelegate<OTSymbol> dataDelegate)

Creates new list symbols command for all symbol types. Match type is "prefix".

Parameters:

exchangeCode - exchange code.

symbolCodePattern - cymbol code.

dataDelegate - data delegate.

ListSymbolsCommand

public ListSymbolsCommand(java.lang.String exchangeCode,
                          IDataDelegate<OTSymbol> dataDelegate)

Creates new list symbols command for all symbol types, with wildcard value for the symbolCodePattern property. Match type is "prefix".

Parameters:

exchangeCode - exchange code.

dataDelegate - data delegate.

Method Detail

getExchangeCode

public java.lang.String getExchangeCode()

Exchange code.

Returns:

exchange code.

setExchangeCode

public void setExchangeCode(java.lang.String exchangeCode)

Sets the exchange code.

Parameters:

exchangeCode - exchange code.

getSymbolCodePattern

public java.lang.String getSymbolCodePattern()

Symbol code. Optional parameter. If not specified, defaults to an empty string, which will act as a wildcard (all symbols will be returned). It acts as a match prefix when searching for symbols. For example, symbolCodePattern value of "GO" may return "GOOG", "GOK", and "GOAT".

Returns:

symbol code.

setSymbolCodePattern

public void setSymbolCodePattern(java.lang.String val)

Sets symbol code.

Parameters:

val - symbol code.

getTypes

public java.util.Set<ListSymbolEnum> getTypes()

Types of symbols to request. Optional property, defaults to ListSymbolEnum.ALL

Returns:

set of types.

setTypes

public void setTypes(java.util.Set<ListSymbolEnum> val)

Sets types of symbols.

Parameters:

val - set of symbol types.

getMatchStyle

public ListSymbolsCommand.MatchStyleEnum getMatchStyle()

Determines how symbolCodePattern is treated. By default, matchStyle is PREFIX that means that symbolCodePattern is matched as a prefix: all symbols that start with this string will be returned. If matchStyle is set to CONTAINS, all symbols that contain this string will be returned.

Returns:

true, if containsMatch is set, false otherwise.

setMatchStyle

public void setMatchStyle(ListSymbolsCommand.MatchStyleEnum val)

Sets match style.

Parameters:

val - matchStyle value.

getDataDelegate

public IDataDelegate<OTSymbol> getDataDelegate()

Delegate to receive OTSymbol events.

Returns:

delegate.

setDataDelegate

public void setDataDelegate(IDataDelegate<OTSymbol> dataDelegate)

Sets delegate.

Parameters:

dataDelegate - delegate.

getCompletionDelegate

public ICompletionDelegate getCompletionDelegate()

Option delegate to watch stream completion event.

Returns:

delegate.

setCompletionDelegate

public void setCompletionDelegate(ICompletionDelegate val)

Sets completion delegate.

Parameters:

val - delegate.