uk.co.real_logic.sbe.xml

Class XmlSchemaParser

java.lang.Object

uk.co.real_logic.sbe.xml.XmlSchemaParser

public class XmlSchemaParser
extends java.lang.Object

Encapsulate the XML Schema parsing for SBE so that other representations may be used to generate independent representations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPOSITE_XPATH_EXPR
static java.lang.String	ENUM_XPATH_EXPR
static java.lang.String	ERROR_HANDLER_KEY Key for storing ErrorHandler as user data in XML document
static java.lang.String	MESSAGE_SCHEMA_XPATH_EXPR
static java.lang.String	MESSAGE_XPATH_EXPR
static java.lang.String	SET_XPATH_EXPR
static java.lang.String	TYPE_XPATH_EXPR

Constructor Summary

Constructors

Constructor and Description
XmlSchemaParser()

Method Summary

Modifier and Type	Method and Description
static void	checkForValidName(org.w3c.dom.Node node, java.lang.String name) Check name against validity for C++ and Java naming.
static java.util.Map<java.lang.Long,Message>	findMessages(org.w3c.dom.Document document, javax.xml.xpath.XPath xPath, java.util.Map<java.lang.String,Type> typeByNameMap) Scan XML for all message definitions and save in map
static java.util.Map<java.lang.String,Type>	findTypes(org.w3c.dom.Document document, javax.xml.xpath.XPath xPath) Scan XML for all types (encodedDataType, compositeType, enumType, and setType) and save in map
static java.lang.String	getAttributeValue(org.w3c.dom.Node elementNode, java.lang.String attrName) Helper function that throws an exception when the attribute is not set.
static java.lang.String	getAttributeValue(org.w3c.dom.Node elementNode, java.lang.String attrName, java.lang.String defValue) Helper function that uses a default value when value not set.
static java.lang.String	getAttributeValueOrNull(org.w3c.dom.Node elementNode, java.lang.String attrName) Helper function that hides the null return from NamedNodeMap.getNamedItem(String)
static java.nio.ByteOrder	getByteOrder(java.lang.String byteOrderName) Helper function to convert a schema byteOrderName into a ByteOrder
static void	handleError(org.w3c.dom.Node node, java.lang.String msg) Handle an error condition as consequence of parsing.
static void	handleWarning(org.w3c.dom.Node node, java.lang.String msg) Handle a warning condition as a consequence of parsing.
static MessageSchema	parse(java.io.InputStream in, ParserOptions options) Take an InputStream and parse it generating map of template ID to Message objects, types, and schema.
static void	validate(java.lang.String xsdFilename, java.io.InputStream in) Validate the document against a given schema.

Methods inherited from class java.lang.Object

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

Field Detail

ERROR_HANDLER_KEY

public static final java.lang.String ERROR_HANDLER_KEY

Key for storing ErrorHandler as user data in XML document

See Also:

Constant Field Values

TYPE_XPATH_EXPR

public static final java.lang.String TYPE_XPATH_EXPR

See Also:

Constant Field Values

COMPOSITE_XPATH_EXPR

public static final java.lang.String COMPOSITE_XPATH_EXPR

See Also:

Constant Field Values

ENUM_XPATH_EXPR

public static final java.lang.String ENUM_XPATH_EXPR

See Also:

Constant Field Values

SET_XPATH_EXPR

public static final java.lang.String SET_XPATH_EXPR

See Also:

Constant Field Values

MESSAGE_SCHEMA_XPATH_EXPR

public static final java.lang.String MESSAGE_SCHEMA_XPATH_EXPR

See Also:

Constant Field Values

MESSAGE_XPATH_EXPR

public static final java.lang.String MESSAGE_XPATH_EXPR

See Also:

Constant Field Values

Constructor Detail

XmlSchemaParser

public XmlSchemaParser()

Method Detail

validate

public static void validate(java.lang.String xsdFilename,
                            java.io.InputStream in)
                     throws java.lang.Exception

Validate the document against a given schema. Error will be written to System.err

Parameters:

xsdFilename - schema to validate against.

in - document to be validated.

Throws:

java.lang.Exception - if an error occurs when parsing the document or schema.

parse

public static MessageSchema parse(java.io.InputStream in,
                                  ParserOptions options)
                           throws java.lang.Exception

Take an InputStream and parse it generating map of template ID to Message objects, types, and schema.

Exceptions are passed back up for any problems.

Parameters:

in - stream from which schema is read.

options - to be applied during parsing.

Returns:

MessageSchema encoding for the schema.

Throws:

java.lang.Exception - on parsing error.

findTypes

public static java.util.Map<java.lang.String,Type> findTypes(org.w3c.dom.Document document,
                                                             javax.xml.xpath.XPath xPath)
                                                      throws java.lang.Exception

Scan XML for all types (encodedDataType, compositeType, enumType, and setType) and save in map

Parameters:

document - for the XML parsing

xPath - for XPath expression reuse

Returns:

Map of name String to Type

Throws:

java.lang.Exception - on parsing error.

findMessages

public static java.util.Map<java.lang.Long,Message> findMessages(org.w3c.dom.Document document,
                                                                 javax.xml.xpath.XPath xPath,
                                                                 java.util.Map<java.lang.String,Type> typeByNameMap)
                                                          throws java.lang.Exception

Scan XML for all message definitions and save in map

Parameters:

document - for the XML parsing

xPath - for XPath expression reuse

typeByNameMap - to use for Type objects

Returns:

Map of schemaId to Message

Throws:

java.lang.Exception - on parsing error.

handleError

public static void handleError(org.w3c.dom.Node node,
                               java.lang.String msg)

Handle an error condition as consequence of parsing.

Parameters:

node - that is the context of the warning.

msg - associated with the error.

handleWarning

public static void handleWarning(org.w3c.dom.Node node,
                                 java.lang.String msg)

Handle a warning condition as a consequence of parsing.

Parameters:

node - as the context for the warning.

msg - associated with the warning.

getAttributeValue

public static java.lang.String getAttributeValue(org.w3c.dom.Node elementNode,
                                                 java.lang.String attrName)

Helper function that throws an exception when the attribute is not set.

Parameters:

elementNode - that should have the attribute

attrName - that is to be looked up

Returns:

value of the attribute

Throws:

java.lang.IllegalArgumentException - if the attribute is not present

getAttributeValue

public static java.lang.String getAttributeValue(org.w3c.dom.Node elementNode,
                                                 java.lang.String attrName,
                                                 java.lang.String defValue)

Helper function that uses a default value when value not set.

Parameters:

elementNode - that should have the attribute

attrName - that is to be looked up

defValue - String to return if not set

Returns:

value of the attribute or defValue

getAttributeValueOrNull

public static java.lang.String getAttributeValueOrNull(org.w3c.dom.Node elementNode,
                                                       java.lang.String attrName)

Helper function that hides the null return from NamedNodeMap.getNamedItem(String)

Parameters:

elementNode - that could be null

attrName - that is to be looked up

Returns:

null or value of the attribute

getByteOrder

public static java.nio.ByteOrder getByteOrder(java.lang.String byteOrderName)

Helper function to convert a schema byteOrderName into a ByteOrder

Parameters:

byteOrderName - specified as a FIX SBE string

Returns:

ByteOrder representation

checkForValidName

public static void checkForValidName(org.w3c.dom.Node node,
                                     java.lang.String name)

Check name against validity for C++ and Java naming. Warning if not valid.

Parameters:

node - to have the name checked.

name - of the node to be checked.