com.devexperts.qd

Interface DataField

All Known Subinterfaces:

DataIntField, DataObjField

All Known Implementing Classes:

AbstractDataField, AbstractDataIntField, AbstractDataObjField, ByteArrayField, CompactCharField, CompactIntField, DateField, DecimalField, LongField, MarshalledObjField, PlainIntField, PlainObjField, SequenceField, ShortStringField, StringField, TimeField, TimeMillisField, TimeSecondsField, VoidIntField, VoidObjField, WideDecimalField

public interface DataField

Common super-interface for DataIntField and DataObjField. Those two interfaces are the only actual interfaces that are used for all data fields in QD -- any data field instance implements exactly one of them.

Method Summary

Modifier and Type	Method and Description
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.
String	getString(RecordCursor cursor)
void	read(com.devexperts.io.BufferedInput in, RecordCursor cursor)
void	setString(RecordCursor cursor, String value)
void	write(com.devexperts.io.BufferedOutput out, RecordCursor cursor)

Method Detail

getRecord

DataRecord getRecord()

Returns parent DataRecord of this field.

getIndex

int getIndex()

Returns index of this field in its parent DataRecord.

getName

String getName()

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.

getLocalName

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. 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.

See Also:

getName(), getPropertyName()

getPropertyName

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. 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.

See Also:

getLocalName()

getSerialType

SerialFieldType getSerialType()

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.

getString

String getString(RecordCursor cursor)

setString

void setString(RecordCursor cursor,
               String value)

write

void write(com.devexperts.io.BufferedOutput out,
           RecordCursor cursor)
    throws IOException

Throws:

IOException

read

void read(com.devexperts.io.BufferedInput in,
          RecordCursor cursor)
   throws IOException

Throws:

IOException