com.micex.client

Class Parser

java.lang.Object

com.micex.client.Parser

public abstract class Parser
extends Object

A parser for data received from ASTS. Parses raw ASTS buffer into records and fields values. The Parser itself does not store any data but uses Binder callback interface to get Filler instance which is in turn responsible to create and/or update records.

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBuffer	buffer
protected Client	client
long	number
protected static long	numerator
protected int	options
static int	PARSE_DATE_AS_INT Parse Meta.FieldType.Date fields as Integer.
static int	PARSE_TIME_AS_INT Parse Meta.FieldType.Time fields as Integer.
long	stamp

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Parser(Client client)

Method Summary

Modifier and Type	Method and Description
ByteBuffer	buffer() Get access to raw ASTS buffer.
abstract boolean	empty() Indicates if the buffer has actually no significant data to parse.
int	execute(Binder binder) Calls execute(Binder, int) with options==0.
int	execute(Binder binder, int options) Starts processing ASTS response buffer.
String	filter() Request parameters, encoded to ASTS string.
Parser	isolate() Isolates raw API buffer.
int	length() Length of the raw ASTS buffer.
protected abstract int	parse(Binder binder)
protected int	process(Meta.Message source, String filter, Filler filler)
protected void	recycle()

Methods inherited from class java.lang.Object

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

Field Detail

PARSE_DATE_AS_INT

public static int PARSE_DATE_AS_INT

Parse Meta.FieldType.Date fields as Integer. By default Date fields are parsed into YMD.

PARSE_TIME_AS_INT

public static int PARSE_TIME_AS_INT

Parse Meta.FieldType.Time fields as Integer. By default Time fields are parsed into HMS.

client

protected Client client

buffer

protected ByteBuffer buffer

options

protected int options

numerator

protected static long numerator

stamp

public long stamp

number

public long number

Constructor Detail

Parser

protected Parser(Client client)

Method Detail

buffer

public ByteBuffer buffer()

Get access to raw ASTS buffer.

Returns:

raw ASTS byte buffer;

isolate

public Parser isolate()

Isolates raw API buffer. Copies the buffer data into a new array buffer in case the origin buffer is direct (i.e. references native API raw buffer). Must be called for a parser that is going to be executed by another thread if the client is configured with direct buffers enabled.

Returns:

the same parser instance (this).

Since:

1.3.0

See Also:

Client.Options.isDirectBuffers(), Client.Options.setDirectBuffers(boolean)

length

public int length()

Length of the raw ASTS buffer.

Returns:

number of bytes in buffer().

empty

public abstract boolean empty()

Indicates if the buffer has actually no significant data to parse.

Returns:

true if it is safe to skip parsing this buffer.

parse

protected abstract int parse(Binder binder)
                      throws ClientException,
                             BufferUnderflowException

Throws:

ClientException

BufferUnderflowException

execute

public final int execute(Binder binder,
                         int options)
                  throws ClientException,
                         BufferUnderflowException

Starts processing ASTS response buffer.

Parameters:

binder - Binder instance which is responsible to return an appropriate Filler for parsing Meta.Message.

options - combination of PARSE_XXX options to control parser behavior.

Returns:

total number of parsed rows.

Throws:

ClientException - if the parser could not obtains scale information.

BufferUnderflowException - in case of incorrect ASTS buffer.

execute

public final int execute(Binder binder)
                  throws ClientException,
                         BufferUnderflowException

Calls execute(Binder, int) with options==0.

Parameters:

binder - Binder instance which is responsible to return an appropriate Filler for parsing Meta.Message.

Returns:

total number of parsed rows.

Throws:

ClientException - if the parser could not obtains scale information.

BufferUnderflowException - in case of incorrect ASTS buffer.

See Also:

execute(Binder, int)

filter

public final String filter()

Request parameters, encoded to ASTS string.

When the same Meta.Message is loaded / opened (Client.load(String, Map) / Client.open(String, Map, boolean)) with different set of params, the filter() can be used to distinguish parsing of one response from another.

Returns:

ASTS request parameters, only valid between Filler.initTableUpdate(Meta.Message) and Filler.doneTableUpdate(Meta.Message).

process

protected int process(Meta.Message source,
                      String filter,
                      Filler filler)
               throws BufferUnderflowException,
                      ClientException

Throws:

BufferUnderflowException

ClientException

recycle

protected void recycle()