IMessageSchema (OnixS CME iLink3 Handler Parent 1.1.1 API)

All Known Implementing Classes:

MessageSchema
```
public interface IMessageSchema
```
Message schema description.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Returns schema description of the schema.
`int`	`getFrameHeaderSize()` Returns size of the frame header.
`UnifiedMetaData`	`getHeaderType()` Returns definition of messages header type.
`int`	`getId()` Returns schema id.
`Map<Integer,UnifiedMetaData>`	`getMessages()` Gets map of all messages in the schema.
`String`	`getPackage()` Returns schema name.
`String`	`getSemanticVersion()` Returns the semantic version of the schema.
`UnifiedMetaData`	`getType(String name)` Gets type from schema dictionary.
`int`	`getVersion()` Returns schema version.
`boolean`	`isLittleEndian()` Returns byte order.
`boolean`	`isMdp3Mode()` Returns CME MDP3 mode.
`int`	`queryVirtualFieldId(String[] fieldPath)` Query virtual field ID.

- Method Detail
  - getPackage
```
String getPackage()
```
    Returns schema name.
    
    Returns:
    
    name of the schema
  - getId
```
int getId()
```
    Returns schema id. A unique identifier of a schema.
    
    Returns:
    
    id of the schema
  - getVersion
```
int getVersion()
```
    Returns schema version.
    
    Returns:
    
    version of the schema
  - getSemanticVersion
```
String getSemanticVersion()
```
    Returns the semantic version of the schema.
    
    Returns:
    
    semantic version of the schema
  - isLittleEndian
```
boolean isLittleEndian()
```
    Returns byte order. Default is little endian.
    
    Returns:
    
    true if byte order is littleEndian (x86), false otherwise
  - getDescription
```
String getDescription()
```
    Returns schema description of the schema.
    
    Returns:
    
    description of the schema
  - getFrameHeaderSize
```
int getFrameHeaderSize()
```
    Returns size of the frame header.
    
    Returns:
    
    frame header size
  - isMdp3Mode
```
boolean isMdp3Mode()
```
    Returns CME MDP3 mode.
    
    Returns:
    
    true if schema is for CME MDP3, false otherwise.
  - getHeaderType
```
UnifiedMetaData getHeaderType()
```
    Returns definition of messages header type. Default value is messageHeader.
    
    Returns:
    
    messages header type definition
  - getType
```
UnifiedMetaData getType(String name)
```
    Gets type from schema dictionary.
    
    Parameters:
    
    name - name of a type in schema type dictionary
    
    Returns:
    
    type definition if type present in the schema, null otherwise
  - getMessages
```
Map<Integer,UnifiedMetaData> getMessages()
```
    Gets map of all messages in the schema.
    
    Returns:
    
    map of all messages
  - queryVirtualFieldId
```
int queryVirtualFieldId(String[] fieldPath)
```
    Query virtual field ID.
    
    Parameters:
    
    fieldPath - Path to the field. "*" in lead position means access to the message header.
    
    Returns:
    
    Id or 0 (zero) if the field not found.

Interface IMessageSchema

Method Summary

Method Detail

getPackage

getId

getVersion

getSemanticVersion

isLittleEndian

getDescription

getFrameHeaderSize

isMdp3Mode

getHeaderType

getType

getMessages

queryVirtualFieldId