biz.onixs.sbe.def

Class MessageSchema

java.lang.Object

biz.onixs.sbe.def.MessageSchema

All Implemented Interfaces:

IMessageSchema

public class MessageSchema
extends Object
implements IMessageSchema

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageSchema.Endianess

Field Summary

Fields

Modifier and Type	Field and Description
static String	LICENSE_DIRECTORY_DEFAULT
static String	LICENSE_FILE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
MessageSchema(Document xmlSchema) Constructs object by XML template.
MessageSchema(Document xmlSchema, boolean isMdp3) Construct schema to use with CME specifications.
MessageSchema(Document xmlSchema, FramingHeaderPolicy framingHeaderPolicy) Constructs object by XML template.

Method Summary

Modifier and Type	Method and Description
void	addMessage(UnifiedMetaData message)
void	buildVirtualFields()
UnifiedMetaData	findType(Function<UnifiedMetaData,Boolean> condition)
String	getDescription() Returns schema description of the schema.
MessageSchema.Endianess	getEndianess()
int	getFrameHeaderSize() Returns size of the frame header.
FramingHeaderSpecification	getFramingHeaderSpecification()
UnifiedMetaData	getHeaderType() Returns definition of messages header type.
String	getHeaderTypeName()
int	getId() Returns schema id.
static String	getLicense() Gets license content.
static String	getLicenseDirectory() Gets path to the license file directory.
LocalDate	getLicenseExpirationDate() Gets license expiration date.
static String	getLicenseFile() Gets path to the license file.
Map<Integer,UnifiedMetaData>	getMessages() Gets map of all messages in the schema.
Map<String,UnifiedMetaData>	getMessagesByNames()
String	getPackage() Returns schema name.
String	getPackageName()
UnifiedMetaData	getResolvedHeaderType()
String	getSemanticVersion() Returns the semantic version of the schema.
UnifiedMetaData	getType(String name) Gets type from schema dictionary.
Map<String,UnifiedMetaData>	getTypes()
int	getVersion() Returns schema version.
boolean	isLittleEndian() Returns byte order.
boolean	isMdp3Mode() Returns CME MDP3 mode.
int	queryVirtualFieldId(String[] fieldPath) Query virtual field ID.
void	recognizeTypes()
void	resolveHeaders()
void	resolveInternalLinks()
void	resolveOffsets()
void	resolveValues()
static void	setLicense(String license) Sets license content.
static void	setLicenseDirectory(String licenseDirectory) Sets path to the license file directory.
static void	setLicenseFile(String licenseFile) Sets path to the license file.
void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

LICENSE_DIRECTORY_DEFAULT

public static final String LICENSE_DIRECTORY_DEFAULT

See Also:

Constant Field Values

LICENSE_FILE_DEFAULT

public static final String LICENSE_FILE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

MessageSchema

public MessageSchema(Document xmlSchema,
                     boolean isMdp3)
              throws LicenseException

Construct schema to use with CME specifications.

Parameters:

xmlSchema - CME SBE template schema.

isMdp3 - true for MDP3 templates, false - for iLink3 templates.

Throws:

LicenseException - if the license not found.

MessageSchema

public MessageSchema(Document xmlSchema)
              throws LicenseException

Constructs object by XML template.

Parameters:

xmlSchema - XML document with SBE template.

Throws:

LicenseException - if valid license not found.

MessageSchema

public MessageSchema(Document xmlSchema,
                     FramingHeaderPolicy framingHeaderPolicy)
              throws LicenseException

Constructs object by XML template.

Parameters:

xmlSchema - XML document with SBE template.

framingHeaderPolicy - framing header creating policy.

Throws:

LicenseException - if valid license not found.

Method Detail

getLicenseDirectory

public static String getLicenseDirectory()

Gets path to the license file directory. By default, it is set to LICENSE_DIRECTORY_DEFAULT directory.

Returns:

path to directory.

setLicenseDirectory

public static void setLicenseDirectory(String licenseDirectory)

Sets path to the license file directory. By default, it is set to LICENSE_DIRECTORY_DEFAULT directory.

Parameters:

licenseDirectory - path to directory.

getLicenseFile

public static String getLicenseFile()

Gets path to the license file. By default, it is set to LICENSE_FILE_DEFAULT.

Returns:

path to file.

setLicenseFile

public static void setLicenseFile(String licenseFile)

Sets path to the license file. By default, it is set to LICENSE_FILE_DEFAULT.

Parameters:

licenseFile - path to file.

getLicense

public static String getLicense()

Gets license content.

Returns:

license content.

setLicense

public static void setLicense(String license)

Sets license content.

Parameters:

license - license content.

getLicenseExpirationDate

public LocalDate getLicenseExpirationDate()

Gets license expiration date.

Returns:

license expiration date.

getPackageName

public String getPackageName()

getVersion

public int getVersion()

Description copied from interface: IMessageSchema

Returns schema version.

Specified by:

getVersion in interface IMessageSchema

Returns:

version of the schema

getDescription

public String getDescription()

Description copied from interface: IMessageSchema

Returns schema description of the schema.

Specified by:

getDescription in interface IMessageSchema

Returns:

description of the schema

getFrameHeaderSize

public int getFrameHeaderSize()

Description copied from interface: IMessageSchema

Returns size of the frame header.

Specified by:

getFrameHeaderSize in interface IMessageSchema

Returns:

frame header size

isMdp3Mode

public boolean isMdp3Mode()

Description copied from interface: IMessageSchema

Returns CME MDP3 mode.

Specified by:

isMdp3Mode in interface IMessageSchema

Returns:

true if schema is for CME MDP3, false otherwise.

getHeaderType

public UnifiedMetaData getHeaderType()

Description copied from interface: IMessageSchema

Returns definition of messages header type. Default value is messageHeader.

Specified by:

getHeaderType in interface IMessageSchema

Returns:

messages header type definition

getEndianess

public MessageSchema.Endianess getEndianess()

isLittleEndian

public boolean isLittleEndian()

Description copied from interface: IMessageSchema

Returns byte order. Default is little endian.

Specified by:

isLittleEndian in interface IMessageSchema

Returns:

true if byte order is littleEndian (x86), false otherwise

getSemanticVersion

public String getSemanticVersion()

Description copied from interface: IMessageSchema

Returns the semantic version of the schema.

Specified by:

getSemanticVersion in interface IMessageSchema

Returns:

semantic version of the schema

getPackage

public String getPackage()

Description copied from interface: IMessageSchema

Returns schema name.

Specified by:

getPackage in interface IMessageSchema

Returns:

name of the schema

getId

public int getId()

Description copied from interface: IMessageSchema

Returns schema id. A unique identifier of a schema.

Specified by:

getId in interface IMessageSchema

Returns:

id of the schema

getTypes

public Map<String,UnifiedMetaData> getTypes()

getMessagesByNames

public Map<String,UnifiedMetaData> getMessagesByNames()

getHeaderTypeName

public String getHeaderTypeName()

getType

public UnifiedMetaData getType(String name)

Description copied from interface: IMessageSchema

Gets type from schema dictionary.

Specified by:

getType in interface IMessageSchema

Parameters:

name - name of a type in schema type dictionary

Returns:

type definition if type present in the schema, null otherwise

getMessages

public Map<Integer,UnifiedMetaData> getMessages()

Description copied from interface: IMessageSchema

Gets map of all messages in the schema.

Specified by:

getMessages in interface IMessageSchema

Returns:

map of all messages

getResolvedHeaderType

public UnifiedMetaData getResolvedHeaderType()

getFramingHeaderSpecification

public FramingHeaderSpecification getFramingHeaderSpecification()

addMessage

public void addMessage(UnifiedMetaData message)

resolveInternalLinks

public void resolveInternalLinks()

recognizeTypes

public void recognizeTypes()

buildVirtualFields

public void buildVirtualFields()

resolveOffsets

public void resolveOffsets()

resolveValues

public void resolveValues()

findType

public UnifiedMetaData findType(Function<UnifiedMetaData,Boolean> condition)

resolveHeaders

public void resolveHeaders()

validate

public void validate()

queryVirtualFieldId

public int queryVirtualFieldId(String[] fieldPath)

Description copied from interface: IMessageSchema

Query virtual field ID.

Specified by:

queryVirtualFieldId in interface IMessageSchema

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.