Package org.marketcetera.util.quickfix

Class AnalyzedField

java.lang.Object

org.marketcetera.util.quickfix.AnalyzedField

public class AnalyzedField
extends Object

Analyzes a QuickFIX/J field, producing a human-readable representation of its contents.

Since:

1.0.0

Version:

$Id: AnalyzedField.java 17411 2017-04-28 14:50:38Z colin $

Author:

tlerios@marketcetera.com

Field Summary

Fields

Modifier and Type	Field	Description
private List<AnalyzedGroup>	mGroups
private String	mName
private quickfix.Field<?>	mQField
private quickfix.FieldType	mQType
private boolean	mRequired
private String	mValue

Constructor Summary

Constructors

Constructor	Description
AnalyzedField(quickfix.DataDictionary nameQDict, quickfix.DataDictionary scopeQDict, quickfix.FieldMap qMap, String msgType, quickfix.Field<?> qField)	Creates a new analyzed field for the given QuickFIX/J field.

Method Summary

Modifier and Type	Method	Description
List<AnalyzedGroup>	getGroups()	Returns the receiver's groups.
String	getName()	Returns the receiver's name.
quickfix.Field<?>	getQField()	Returns the receiver's QuickFIX/J field.
int	getQFieldTag()	Returns the receiver's QuickFIX/J field tag.
Object	getQFieldValue()	Returns the receiver's QuickFIX/J field value.
String	getQFieldValueAsString()	Returns the receiver's QuickFIX/J field value in string form.
quickfix.FieldType	getQType()	Returns the receiver's QuickFIX/J field type.
boolean	getRequired()	Returns true if the receiver is a required field.
String	getValue()	Returns the receiver's (analyzed) value.
void	print(PrintStream stream, String prefix)	Prints the receiver onto the given stream.

Methods inherited from class java.lang.Object

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

Field Detail

mQField

private final quickfix.Field<?> mQField

mQType

private final quickfix.FieldType mQType

mName

private final String mName

mRequired

private final boolean mRequired

mValue

private final String mValue

mGroups

private final List<AnalyzedGroup> mGroups

Constructor Detail

AnalyzedField

AnalyzedField(quickfix.DataDictionary nameQDict,
              quickfix.DataDictionary scopeQDict,
              quickfix.FieldMap qMap,
              String msgType,
              quickfix.Field<?> qField)

Creates a new analyzed field for the given QuickFIX/J field. The field is part of the given QuickFIX/J field map, and the map is part of (or same as) the message with the given type. One data dictionary is used to translate field tags and enumerated values (the name dictionary); another (the scope dictionary) is used for scope-dependent lookups such as required flags and subgroup analysis.

Parameters:

nameQDict - The name dictionary.

scopeQDict - The scope dictionary.

qMap - The field map.

msgType - The message type.

qField - The field.

Method Detail

getQField

public quickfix.Field<?> getQField()

Returns the receiver's QuickFIX/J field.

Returns:

The field.

getQType

public quickfix.FieldType getQType()

Returns the receiver's QuickFIX/J field type.

Returns:

The type.

getName

public String getName()

Returns the receiver's name.

Returns:

The name.

getRequired

public boolean getRequired()

Returns true if the receiver is a required field.

Returns:

True if so.

getValue

public String getValue()

Returns the receiver's (analyzed) value.

Returns:

The value.

getGroups

public List<AnalyzedGroup> getGroups()

Returns the receiver's groups.

Returns:

The groups.

getQFieldTag

public int getQFieldTag()

Returns the receiver's QuickFIX/J field tag.

Returns:

The tag.

getQFieldValue

public Object getQFieldValue()

Returns the receiver's QuickFIX/J field value.

Returns:

The value. It may be null.

getQFieldValueAsString

public String getQFieldValueAsString()

Returns the receiver's QuickFIX/J field value in string form.

Returns:

The value. It may be null.

print

public void print(PrintStream stream,
                  String prefix)

Prints the receiver onto the given stream. Each line printed is preceded by the given prefix.

Parameters:

stream - The stream.

prefix - The prefix.