com.devexperts.qd.kit

Class DefaultRecord

java.lang.Object

com.devexperts.qd.kit.DefaultRecord

All Implemented Interfaces:

DataRecord

public class DefaultRecord
extends Object
implements DataRecord

The DefaultRecord is a basic implementation of data record. Note, that this implementation works only with fields that are derived from AbstractDataIntField and AbstractDataObjField classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	has_time
protected int	id
protected String	name

Constructor Summary

Constructors

Constructor and Description
DefaultRecord(int id, String name, boolean hasTime, DataIntField[] dataIntFields, DataObjField[] dataObjFields)

Method Summary

Modifier and Type	Method and Description
void	addFieldAlias(String oldName, String newName)
DataField	findFieldByName(String name) Finds field by its full name, or by its local name, or by its property name, or by its default property name that is created from its local name using AbstractDataField.getDefaultPropertyName method.
int	getId() Returns identifier of this record.
AbstractDataIntField	getIntField(int index) Returns Int-field by its index within this record.
int	getIntFieldCount() Returns a number of Int-fields in this record.
RecordMapping	getMapping() Returns mapping for this data record or null if there is no such mapping for this record.
<T extends RecordMapping> T	getMapping(Class<T> mappingClass) Returns specified mapping for this data record or null if there is no such mapping for this record.
Map<Class<? extends RecordMapping>,RecordMapping>	getMappings() Returns all mappings for this data record.
String	getName() Returns name of this record.
AbstractDataObjField	getObjField(int index) Returns Obj-field by its index within this record.
int	getObjFieldCount() Returns a number of Obj-fields in this record.
DefaultScheme	getScheme() Returns parent DataScheme of this field.
boolean	hasTime() Determines if this record contains time coordinate.
void	readFields(com.devexperts.io.BufferedInput in, RecordCursor cursor) Reads this record's field values in a binary from the specified buffered input.
void	setScheme(DefaultScheme scheme) Sets reference to parent data scheme.
String	toString()
boolean	update(RecordCursor from, RecordCursor to) Updates this record's field values in to cursor by values from cursor.
void	writeFields(com.devexperts.io.BufferedOutput out, RecordCursor cursor) Writes this record's field values in a binary form into a specified buffered output.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected final int id

name

protected final String name

has_time

protected final boolean has_time

Constructor Detail

DefaultRecord

public DefaultRecord(int id,
                     String name,
                     boolean hasTime,
                     DataIntField[] dataIntFields,
                     DataObjField[] dataObjFields)

Method Detail

addFieldAlias

public void addFieldAlias(String oldName,
                          String newName)

setScheme

public final void setScheme(DefaultScheme scheme)

Sets reference to parent data scheme.

Throws:

IllegalStateException - if parent scheme already set to different instance.

toString

public final String toString()

Overrides:

toString in class Object

getScheme

public final DefaultScheme getScheme()

Description copied from interface: DataRecord

Returns parent DataScheme of this field.

Specified by:

getScheme in interface DataRecord

getMapping

public RecordMapping getMapping()

Description copied from interface: DataRecord

Returns mapping for this data record or null if there is no such mapping for this record. If data record has multiple mappings then the first processed mapping will be returned. The result of invoking getRecord() method on the resulting record mapping (when it is non null) is equal to this data record.

Specified by:

getMapping in interface DataRecord

getMapping

public final <T extends RecordMapping> T getMapping(Class<T> mappingClass)

Description copied from interface: DataRecord

Returns specified mapping for this data record or null if there is no such mapping for this record. The result of invoking getRecord() method on the resulting record mapping (when it is non null) is equal to this data record.

Specified by:

getMapping in interface DataRecord

getMappings

public Map<Class<? extends RecordMapping>,RecordMapping> getMappings()

Description copied from interface: DataRecord

Returns all mappings for this data record. The result of invoking getRecord() method on any of the resulting record mappings is equal to this data record.

Specified by:

getMappings in interface DataRecord

getId

public final int getId()

Description copied from interface: DataRecord

Returns identifier of this record. The identifier coincides with record index in its parent DataScheme. It is also used for identification of data record in serialized form.

Specified by:

getId in interface DataRecord

getName

public final String getName()

Description copied from interface: DataRecord

Returns name of this record. The name must be unique within whole DataScheme. The naming convention for record names is to use CapitalizedNames without separators and to prefer one-word names, like "Quote", "Trade", "TimeAndSales", etc.

Specified by:

getName in interface DataRecord

hasTime

public final boolean hasTime()

Description copied from interface: DataRecord

Determines if this record contains time coordinate.

Specified by:

hasTime in interface DataRecord

getIntFieldCount

public final int getIntFieldCount()

Description copied from interface: DataRecord

Returns a number of Int-fields in this record.

Specified by:

getIntFieldCount in interface DataRecord

getIntField

public final AbstractDataIntField getIntField(int index)

Description copied from interface: DataRecord

Returns Int-field by its index within this record.

Specified by:

getIntField in interface DataRecord

getObjFieldCount

public final int getObjFieldCount()

Description copied from interface: DataRecord

Returns a number of Obj-fields in this record.

Specified by:

getObjFieldCount in interface DataRecord

getObjField

public final AbstractDataObjField getObjField(int index)

Description copied from interface: DataRecord

Returns Obj-field by its index within this record.

Specified by:

getObjField in interface DataRecord

findFieldByName

public final DataField findFieldByName(String name)

Description copied from interface: DataRecord

Finds field by its full name, or by its local name, or by its property name, or by its default property name that is created from its local name using AbstractDataField.getDefaultPropertyName method.

Specified by:

findFieldByName in interface DataRecord

Returns:

data field with the corresponding full name, local or property name or null if not found.

update

public boolean update(RecordCursor from,
                      RecordCursor to)

Description copied from interface: DataRecord

Updates this record's field values in to cursor by values from cursor. This method is used for implementation of ticker contract.

Specified by:

update in interface DataRecord

Returns:

true if any values were updated and listeners shall be notified on data change.

writeFields

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

Description copied from interface: DataRecord

Writes this record's field values in a binary form into a specified buffered output. The bytes written should be the same as if each field is individually written using DataIntField.writeInt(BufferedOutput, int) and DataObjField.writeObj(BufferedOutput, Object).

Specified by:

writeFields in interface DataRecord

Throws:

IOException

readFields

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

Description copied from interface: DataRecord

Reads this record's field values in a binary from the specified buffered input. The data read should be the same as if each field is individually read using DataIntField.readInt(BufferedInput) and DataObjField.readObj(BufferedInput).

Specified by:

readFields in interface DataRecord

Throws:

IOException