ch.algotrader.entity.security

Class SecurityFamilyVO

java.lang.Object

ch.algotrader.entity.property.PropertyHolderVO

ch.algotrader.entity.security.SecurityFamilyVO

All Implemented Interfaces:

BaseValueObjectI, PropertyHolderI, SecurityFamilyI, java.io.Serializable

public class SecurityFamilyVO
extends PropertyHolderVO
implements SecurityFamilyI

Represents an entire family of similar Securities (e.g. All Options of the SP500)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecurityFamilyVO.VOConverter Converts instances of value object type SecurityFamilyVO to corresponding entity type SecurityFamily.

Constructor Summary

Constructors

Constructor and Description
SecurityFamilyVO(long id, java.lang.String name, java.math.BigDecimal priceIncr)
SecurityFamilyVO(long id, java.lang.String name, java.lang.String symbolRoot, java.lang.String isinRoot, java.lang.String ricRoot, java.lang.String currency, double contractSize, java.math.BigDecimal priceIncr, SecurityFamilyType familyType, long underlyingId, long exchangeId)

Method Summary

Modifier and Type	Method and Description
SecurityFamily	convertVOToEntity(GenericDao genericDao) converts a value object to its corresponding entity
boolean	equals(java.lang.Object o)
double	getContractSize() The contractSize of the Securities of this SecurityFamily (e.g.
java.lang.String	getCurrency() The currency of the Securities of this SecurityFamily
long	getExchangeId() Exchange where securities are traded
SecurityFamilyType	getFamilyType() Type of SecurityFamily
long	getId()
java.lang.String	getIsinRoot() The common part of the ISIN (e.g.
java.lang.String	getName() The name of this SecurityFamily
java.lang.String	getObjectType()
java.math.BigDecimal	getPriceIncr() Step size for price.
int	getPriceScale() The number of digits that prices of Securities of this SecurityFamily are quoted in.
java.lang.String	getRicRoot() The common part of RIC (e.g.
java.lang.String	getSymbolRoot() The common part of Symbol (e.g.
long	getUnderlyingId() The base class of all Securities in the system
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityFamilyVO

public SecurityFamilyVO(long id,
                        java.lang.String name,
                        java.math.BigDecimal priceIncr)

SecurityFamilyVO

public SecurityFamilyVO(long id,
                        java.lang.String name,
                        java.lang.String symbolRoot,
                        java.lang.String isinRoot,
                        java.lang.String ricRoot,
                        java.lang.String currency,
                        double contractSize,
                        java.math.BigDecimal priceIncr,
                        SecurityFamilyType familyType,
                        long underlyingId,
                        long exchangeId)

Method Detail

getObjectType

public java.lang.String getObjectType()

Specified by:

getObjectType in class PropertyHolderVO

getId

public long getId()

Specified by:

getId in interface BaseValueObjectI

Specified by:

getId in interface PropertyHolderI

Specified by:

getId in interface SecurityFamilyI

getName

public java.lang.String getName()

The name of this SecurityFamily

Specified by:

getName in interface SecurityFamilyI

getSymbolRoot

public java.lang.String getSymbolRoot()

The common part of Symbol (e.g. VIX for the VIX Future FVIX AUG/10 1000)

Specified by:

getSymbolRoot in interface SecurityFamilyI

getIsinRoot

public java.lang.String getIsinRoot()

The common part of the ISIN (e.g. VIX for the VIX Future 0FVIXFD00000). If no value is set the baseSymbol is taken.

Specified by:

getIsinRoot in interface SecurityFamilyI

getRicRoot

public java.lang.String getRicRoot()

The common part of RIC (e.g. VX for the VIX Future VXQ1:VE). If no value is set the baseSymbol is taken.

Specified by:

getRicRoot in interface SecurityFamilyI

getCurrency

public java.lang.String getCurrency()

The currency of the Securities of this SecurityFamily

Specified by:

getCurrency in interface SecurityFamilyI

getContractSize

public double getContractSize()

The contractSize of the Securities of this SecurityFamily (e.g. 100 for SPX Options).

Specified by:

getContractSize in interface SecurityFamilyI

getPriceIncr

public java.math.BigDecimal getPriceIncr()

Step size for price.

Specified by:

getPriceIncr in interface SecurityFamilyI

getFamilyType

public SecurityFamilyType getFamilyType()

Type of SecurityFamily

Specified by:

getFamilyType in interface SecurityFamilyI

getUnderlyingId

public long getUnderlyingId()

The base class of all Securities in the system

getExchangeId

public long getExchangeId()

Exchange where securities are traded

toString

public java.lang.String toString()

Specified by:

toString in interface BaseValueObjectI

Overrides:

toString in class PropertyHolderVO

getPriceScale

public int getPriceScale()

The number of digits that prices of Securities of this SecurityFamily are quoted in.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

convertVOToEntity

public SecurityFamily convertVOToEntity(GenericDao genericDao)

converts a value object to its corresponding entity