EventParser (eda-eventtypestore 9.8.0-v0248 API)

All Superinterfaces:

Separable
```
public interface EventParser
extends Separable
```
Fast SAX based parser for XML events.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBody()` Returns the event body.
`java.util.Map<java.lang.String,java.lang.String>`	`getFilterableProperties()` Returns a name to value map of the filterable elements.
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()` Returns a name to value map of the event headers including custom ones.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` Returns a name to value map of the leaf elements.
`void`	`ignoreBodyRootName()` If enabled, the property names returned by `getProperties()` or `getFilterableProperties()` will not start with the body root element name.
`void`	`parse(SchemaElementTree schemaDefinition, java.lang.String event, boolean validate)` Parses the event against the specified schema definition.
`void`	`setHeadersPrefix(java.lang.String prefix)` If specified, the header names returned by `getHeaders()` will be prefixed with the specified value.
`void`	`validate(SchemaElementTree schemaDefinition, java.lang.String event)` Validates the provided event `content` against the specified `schemaDefinition`.

Methods inherited from interface com.softwareag.eda.store.api.parser.Separable
getSeparator, setSeparator

- Method Detail
  - setHeadersPrefix
```
void setHeadersPrefix(java.lang.String prefix)
```
    If specified, the header names returned by getHeaders() will be prefixed with the specified value.
    
    Parameters:
    prefix - will be used to prefix header names
  - ignoreBodyRootName
```
void ignoreBodyRootName()
```
    If enabled, the property names returned by getProperties() or getFilterableProperties() will not start with the body root element name. Consider the following event body:
```
 <Body>
      <PartInventoryLow xmlns="http://namespaces.softwareag.com/EDA/WebM/Sample/InventoryMgmt/1.0">
          <Part>
              <ItemID>itemID</ItemID>
              <ItemName>itemName</ItemName>
              <Model>model</Model>
              <Color>color</Color>
              <Shape>shape</Shape>
          </Part>
          <InventoryLevel>2</InventoryLevel>
          <DesiredInventoryLevel>1</DesiredInventoryLevel>
      </PartInventoryLow>
  </Body>
 
```
    The properties map entry corresponding to the ItemID element would be Part$ItemID=itemID instead of PartInventoryLow$Part$ItemID=itemID.
  - getBody
```
java.lang.String getBody()
```
    Returns the event body.
    
    Returns:
    event body extracted from the event XML
  - getHeaders
```
java.util.Map<java.lang.String,java.lang.String> getHeaders()
```
    Returns a name to value map of the event headers including custom ones.
    
    Returns:
    a name to value map of the event headers
  - getProperties
```
java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Returns a name to value map of the leaf elements. Note that attributes are considered properties.
    
    NB If multiple elements with the same path and name are present in the event XML, the last occurrence of the element is honoured and its value is added to the properties map.
    
    Returns:
    a name to value map of the leaf elements
  - getFilterableProperties
```
java.util.Map<java.lang.String,java.lang.String> getFilterableProperties()
```
    Returns a name to value map of the filterable elements.
    
    NB If multiple filterable elements with the same path and name are present in the event XML, the last occurrence of the element is honoured and its value is added to the properties map.
    
    Returns:
    a name to value map of the filterable elements
  - validate
```
void validate(SchemaElementTree schemaDefinition,
            java.lang.String event)
              throws EventParserException
```
    Validates the provided event content against the specified schemaDefinition. If the validation fails, an EventParserException exception is thrown.
    
    Parameters:
    schemaDefinition - represents the XML schema of the event to be validated
    event - content of the XML event
    
    Throws:
    
    EventParserException - gets thrown if the validation is unsuccessful
  - parse
```
void parse(SchemaElementTree schemaDefinition,
         java.lang.String event,
         boolean validate)
           throws EventParserException
```
    Parses the event against the specified schema definition.
    
    Parameters:
    schemaDefinition - represents the XML schema of the event to be parsed
    event - content of the XML event
    validate - enables validation of the XML event against the specified XML schema defnition
    
    Throws:
    
    EventParserException

Interface EventParser

Method Summary

Methods inherited from interface com.softwareag.eda.store.api.parser.Separable

Method Detail

setHeadersPrefix

ignoreBodyRootName

getBody

getHeaders

getProperties

getFilterableProperties

validate

parse