public final class InstrumentProfile extends Object implements Comparable<InstrumentProfile>, Serializable
Constructor and Description |
---|
InstrumentProfile()
Creates an instrument profile with default values.
|
InstrumentProfile(InstrumentProfile ip)
Creates an instrument profile as a copy of the specified instrument profile.
|
Modifier and Type | Method and Description |
---|---|
boolean |
addNonEmptyCustomFieldNames(Collection<? super String> targetFieldNames)
Adds names of non-empty custom fields to specified collection.
|
int |
compareTo(InstrumentProfile ip)
Compares this profile with the specified profile for order.
|
boolean |
equals(Object o)
Indicates whether some other object is "equal to" this one.
|
String |
getAdditionalUnderlyings()
Returns additional underlyings for options, including additional cash.
|
String |
getBaseCurrency()
Returns base currency of currency pair (FOREX instruments).
|
String |
getCFI()
Returns Classification of Financial Instruments code.
|
String |
getCountry()
Returns country of origin (incorporation) of corresponding company or parent entity.
|
String |
getCurrency()
Returns currency of quotation, pricing and trading.
|
String |
getCUSIP()
Returns Committee on Uniform Security Identification Procedures code.
|
int |
getDateField(String name)
Returns day id value for a date field with a specified name.
|
String |
getDescription()
Returns description of instrument,
preferable an international one in Latin alphabet.
|
String |
getExchangeData()
Returns exchange-specific data required to properly identify instrument when communicating with exchange.
|
String |
getExchanges()
Returns list of exchanges where instrument is quoted or traded.
|
int |
getExpiration()
Returns day id of expiration.
|
String |
getExpirationStyle()
Returns expiration cycle style, such as "Weeklys", "Quarterlys".
|
String |
getField(String name)
Returns field value with a specified name.
|
int |
getICB()
Returns Industry Classification Benchmark.
|
String |
getISIN()
Returns International Securities Identifying Number.
|
int |
getLastTrade()
Returns day id of last trading day.
|
String |
getLocalDescription()
Returns description of instrument in national language.
|
String |
getLocalSymbol()
Returns identifier of instrument in national language.
|
String |
getMMY()
Returns maturity month-year as provided for corresponding FIX tag (200).
|
double |
getMultiplier()
Returns market value multiplier.
|
double |
getNumericField(String name)
Returns numeric field value with a specified name.
|
String |
getOPOL()
Returns official Place Of Listing, the organization that have listed this instrument.
|
String |
getOptionType()
Returns type of option.
|
String |
getPriceIncrements()
Returns minimum allowed price increments with corresponding price ranges.
|
String |
getProduct()
Returns product for futures and options on futures (underlying asset name).
|
String |
getSEDOL()
Returns Stock Exchange Daily Official List.
|
String |
getSettlementStyle()
Returns settlement price determination style, such as "Open", "Close".
|
int |
getSIC()
Returns Standard Industrial Classification.
|
double |
getSPC()
Returns shares per contract for options.
|
double |
getStrike()
Returns strike price for options.
|
String |
getSymbol()
Returns identifier of instrument,
preferable an international one in Latin alphabet.
|
String |
getTradingHours()
Returns trading hours specification.
|
String |
getType()
Returns type of instrument.
|
String |
getUnderlying()
Returns primary underlying symbol for options.
|
int |
hashCode()
Returns a hash code value for the object.
|
void |
setAdditionalUnderlyings(String additionalUnderlyings)
Changes additional underlyings for options, including additional cash.
|
void |
setBaseCurrency(String baseCurrency)
Changes base currency of currency pair (FOREX instruments).
|
void |
setCFI(String cfi)
Changes Classification of Financial Instruments code.
|
void |
setCountry(String country)
Changes country of origin (incorporation) of corresponding company or parent entity.
|
void |
setCurrency(String currency)
Changes currency of quotation, pricing and trading.
|
void |
setCUSIP(String cusip)
Changes Committee on Uniform Security Identification Procedures code.
|
void |
setDateField(String name,
int value)
Changes day id value for a date field with a specified name.
|
void |
setDescription(String description)
Changes description of instrument,
preferable an international one in Latin alphabet.
|
void |
setExchangeData(String exchangeData)
Changes exchange-specific data required to properly identify instrument when communicating with exchange.
|
void |
setExchanges(String exchanges)
Changes list of exchanges where instrument is quoted or traded.
|
void |
setExpiration(int expiration)
Changes day id of expiration.
|
void |
setExpirationStyle(String expirationStyle)
Returns expiration cycle style, such as "Weeklys", "Quarterlys".
|
void |
setField(String name,
String value)
Changes field value with a specified name.
|
void |
setICB(int icb)
Changes Industry Classification Benchmark.
|
void |
setISIN(String isin)
Changes International Securities Identifying Number.
|
void |
setLastTrade(int lastTrade)
Changes day id of last trading day.
|
void |
setLocalDescription(String localDescription)
Changes description of instrument in national language.
|
void |
setLocalSymbol(String localSymbol)
Changes identifier of instrument in national language.
|
void |
setMMY(String mmy)
Changes maturity month-year as provided for corresponding FIX tag (200).
|
void |
setMultiplier(double multiplier)
Changes market value multiplier.
|
void |
setNumericField(String name,
double value)
Changes numeric field value with a specified name.
|
void |
setOPOL(String opol)
Changes official Place Of Listing, the organization that have listed this instrument.
|
void |
setOptionType(String optionType)
Changes type of option.
|
void |
setPriceIncrements(String priceIncrements)
Changes minimum allowed price increments with corresponding price ranges.
|
void |
setProduct(String product)
Changes product for futures and options on futures (underlying asset name).
|
void |
setSEDOL(String sedol)
Changes Stock Exchange Daily Official List.
|
void |
setSettlementStyle(String settlementStyle)
Changes settlement price determination style, such as "Open", "Close".
|
void |
setSIC(int sic)
Changes Standard Industrial Classification.
|
void |
setSPC(double spc)
Changes shares per contract for options.
|
void |
setStrike(double strike)
Changes strike price for options.
|
void |
setSymbol(String symbol)
Changes identifier of instrument,
preferable an international one in Latin alphabet.
|
void |
setTradingHours(String tradingHours)
Changes trading hours specification.
|
void |
setType(String type)
Changes type of instrument.
|
void |
setUnderlying(String underlying)
Changes primary underlying symbol for options.
|
String |
toString()
Returns a string representation of the instrument profile.
|
public InstrumentProfile()
public InstrumentProfile(InstrumentProfile ip)
ip
- an instrument profile to copy.public String getType()
public void setType(String type)
type
- type of instrument.public String getSymbol()
public void setSymbol(String symbol)
symbol
- identifier of instrument.public String getDescription()
public void setDescription(String description)
description
- description of instrument.public String getLocalSymbol()
symbol
.public void setLocalSymbol(String localSymbol)
symbol
.localSymbol
- identifier of instrument in national language.public String getLocalDescription()
description
.public void setLocalDescription(String localDescription)
description
.localDescription
- description of instrument in national language.public String getCountry()
public void setCountry(String country)
country
- country of origin (incorporation) of corresponding company or parent entity.public String getOPOL()
public void setOPOL(String opol)
opol
- official Place Of Listing, the organization that have listed this instrument.public String getExchangeData()
public void setExchangeData(String exchangeData)
exchangeData
- exchange-specific data required to properly identify instrument when communicating with exchange.public String getExchanges()
<VALUE> ::= <empty> | <LIST> <IST> ::= <MIC> | <MIC> <semicolon><LIST> the list shall be sorted by MIC. Example: "ARCX;CBSX ;XNAS;XNYS".
public void setExchanges(String exchanges)
<VALUE> ::= <empty> | <LIST> <IST> ::= <MIC> | <MIC> <semicolon><LIST> the list shall be sorted by MIC. Example: "ARCX;CBSX ;XNAS;XNYS".
exchanges
- list of exchanges where instrument is quoted or traded.public String getCurrency()
public void setCurrency(String currency)
currency
- currency of quotation, pricing and trading.public String getBaseCurrency()
currency
.public void setBaseCurrency(String baseCurrency)
currency
.baseCurrency
- base currency of currency pair (FOREX instruments).public String getCFI()
public void setCFI(String cfi)
cfi
- CFI code.public String getISIN()
public void setISIN(String isin)
isin
- International Securities Identifying Number.public String getSEDOL()
public void setSEDOL(String sedol)
sedol
- Stock Exchange Daily Official List.public String getCUSIP()
public void setCUSIP(String cusip)
cusip
- CUSIP code.public int getICB()
public void setICB(int icb)
icb
- Industry Classification Benchmark.public int getSIC()
public void setSIC(int sic)
sic
- Standard Industrial Classification.public double getMultiplier()
public void setMultiplier(double multiplier)
multiplier
- market value multiplier.public String getProduct()
public void setProduct(String product)
product
- product for futures and options on futures (underlying asset name).public String getUnderlying()
public void setUnderlying(String underlying)
underlying
- primary underlying symbol for options.public double getSPC()
public void setSPC(double spc)
spc
- shares per contract for options.public String getAdditionalUnderlyings()
<VALUE> ::= <empty> | <LIST> <LIST> ::= <AU> | <AU> <semicolon> <space> <LIST> <AU> ::= <UNDERLYING> <space> <SPC>the list shall be sorted by <UNDERLYING>. Example: "SE 50", "FIS 53; US$ 45.46".
public void setAdditionalUnderlyings(String additionalUnderlyings)
<VALUE> ::= <empty> | <LIST> <LIST> ::= <AU> | <AU> <semicolon> <space> <LIST> <AU> ::= <UNDERLYING> <space> <SPC>the list shall be sorted by <UNDERLYING>. Example: "SE 50", "FIS 53; US$ 45.46".
additionalUnderlyings
- additional underlyings for options, including additional cash.public String getMMY()
public void setMMY(String mmy)
mmy
- maturity month-year as provided for corresponding FIX tag (200).public int getExpiration()
DayUtil.getDayIdByYearMonthDay
(20090117).public void setExpiration(int expiration)
DayUtil.getDayIdByYearMonthDay
(20090117).expiration
- day id of expiration.public int getLastTrade()
DayUtil.getDayIdByYearMonthDay
(20090116).public void setLastTrade(int lastTrade)
DayUtil.getDayIdByYearMonthDay
(20090116).lastTrade
- day id of last trading day.public double getStrike()
public void setStrike(double strike)
strike
- strike price for options.public String getOptionType()
public void setOptionType(String optionType)
optionType
- type of option.public String getExpirationStyle()
public void setExpirationStyle(String expirationStyle)
expirationStyle
- expiration cycle style.public String getSettlementStyle()
public void setSettlementStyle(String settlementStyle)
settlementStyle
- settlement price determination style.public String getPriceIncrements()
<VALUE> ::= <empty> | <LIST> <LIST> ::= <INCREMENT> | <RANGE> <semicolon> <space> <LIST> <RANGE> ::= <INCREMENT> <space> <UPPER_LIMIT>the list shall be sorted by <UPPER_LIMIT>. Example: "0.25", "0.01 3; 0.05".
public void setPriceIncrements(String priceIncrements)
<VALUE> ::= <empty> | <LIST> <LIST> ::= <INCREMENT> | <RANGE> <semicolon> <space> <LIST> <RANGE> ::= <INCREMENT> <space> <UPPER_LIMIT>the list shall be sorted by <UPPER_LIMIT>. Example: "0.25", "0.01 3; 0.05".
priceIncrements
- minimum allowed price increments with corresponding price ranges.public String getTradingHours()
Schedule.getInstance(String)
.public void setTradingHours(String tradingHours)
Schedule.getInstance(String)
.tradingHours
- trading hours specification.public String getField(String name)
name
- name of field.public void setField(String name, String value)
name
- name of field.value
- field value.public double getNumericField(String name)
name
- name of field.public void setNumericField(String name, double value)
name
- name of field.value
- field value.public int getDateField(String name)
name
- name of field.public void setDateField(String name, int value)
name
- name of field.value
- day id value.public boolean addNonEmptyCustomFieldNames(Collection<? super String> targetFieldNames)
targetFieldNames
changed as a result of the callpublic boolean equals(Object o)
public int hashCode()
public int compareTo(InstrumentProfile ip)
The natural ordering implied by this method is designed for convenient data representation in a file and shall not be used for business purposes.
compareTo
in interface Comparable<InstrumentProfile>
Copyright © 2002–2023 Devexperts LLC. All rights reserved.