com.devexperts.qd.kit

Class AbstractDataField

java.lang.Object

com.devexperts.qd.kit.AbstractDataField

All Implemented Interfaces:

DataField

Direct Known Subclasses:

AbstractDataIntField, AbstractDataObjField

public abstract class AbstractDataField
extends Object
implements DataField

Method Summary

Modifier and Type	Method and Description
static String	getDefaultPropertyName(String localName)
int	getIndex() Returns index of this field in its parent DataRecord.
String	getLocalName() Returns local name of this field -- the name of this field that is unique within the record and identifies this field in QTP binary protocol.
String	getName() Returns name of this field.
String	getPropertyName() Returns property name of this field -- the name of this field that is unique within the record and identifies this field in QTP text formats.
DataRecord	getRecord() Returns parent DataRecord of this field.
SerialFieldType	getSerialType() Returns serial type of this field.
void	setRecord(DataRecord record) Sets reference to parent data record.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.devexperts.qd.DataField

getString, read, setString, write

Method Detail

setRecord

public final void setRecord(DataRecord record)

Sets reference to parent data record.

Throws:

IllegalStateException - if parent record already set to different instance.

toString

public final String toString()

Overrides:

toString in class Object

getRecord

public final DataRecord getRecord()

Description copied from interface: DataField

Returns parent DataRecord of this field.

Specified by:

getRecord in interface DataField

getIndex

public final int getIndex()

Description copied from interface: DataField

Returns index of this field in its parent DataRecord.

Specified by:

getIndex in interface DataField

getName

public final String getName()

Description copied from interface: DataField

Returns name of this field. The name must be unique within the whole DataScheme. It is required that this full field name consists of its parent record name followed by dot ('.') followed by local name of this filed like these: "Quote.Bid.Price", "Quote.Bid.Exchange", "Trade.Last.Price", "TimeAndSale.Price", etc.

Specified by:

getName in interface DataField

getLocalName

public final String getLocalName()

Description copied from interface: DataField

Returns local name of this field -- the name of this field that is unique within the record and identifies this field in QTP binary protocol. The naming convention for record names is to use CapitalizedNames with occasional dots ('.') to separate conceptual pieces and to make local names system-wide unique in certain application like these: "Bid.Price", "Bid.Exchange", "Last.Price", "Price", etc. Note, that uniqueness in the data scheme of local names is not required by QD itself, but full names must be unique in each data scheme.

Specified by:

getLocalName in interface DataField

See Also:

DataField.getName(), DataField.getPropertyName()

getPropertyName

public String getPropertyName()

Description copied from interface: DataField

Returns property name of this field -- the name of this field that is unique within the record and identifies this field in QTP text formats. The naming convention for record names is to use CapitalizedNames without separators, like "BidPrice", "BidExchangeCode", "Price", etc. The property name in a combination with "get" or "is" prefix serves as a method name in object-oriented APIs for QD data like RecordMapping.

The property name serves as an alternative identification in QTP binary protocol, too. Local names and property names should not conflict in the record.

By default, property names are constructed from local names by dropping dots ('.') inside them using AbstractDataField.getDefaultPropertyName method, but RecordMapping can provide custom property names with getNonDefaultPropertyName method.

Specified by:

getPropertyName in interface DataField

See Also:

DataField.getLocalName()

getSerialType

public final SerialFieldType getSerialType()

Description copied from interface: DataField

Returns serial type of this field. It describes the serialized form of this field in QTP protocol with enough detail to skip the serialized value of this field if necessary.

Specified by:

getSerialType in interface DataField

getDefaultPropertyName

public static String getDefaultPropertyName(String localName)