DataDictionary (QuickFIX/J Distribution 2.3.0 API)

java.lang.Object
- quickfix.DataDictionary

```
public class DataDictionary
extends Object
```
Provide the message metadata for various versions of FIX.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataDictionary.GroupInfo
Contains meta-data for FIX repeating groups

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataDictionary.GroupInfo` Contains meta-data for FIX repeating groups

Field Summary

Fields
Modifier and Type Field and Description

static String ANY_VALUE

static String HEADER_ID

static String TRAILER_ID

Fields
Modifier and Type	Field and Description
`static String`	`ANY_VALUE`
`static String`	`HEADER_ID`
`static String`	`TRAILER_ID`

Constructor Summary

Constructors
Constructor and Description
`DataDictionary(DataDictionary source)` Copy a data dictionary.
`DataDictionary(InputStream in)` Initialize a data dictionary from an input stream.
`DataDictionary(InputStream in, Supplier<DocumentBuilderFactory> documentBuilderFactorySupplier)` Initialize a data dictionary from an input stream.
`DataDictionary(String location)` Initialize a data dictionary from a URL or a file path.
`DataDictionary(String location, Supplier<DocumentBuilderFactory> documentBuilderFactorySupplier)` Initialize a data dictionary from a URL or a file path.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getExtensionPack()`
`String`	`getFieldName(int field)` Get the field name for a specified tag.
`int`	`getFieldTag(String name)` Get the field tag given a field name.
`FieldType`	`getFieldType(int field)` Return the field type for a field.
`String`	`getFullVersion()` Get the FIX major/minor/SP/EP version associated with this dictionary.
`DataDictionary.GroupInfo`	`getGroup(String msg, int field)` Get repeating group metadata.
`String`	`getMajorVersion()` NOTE: this is of type String to cover the "Latest" case.
`int`	`getMinorVersion()`
`String`	`getMsgType(String msgName)` Return the message type for the specified name.
`int`	`getNumMessageCategories()`
`int[]`	`getOrderedFields()`
`int`	`getServicePack()`
`String`	`getValue(int field, String name)` Get the value, if any, for an enumerated value name.
`String`	`getValueName(int field, String value)` Get the value name, if any, for an enumerated field value.
`String`	`getVersion()` Get the FIX major/minor version associated with this dictionary.
`boolean`	`hasFieldValue(int field)` Predicate for determining if a field has enumerated values.
`boolean`	`isAdminMessage(String msgType)` Predicate for determining if a message is in the admin category.
`boolean`	`isAllowUnknownMessageFields()`
`boolean`	`isAppMessage(String msgType)` Predicate for determining if a message is in the app category.
`boolean`	`isCheckFieldsHaveValues()`
`boolean`	`isCheckFieldsOutOfOrder()`
`boolean`	`isCheckUnorderedGroupFields()`
`boolean`	`isCheckUserDefinedFields()`
`boolean`	`isDataField(int field)` Predicate for determining if a field is a FIX raw data field.
`boolean`	`isField(int field)` Predicate for determining if a tag is a defined field.
`boolean`	`isFieldValue(int field, String value)` Predicate for determining if a field value is valid
`boolean`	`isGroup(String msg, int field)` Predicate for determining if a field is a group count field for a message type.
`boolean`	`isHeaderField(int field)` Predicate for determining if field is a header field.
`boolean`	`isHeaderGroup(int field)` Predicate for determining if a field is a header group count field
`boolean`	`isMsgField(String msgType, int field)` Predicate for determining if a field is valid for a given message type.
`boolean`	`isMsgType(String msgType)` Predicate for determining if message type is valid for a specified FIX version.
`boolean`	`isRequiredField(String msgType, int field)` Predicate for determining if a field is required for a message type
`boolean`	`isRequiredHeaderField(int field)` Predicate for determining if a header field is a required field
`boolean`	`isRequiredTrailerField(int field)` Predicate for determining if a trailer field is a required field
`boolean`	`isTrailerField(int field)` Predicate for determining if field is a trailer field.
`void`	`setAllowUnknownMessageFields(boolean allowUnknownFields)`
`void`	`setCheckFieldsHaveValues(boolean flag)` Controls whether empty field values are checked.
`void`	`setCheckFieldsOutOfOrder(boolean flag)` Controls whether out of order fields are checked.
`void`	`setCheckUnorderedGroupFields(boolean flag)` Controls whether group fields are in the same order
`void`	`setCheckUserDefinedFields(boolean flag)` Controls whether user defined fields are checked.
`void`	`validate(Message message)` Validate a message, including the header and trailer fields.
`void`	`validate(Message message, boolean bodyOnly)` Validate the message body, with header and trailer fields being validated conditionally.

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

- Field Detail
  - ANY_VALUE
```
public static final String ANY_VALUE
```
    See Also:
    
    Constant Field Values
  - HEADER_ID
```
public static final String HEADER_ID
```
    See Also:
    
    Constant Field Values
  - TRAILER_ID
```
public static final String TRAILER_ID
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataDictionary
```
public DataDictionary(String location)
               throws ConfigError
```
    Initialize a data dictionary from a URL or a file path.
    
    Parameters:
    
    location - a URL or file system path
    
    Throws:
    
    ConfigError
  - DataDictionary
```
public DataDictionary(String location,
                      Supplier<DocumentBuilderFactory> documentBuilderFactorySupplier)
               throws ConfigError
```
    Initialize a data dictionary from a URL or a file path.
    
    Parameters:
    
    location - a URL or file system path
    
    documentBuilderFactorySupplier - custom document builder factory supplier
    
    Throws:
    
    ConfigError
  - DataDictionary
```
public DataDictionary(InputStream in)
               throws ConfigError
```
    Initialize a data dictionary from an input stream.
    
    Parameters:
    
    in - the input stream
    
    Throws:
    
    ConfigError
  - DataDictionary
```
public DataDictionary(InputStream in,
                      Supplier<DocumentBuilderFactory> documentBuilderFactorySupplier)
               throws ConfigError
```
    Initialize a data dictionary from an input stream.
    
    Parameters:
    
    in - the input stream
    
    documentBuilderFactorySupplier - custom document builder factory supplier
    
    Throws:
    
    ConfigError
  - DataDictionary
```
public DataDictionary(DataDictionary source)
```
    Copy a data dictionary.
    
    Parameters:
    
    source - the source dictionary that will be copied into this dictionary
- Method Detail
  - getVersion
```
public String getVersion()
```
    Get the FIX major/minor version associated with this dictionary. E.g. FIX.5.0
    
    Returns:
    
    the FIX version
  - getFullVersion
```
public String getFullVersion()
```
    Get the FIX major/minor/SP/EP version associated with this dictionary. E.g. FIX.5.0.SP2_EP260
    
    Returns:
    
    the full FIX version
  - getExtensionPack
```
public int getExtensionPack()
```
    Returns:
    
    the ExtensionPack (EP), 0 if it is undefined.
  - getServicePack
```
public int getServicePack()
```
    Returns:
    
    the ServicePack (SP), 0 if it is undefined.
  - getMinorVersion
```
public int getMinorVersion()
```
    Returns:
    
    the minor FIX version, 0 if it is undefined.
  - getMajorVersion
```
public String getMajorVersion()
```
    NOTE: this is of type String to cover the "Latest" case.
    
    Returns:
    
    the major FIX version
  - getFieldName
```
public String getFieldName(int field)
```
    Get the field name for a specified tag.
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    the field name
  - getValueName
```
public String getValueName(int field,
                           String value)
```
    Get the value name, if any, for an enumerated field value.
    
    Parameters:
    
    field - the tag
    
    value - the value
    
    Returns:
    
    the value's name
  - getValue
```
public String getValue(int field,
                       String name)
```
    Get the value, if any, for an enumerated value name.
    
    Parameters:
    
    field - the tag
    
    name - the value name
    
    Returns:
    
    the value assigned to passed name
  - isField
```
public boolean isField(int field)
```
    Predicate for determining if a tag is a defined field.
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    true if the field is defined, false otherwise
  - getFieldType
```
public FieldType getFieldType(int field)
```
    Return the field type for a field.
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    the field type
  - getMsgType
```
public String getMsgType(String msgName)
```
    Return the message type for the specified name.
    
    Parameters:
    
    msgName - The message name.
    
    Returns:
    
    the message type
  - isMsgType
```
public boolean isMsgType(String msgType)
```
    Predicate for determining if message type is valid for a specified FIX version.
    
    Parameters:
    
    msgType - the message type value
    
    Returns:
    
    true if the message type if defined, false otherwise
  - isAdminMessage
```
public boolean isAdminMessage(String msgType)
```
    Predicate for determining if a message is in the admin category.
    
    Parameters:
    
    msgType - the messageType
    
    Returns:
    
    true, if the msgType is a AdminMessage false, if the msgType is a ApplicationMessage
  - isAppMessage
```
public boolean isAppMessage(String msgType)
```
    Predicate for determining if a message is in the app category.
    
    Parameters:
    
    msgType - the messageType
    
    Returns:
    
    true, if the msgType is a ApplicationMessage false, if the msgType is a AdminMessage
  - isMsgField
```
public boolean isMsgField(String msgType,
                          int field)
```
    Predicate for determining if a field is valid for a given message type.
    
    Parameters:
    
    msgType - the message type
    
    field - the tag
    
    Returns:
    
    true if field is defined for message, false otherwise.
  - isHeaderField
```
public boolean isHeaderField(int field)
```
    Predicate for determining if field is a header field.
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    true if field is a header field, false otherwise.
  - isTrailerField
```
public boolean isTrailerField(int field)
```
    Predicate for determining if field is a trailer field.
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    true if field is a trailer field, false otherwise.
  - getFieldTag
```
public int getFieldTag(String name)
```
    Get the field tag given a field name.
    
    Parameters:
    
    name - the field name
    
    Returns:
    
    the tag
  - isRequiredField
```
public boolean isRequiredField(String msgType,
                               int field)
```
    Predicate for determining if a field is required for a message type
    
    Parameters:
    
    msgType - the message type
    
    field - the tag
    
    Returns:
    
    true if field is required, false otherwise
  - isRequiredHeaderField
```
public boolean isRequiredHeaderField(int field)
```
    Predicate for determining if a header field is a required field
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    true if field s required, false otherwise
  - isRequiredTrailerField
```
public boolean isRequiredTrailerField(int field)
```
    Predicate for determining if a trailer field is a required field
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    true if field s required, false otherwise
  - hasFieldValue
```
public boolean hasFieldValue(int field)
```
    Predicate for determining if a field has enumerated values.
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    true if field is enumerated, false otherwise
  - isFieldValue
```
public boolean isFieldValue(int field,
                            String value)
```
    Predicate for determining if a field value is valid
    
    Parameters:
    
    field - the tag
    
    value - a possible field value
    
    Returns:
    
    true if field value is valid, false otherwise
  - isGroup
```
public boolean isGroup(String msg,
                       int field)
```
    Predicate for determining if a field is a group count field for a message type.
    
    Parameters:
    
    msg - the message type
    
    field - the tag
    
    Returns:
    
    true if field starts a repeating group, false otherwise
  - isHeaderGroup
```
public boolean isHeaderGroup(int field)
```
    Predicate for determining if a field is a header group count field
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    true if field starts a repeating group, false otherwise
  - getGroup
```
public DataDictionary.GroupInfo getGroup(String msg,
                                         int field)
```
    Get repeating group metadata.
    
    Parameters:
    
    msg - the message type
    
    field - the tag
    
    Returns:
    
    an object containing group-related metadata
  - isDataField
```
public boolean isDataField(int field)
```
    Predicate for determining if a field is a FIX raw data field.
    
    Parameters:
    
    field - the tag
    
    Returns:
    
    true if field is a raw data field, false otherwise
  - setCheckFieldsOutOfOrder
```
public void setCheckFieldsOutOfOrder(boolean flag)
```
    Controls whether out of order fields are checked.
    
    Parameters:
    
    flag - true = checked, false = not checked
  - isCheckFieldsOutOfOrder
```
public boolean isCheckFieldsOutOfOrder()
```
  - isCheckUnorderedGroupFields
```
public boolean isCheckUnorderedGroupFields()
```
  - isCheckFieldsHaveValues
```
public boolean isCheckFieldsHaveValues()
```
  - isCheckUserDefinedFields
```
public boolean isCheckUserDefinedFields()
```
  - isAllowUnknownMessageFields
```
public boolean isAllowUnknownMessageFields()
```
  - setCheckUnorderedGroupFields
```
public void setCheckUnorderedGroupFields(boolean flag)
```
    Controls whether group fields are in the same order
    
    Parameters:
    
    flag - true = checked, false = not checked
  - setCheckFieldsHaveValues
```
public void setCheckFieldsHaveValues(boolean flag)
```
    Controls whether empty field values are checked.
    
    Parameters:
    
    flag - true = checked, false = not checked
  - setCheckUserDefinedFields
```
public void setCheckUserDefinedFields(boolean flag)
```
    Controls whether user defined fields are checked.
    
    Parameters:
    
    flag - true = checked, false = not checked
  - setAllowUnknownMessageFields
```
public void setAllowUnknownMessageFields(boolean allowUnknownFields)
```
  - validate
```
public void validate(Message message)
              throws IncorrectTagValue,
                     FieldNotFound,
                     IncorrectDataFormat
```
    Validate a message, including the header and trailer fields.
    
    Parameters:
    
    message - the message
    
    Throws:
    
    IncorrectTagValue - if a field value is not valid
    
    FieldNotFound - if a field cannot be found
    
    IncorrectDataFormat - if a field value has a wrong data type
  - validate
```
public void validate(Message message,
                     boolean bodyOnly)
              throws IncorrectTagValue,
                     FieldNotFound,
                     IncorrectDataFormat
```
    Validate the message body, with header and trailer fields being validated conditionally.
    
    Parameters:
    
    message - the message
    
    bodyOnly - whether to validate just the message body, or to validate the header and trailer sections as well.
    
    Throws:
    
    IncorrectTagValue - if a field value is not valid
    
    FieldNotFound - if a field cannot be found
    
    IncorrectDataFormat - if a field value has a wrong data type
  - getNumMessageCategories
```
public int getNumMessageCategories()
```
  - getOrderedFields
```
public int[] getOrderedFields()
```

Class DataDictionary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANY_VALUE

HEADER_ID

TRAILER_ID

Constructor Detail

DataDictionary

DataDictionary

DataDictionary

DataDictionary

DataDictionary

Method Detail

getVersion

getFullVersion

getExtensionPack

getServicePack

getMinorVersion

getMajorVersion

getFieldName

getValueName

getValue

isField

getFieldType

getMsgType

isMsgType

isAdminMessage

isAppMessage

isMsgField

isHeaderField

isTrailerField

getFieldTag

isRequiredField

isRequiredHeaderField

isRequiredTrailerField

hasFieldValue

isFieldValue

isGroup

isHeaderGroup

getGroup

isDataField

setCheckFieldsOutOfOrder

isCheckFieldsOutOfOrder

isCheckUnorderedGroupFields

isCheckFieldsHaveValues

isCheckUserDefinedFields

isAllowUnknownMessageFields

setCheckUnorderedGroupFields

setCheckFieldsHaveValues

setCheckUserDefinedFields

setAllowUnknownMessageFields

validate

validate

getNumMessageCategories

getOrderedFields