AbstractQTPParser (QD Core API 3.342)

java.lang.Object
- com.devexperts.qd.qtp.AbstractQTPParser

Direct Known Subclasses:

BinaryQTPParser
```
public abstract class AbstractQTPParser
extends Object
```
Base class for classes that parse QTP messages data from byte stream in some format. This class has some common parsing infrastructure for all formats. Descendants of this class implement particular formats. The input for this parser must be configured with setInput(BufferedInput) method immediately after construction.
Note, that all methods declared to throw IOException actually never do so if the underlying BufferedInput is memory-only. They are declared to throw IOException only in order not to process it in every subclass but to process it in the outermost methods only, where they are wrapped in RuntimeQTPException if they happen.
This class is not thread-safe.
It can be reused to parse unrelated messages if they do not contain record descriptions or if resetSession() is called to clean up its state.

See Also:

AbstractQTPComposer

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`eventTimeSequence` Time and sequence which should be set to cursor.
`protected FieldReplacersCache`	`fieldReplacers` Cache of instantiated field replacers.
`protected boolean`	`mixedSubscription` Flag to combine add/remove subscription into a single addSubscription message.
`protected boolean`	`readEventTimeSequence` Flag to read virtual EventTime/EventSequence fields from messages into `RecordMode.TIMESTAMPED_DATA` buffer.
`protected DataScheme`	`scheme`
`protected QDStats`	`stats` Where to collect stats to.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractQTPParser(DataScheme scheme)
Constructs parser with a specified scheme.

Constructors
Modifier	Constructor and Description
`protected`	`AbstractQTPParser(DataScheme scheme)` Constructs parser with a specified scheme.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected ProtocolDescriptor`	`applyReadAs(ProtocolDescriptor protocolDescriptor)`
`protected RecordMode`	`getRecordBufferMode(MessageType messageType)`
`protected RecordBuffer`	`nextRecordsMessage(MessageConsumer consumer, MessageType messageType)`
`void`	`parse(MessageConsumer consumer)` Parses accumulated bytes and submits parsed messages to the specified MessageConsumer.
`protected abstract void`	`parseImpl(com.devexperts.io.BufferedInput in, MessageConsumer consumer)`
`protected void`	`processPending(MessageConsumer consumer)` Processes pending message from buffers (if any) and resets them to `null`.
`void`	`readAs(MessageType readAs)` Overrides message type for all data and subscription messages read by this parser.
`protected void`	`replaceFieldIfNeeded(RecordCursor cursor)`
`void`	`resetSession()`
`void`	`setEventTimeSequence(long eventTimeSequence)`
`protected void`	`setEventTimeSequenceIfNeeded(RecordCursor cur)`
`void`	`setFieldReplacers(FieldReplacersCache fieldReplacers)`
`void`	`setInput(com.devexperts.io.BufferedInput input)` Changes input to parse messages from.
`void`	`setMixedSubscription(boolean mixedSubscription)`
`void`	`setReadEventTimeSequence(boolean readEventTimeSequence)`
`void`	`setStats(QDStats stats)` Changes stats to gather parser statistics.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - scheme
```
protected final DataScheme scheme
```
  - stats
```
protected QDStats stats
```
    Where to collect stats to. Set by parse(MessageConsumer).
  - readEventTimeSequence
```
protected boolean readEventTimeSequence
```
    Flag to read virtual EventTime/EventSequence fields from messages into RecordMode.TIMESTAMPED_DATA buffer.
  - mixedSubscription
```
protected boolean mixedSubscription
```
    Flag to combine add/remove subscription into a single addSubscription message.
  - eventTimeSequence
```
protected long eventTimeSequence
```
    Time and sequence which should be set to cursor.
  - fieldReplacers
```
protected FieldReplacersCache fieldReplacers
```
    Cache of instantiated field replacers.
- Constructor Detail
  - AbstractQTPParser
```
protected AbstractQTPParser(DataScheme scheme)
```
    Constructs parser with a specified scheme. You must setInput before using this parser.
    
    Parameters:
    
    scheme - data scheme.
- Method Detail
  - setInput
```
public void setInput(com.devexperts.io.BufferedInput input)
```
    Changes input to parse messages from.
    
    Parameters:
    
    input - input to parse messages from.
  - setStats
```
public void setStats(QDStats stats)
```
    Changes stats to gather parser statistics.
    
    Parameters:
    
    stats - stats to gather parser statistics.
  - readAs
```
public void readAs(MessageType readAs)
```
    Overrides message type for all data and subscription messages read by this parser.
    
    Parameters:
    
    readAs - the message type that will be reported for all data and subscription messages, use null to turn off override.
  - setReadEventTimeSequence
```
public void setReadEventTimeSequence(boolean readEventTimeSequence)
```
  - setMixedSubscription
```
public void setMixedSubscription(boolean mixedSubscription)
```
  - setEventTimeSequence
```
public void setEventTimeSequence(long eventTimeSequence)
```
  - setFieldReplacers
```
public void setFieldReplacers(FieldReplacersCache fieldReplacers)
```
  - resetSession
```
public void resetSession()
```
  - parse
```
public final void parse(MessageConsumer consumer)
```
    Parses accumulated bytes and submits parsed messages to the specified MessageConsumer. This method also updates per-record parsed bytes statistics in the specified stats. This is the main method in this class.
    
    Parameters:
    
    consumer - MessageConsumer to pass parsed messages.
  - parseImpl
```
protected abstract void parseImpl(com.devexperts.io.BufferedInput in,
                                  MessageConsumer consumer)
                           throws IOException
```
    Throws:
    
    IOException
  - processPending
```
protected void processPending(MessageConsumer consumer)
```
    Processes pending message from buffers (if any) and resets them to null.
  - nextRecordsMessage
```
protected RecordBuffer nextRecordsMessage(MessageConsumer consumer,
                                          MessageType messageType)
```
  - getRecordBufferMode
```
protected RecordMode getRecordBufferMode(MessageType messageType)
```
  - applyReadAs
```
protected ProtocolDescriptor applyReadAs(ProtocolDescriptor protocolDescriptor)
```
  - setEventTimeSequenceIfNeeded
```
protected final void setEventTimeSequenceIfNeeded(RecordCursor cur)
```
  - replaceFieldIfNeeded
```
protected void replaceFieldIfNeeded(RecordCursor cursor)
```

Class AbstractQTPParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

scheme

stats

readEventTimeSequence

mixedSubscription

eventTimeSequence

fieldReplacers

Constructor Detail

AbstractQTPParser

Method Detail

setInput

setStats

readAs

setReadEventTimeSequence

setMixedSubscription

setEventTimeSequence

setFieldReplacers

resetSession

parse

parseImpl

processPending

nextRecordsMessage

getRecordBufferMode

applyReadAs

setEventTimeSequenceIfNeeded

replaceFieldIfNeeded