EventFormatter

Overview

Package

Class

Tree

Deprecated

Index

Help

TPTP 4.5.0 Platform Project
Public API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.tptp.logging.events.cbe.util
Class EventFormatter

java.lang.Object
  org.eclipse.tptp.logging.events.cbe.util.EventFormatter

public final class EventFormatter
extends java.lang.Object
extends java.lang.Object

Utility class for converting, serializing and de-serializing CommonBaseEvents and AssociationEngines.

Conversion, serialization and de-serialization of CommonBaseEvents and AssociationEngines is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Notes:

For converting between Document Object Model (DOM) and XML documents, see the XmlUtility.serialize(org.w3c.dom.Document) and XmlUtility.deserialize(java.lang.String) methods in XmlUtility.
Some JAXP implementations (e.g. Sun's Java V1.4.x with Crimson) do not support schema validation. As such, validation in these run-time environments is not supported.

See Also:: CommonBaseEvent, AssociationEngine, FormattingException, EventListener, XmlUtility

Constructor Summary
`EventFormatter()`

Method Summary
`static AssociationEngine`	`associationEngineFromCanonicalXML(java.lang.String xmlFragmentString)` De-serializes an Association Engine XML fragment to an `AssociationEngine`.
`static AssociationEngine`	`associationEngineFromCanonicalXML(java.lang.String xmlFragmentString, boolean validate)` De-serializes an Association Engine XML fragment to an `AssociationEngine`.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(org.w3c.dom.Document document)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(org.w3c.dom.Document document, boolean validate)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(org.w3c.dom.Document document, boolean validate, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(org.w3c.dom.Document document, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(java.io.File file)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(java.io.File file, boolean validate)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(java.io.File file, boolean validate, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(java.io.File file, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource, boolean validate)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource, boolean validate, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream, boolean validate)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream, boolean validate, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocumentString)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static AssociationEngine[]`	`associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocumentString, boolean validate)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocumentString, boolean validate, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static void`	`associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocumentString, EventListener eventListener)` De-serializes Association Engine XML fragments contained in a Common Base Event XML document to `AssociationEngine`s.
`static CommonBaseEvent`	`eventFromCanonicalXML(java.lang.String xmlFragmentString)` De-serializes a Common Base Event XML fragment to a `CommonBaseEvent`.
`static CommonBaseEvent`	`eventFromCanonicalXML(java.lang.String xmlFragmentString, boolean validate)` De-serializes a Common Base Event XML fragment to a `CommonBaseEvent`.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(org.w3c.dom.Document document)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(org.w3c.dom.Document document, boolean validate)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(org.w3c.dom.Document document, boolean validate, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(org.w3c.dom.Document document, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(java.io.File file)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(java.io.File file, boolean validate)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(java.io.File file, boolean validate, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(java.io.File file, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource, boolean validate)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource, boolean validate, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(java.io.InputStream inputStream)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(java.io.InputStream inputStream, boolean validate)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(java.io.InputStream inputStream, boolean validate, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(java.io.InputStream inputStream, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(java.lang.String xmlDocumentString)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static CommonBaseEvent[]`	`eventsFromCanonicalXMLDoc(java.lang.String xmlDocumentString, boolean validate)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(java.lang.String xmlDocumentString, boolean validate, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static void`	`eventsFromCanonicalXMLDoc(java.lang.String xmlDocumentString, EventListener eventListener)` De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to `CommonBaseEvent`s.
`static java.lang.String`	`toCanonicalXMLDocString(AssociationEngine associationEngine)` Serializes an `AssociationEngine` to an Association Engine XML fragment contained in a Common Base Event XML document.
`static java.lang.String`	`toCanonicalXMLDocString(AssociationEngine[] associationEngines)` Serializes an array of `AssociationEngine`s to Association Engine XML fragments contained in a Common Base Event XML document.
`static java.lang.String`	`toCanonicalXMLDocString(AssociationEngine[] associationEngines, boolean format)` Serializes an array of `AssociationEngine`s to Association Engine XML fragments contained in a Common Base Event XML document.
`static java.lang.String`	`toCanonicalXMLDocString(AssociationEngine associationEngine, boolean format)` Serializes an `AssociationEngine` to an Association Engine XML fragment contained in a Common Base Event XML document.
`static java.lang.String`	`toCanonicalXMLDocString(CommonBaseEvent commonBaseEvent)` Serializes a `CommonBaseEvent` to a Common Base Event XML fragment contained in a Common Base Event XML document.
`static java.lang.String`	`toCanonicalXMLDocString(CommonBaseEvent[] commonBaseEvents)` Serializes an array of `CommonBaseEvent`s to Common Base Event XML fragments contained in a Common Base Event XML document.
`static java.lang.String`	`toCanonicalXMLDocString(CommonBaseEvent[] commonBaseEvents, boolean format)` Serializes an array of `CommonBaseEvent`s to Common Base Event XML fragments contained in a Common Base Event XML document.
`static java.lang.String`	`toCanonicalXMLDocString(CommonBaseEvent commonBaseEvent, boolean format)` Serializes a `CommonBaseEvent` to a Common Base Event XML fragment contained in a Common Base Event XML document.
`static java.lang.String`	`toCanonicalXMLString(AssociationEngine associationEngine)` Serializes an `AssociationEngine` to an Association Engine XML fragment.
`static java.lang.String`	`toCanonicalXMLString(CommonBaseEvent commonBaseEvent)` Serializes a `CommonBaseEvent` to a Common Base Event XML fragment.
`static java.lang.String`	`toCanonicalXMLString(CommonBaseEvent commonBaseEvent, boolean format)` Serializes a `CommonBaseEvent` to a Common Base Event XML fragment.

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

Constructor Detail

EventFormatter

public EventFormatter()

Method Detail

toCanonicalXMLDocString

public static java.lang.String toCanonicalXMLDocString(AssociationEngine associationEngine)

Serializes an AssociationEngine to an Association Engine XML fragment contained in a Common Base Event XML document.

The resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation) by default.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: associationEngine - The AssociationEngine to be serialized to an Association Engine XML fragment contained in a Common Base Event XML document.
Returns:: A Common Base Event XML document containing the serialized Association Engine XML fragment.

toCanonicalXMLDocString

public static java.lang.String toCanonicalXMLDocString(AssociationEngine[] associationEngines)

Serializes an array of AssociationEngines to Association Engine XML fragments contained in a Common Base Event XML document.

The resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation) by default.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: associationEngines - The array of AssociationEngines to be serialized to Association Engine XML fragments contained in a Common Base Event XML document.
Returns:: A Common Base Event XML document containing the serialized Association Engine XML fragments.

toCanonicalXMLDocString

public static java.lang.String toCanonicalXMLDocString(AssociationEngine associationEngine,
                                                       boolean format)

Serializes an AssociationEngine to an Association Engine XML fragment contained in a Common Base Event XML document.

The resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation) based on the format parameter.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: associationEngine - The AssociationEngine to be serialized to an Association Engine XML fragment.; format - If the resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation).
Returns:: A Common Base Event XML document containing the serialized Association Engine XML fragment.

toCanonicalXMLDocString

public static java.lang.String toCanonicalXMLDocString(AssociationEngine[] associationEngines,
                                                       boolean format)

Serializes an array of AssociationEngines to Association Engine XML fragments contained in a Common Base Event XML document.

The resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation) based on the format parameter.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: associationEngines - The array of AssociationEngines to be serialized to Association Engine XML fragments contained in a Common Base Event XML document.; format - If the resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation).
Returns:: A Common Base Event XML document containing the serialized Association Engine XML fragments.

toCanonicalXMLString

public static java.lang.String toCanonicalXMLString(AssociationEngine associationEngine)

Serializes an AssociationEngine to an Association Engine XML fragment.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: associationEngine - The AssociationEngine to be serialized to an Association Engine XML fragment.
Returns:: A serialized Association Engine XML fragment.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocumentString)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: xmlDocumentString - The string with the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocumentString,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Callers receive notification to process the de-serialized AssociationEngines through the parameter EventListener. As such, callers can process de-serialized AssociationEngines on a separate thread before this method returns, resulting in a high level of parallelism and improved efficiency. Noteworthy, callers are responsible for listener instantiation, registration and clean-up.

Parameters:: xmlDocumentString - The string with the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocumentString,
                                                                        boolean validate)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

Parameters:: xmlDocumentString - The string with the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(java.lang.String xmlDocumentString,
                                                         boolean validate,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: xmlDocumentString - The string with the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines. The Common Base Event XML document is resolved from an InputSource.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

Parameters:: inputSource - The InputSource to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines. The Common Base Event XML document is resolved from an InputSource.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputSource - The InputSource to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource,
                                                                        boolean validate)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines. The Common Base Event XML document is resolved from an InputSource.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

Parameters:: inputSource - The InputSource to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource,
                                                         boolean validate,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines. The Common Base Event XML document is resolved from an InputSource.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputSource - The InputSource to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines. The Common Base Event XML document is resolved from an InputStream.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

Parameters:: inputStream - The InputStream to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines. The Common Base Event XML document is resolved from an InputStream.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputStream - The InputStream to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream,
                                                                        boolean validate)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines. The Common Base Event XML document is resolved from an InputStream.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

Parameters:: inputStream - The InputStream to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(java.io.InputStream inputStream,
                                                         boolean validate,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines. The Common Base Event XML document is resolved from an InputStream.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputStream - The InputStream to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(org.w3c.dom.Document document)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines. The Common Base Event XML document is resolved from a Document.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

Parameters:: document - The Document to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(org.w3c.dom.Document document,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines. The Common Base Event XML document is resolved from a Document.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: document - The Document to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(org.w3c.dom.Document document,
                                                                        boolean validate)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines. The Common Base Event XML document is resolved from a Document.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

Parameters:: document - The Document to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(org.w3c.dom.Document document,
                                                         boolean validate,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines. The Common Base Event XML document is resolved from a Document.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: document - The Document to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(java.io.File file)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines. The Common Base Event XML document is resolved from a File.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

Parameters:: file - The File to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(java.io.File file,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines. The Common Base Event XML document is resolved from a File.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: file - The File to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEnginesFromCanonicalXMLDoc

public static AssociationEngine[] associationEnginesFromCanonicalXMLDoc(java.io.File file,
                                                                        boolean validate)
                                                                 throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to an array of AssociationEngines. The Common Base Event XML document is resolved from a File.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: file - The File to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to an array of AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of AssociationEngines, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEnginesFromCanonicalXMLDoc

public static void associationEnginesFromCanonicalXMLDoc(java.io.File file,
                                                         boolean validate,
                                                         EventListener eventListener)
                                                  throws FormattingException

De-serializes Association Engine XML fragments contained in a Common Base Event XML document to AssociationEngines. The Common Base Event XML document is resolved from a File.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: file - The File to resolve the Association Engine XML fragments contained in a Common Base Event XML document to be de-serialized to AssociationEngines.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized AssociationEngines.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

associationEngineFromCanonicalXML

public static AssociationEngine associationEngineFromCanonicalXML(java.lang.String xmlFragmentString)
                                                           throws FormattingException

De-serializes an Association Engine XML fragment to an AssociationEngine.

The Association Engine XML fragment is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: xmlFragmentString - The string with the Association Engine XML fragment to be de-serialized to an AssociationEngine.
Returns:: An AssociationEngine, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

associationEngineFromCanonicalXML

public static AssociationEngine associationEngineFromCanonicalXML(java.lang.String xmlFragmentString,
                                                                  boolean validate)
                                                           throws FormattingException

De-serializes an Association Engine XML fragment to an AssociationEngine.

The Association Engine XML fragment is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: xmlFragmentString - The string with the Association Engine XML fragment to be de-serialized to an AssociationEngine.; validate - If the Association Engine XML fragment is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An AssociationEngine, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

toCanonicalXMLDocString

public static java.lang.String toCanonicalXMLDocString(CommonBaseEvent commonBaseEvent)

Serializes a CommonBaseEvent to a Common Base Event XML fragment contained in a Common Base Event XML document.

The Common Base Event XML document is constructed by first serializing each of the AssociationEngines contained in each AssociatedEvent (AssociatedEvent.getAssociationEngineInfo()) for the CommonBaseEvent to an Association Engine XML fragment. Next, the CommonBaseEvent is serialized to a Common Base Event XML fragment.

The resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation) by default.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: commonBaseEvent - The CommonBaseEvent to be serialized to a Common Base Event XML fragment contained in a Common Base Event XML document.
Returns:: A Common Base Event XML document containing the serialized Common Base Event XML fragment.

toCanonicalXMLDocString

public static java.lang.String toCanonicalXMLDocString(CommonBaseEvent[] commonBaseEvents)

Serializes an array of CommonBaseEvents to Common Base Event XML fragments contained in a Common Base Event XML document.

The Common Base Event XML document is constructed by first serializing each of the AssociationEngines contained in each AssociatedEvent (AssociatedEvent.getAssociationEngineInfo()) for each of the CommonBaseEvents to an Association Engine XML fragment. Next, each CommonBaseEvent is serialized to a Common Base Event XML fragment.

The resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation) by default.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: commonBaseEvents - The array of CommonBaseEvents to be serialized to Common Base Event XML fragments contained in a Common Base Event XML document.
Returns:: A Common Base Event XML document containing the serialized Common Base Event XML fragments.

toCanonicalXMLDocString

public static java.lang.String toCanonicalXMLDocString(CommonBaseEvent commonBaseEvent,
                                                       boolean format)

Serializes a CommonBaseEvent to a Common Base Event XML fragment contained in a Common Base Event XML document.

The resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation) based on the format parameter.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: commonBaseEvent - The CommonBaseEvent to be serialized to a Common Base Event XML fragment.; format - If the resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation).
Returns:: A Common Base Event XML document containing the serialized Common Base Event XML fragment.

toCanonicalXMLDocString

public static java.lang.String toCanonicalXMLDocString(CommonBaseEvent[] commonBaseEvents,
                                                       boolean format)

Serializes an array of CommonBaseEvents to Common Base Event XML fragments contained in a Common Base Event XML document.

The Common Base Event XML document is constructed by first serializing each of the AssociationEngines contained in each AssociatedEvent (AssociatedEvent.getAssociationEngineInfo()) for each of the CommonBaseEvents to an Association Engine XML fragment. Next, each CommonBaseEvent is serialized to a Common Base Event XML fragment.

The resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation) based on the format parameter.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: commonBaseEvents - The array of CommonBaseEvents to be serialized to Common Base Event XML fragments contained in a Common Base Event XML document.; format - If the resultant Common Base Event XML document is formatted (e.g. platform-dependent new lines and indentation).
Returns:: A Common Base Event XML document containing the serialized Common Base Event XML fragments.

toCanonicalXMLString

public static java.lang.String toCanonicalXMLString(CommonBaseEvent commonBaseEvent)

Serializes a CommonBaseEvent to a Common Base Event XML fragment.

The resultant Common Base Event XML fragment is formatted (e.g. platform-dependent new lines and indentation) by default.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: commonBaseEvent - The CommonBaseEvent to be serialized to a Common Base Event XML fragment.
Returns:: A serialized Common Base Event XML fragment.

toCanonicalXMLString

public static java.lang.String toCanonicalXMLString(CommonBaseEvent commonBaseEvent,
                                                    boolean format)

Serializes a CommonBaseEvent to a Common Base Event XML fragment.

The resultant Common Base Event XML fragment is formatted (e.g. platform-dependent new lines and indentation) based on the format parameter.

Serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: commonBaseEvent - The CommonBaseEvent to be serialized to a Common Base Event XML fragment.; format - If the resultant Common Base Event XML fragment is formatted (e.g. platform-dependent new lines and indentation).
Returns:: A serialized Common Base Event XML fragment.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(java.lang.String xmlDocumentString)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: xmlDocumentString - The string with the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(java.lang.String xmlDocumentString,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Callers receive notification to process the de-serialized CommonBaseEvents through the parameter EventListener. As such, callers can process de-serialized CommonBaseEvents on a separate thread before this method returns, resulting in a high level of parallelism and improved efficiency. Noteworthy, callers are responsible for listener instantiation, registration and clean-up.

Parameters:: xmlDocumentString - The string with the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(java.lang.String xmlDocumentString,
                                                          boolean validate)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: xmlDocumentString - The string with the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(java.lang.String xmlDocumentString,
                                             boolean validate,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: xmlDocumentString - The string with the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents. The Common Base Event XML document is resolved from an InputSource.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputSource - The InputSource to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents. The Common Base Event XML document is resolved from an InputSource.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputSource - The InputSource to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource,
                                                          boolean validate)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents. The Common Base Event XML document is resolved from an InputSource.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputSource - The InputSource to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(org.xml.sax.InputSource inputSource,
                                             boolean validate,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents. The Common Base Event XML document is resolved from an InputSource.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputSource - The InputSource to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(java.io.InputStream inputStream)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents. The Common Base Event XML document is resolved from an InputStream.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputStream - The InputStream to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(java.io.InputStream inputStream,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents. The Common Base Event XML document is resolved from an InputStream.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputStream - The InputStream to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(java.io.InputStream inputStream,
                                                          boolean validate)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents. The Common Base Event XML document is resolved from an InputStream.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputStream - The InputStream to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(java.io.InputStream inputStream,
                                             boolean validate,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents. The Common Base Event XML document is resolved from an InputStream.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: inputStream - The InputStream to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(org.w3c.dom.Document document)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents. The Common Base Event XML document is resolved from a Document.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: document - The Document to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(org.w3c.dom.Document document,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents. The Common Base Event XML document is resolved from a Document.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: document - The Document to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(org.w3c.dom.Document document,
                                                          boolean validate)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents. The Common Base Event XML document is resolved from a Document.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: document - The Document to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(org.w3c.dom.Document document,
                                             boolean validate,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents. The Common Base Event XML document is resolved from a Document.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: document - The Document to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(java.io.File file)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents. The Common Base Event XML document is resolved from a File.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: file - The File to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(java.io.File file,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents. The Common Base Event XML document is resolved from a File.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: file - The File to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventsFromCanonicalXMLDoc

public static CommonBaseEvent[] eventsFromCanonicalXMLDoc(java.io.File file,
                                                          boolean validate)
                                                   throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to an array of CommonBaseEvents. The Common Base Event XML document is resolved from a File.

The Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: file - The File to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to an array of CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: An array of CommonBaseEvents, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventsFromCanonicalXMLDoc

public static void eventsFromCanonicalXMLDoc(java.io.File file,
                                             boolean validate,
                                             EventListener eventListener)
                                      throws FormattingException

De-serializes Common Base Event XML fragments contained in a Common Base Event XML document to CommonBaseEvents. The Common Base Event XML document is resolved from a File.

The Common Base Event XML document is not validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: file - The File to resolve the Common Base Event XML fragments contained in a Common Base Event XML document to be de-serialized to CommonBaseEvents.; validate - If the Common Base Event XML document is validated using the Common Base Event V1.0.1 schema (XSD).; eventListener - A non-null EventListener to be receive notification to process de-serialized CommonBaseEvents.
Throws:: FormattingException - A de-serialization error has occurred.
See Also:: EventListener
Provisional API: This API is subject to change in the next release.: As of TPTP v4.2.0, this method is marked as 'provisional'.

eventFromCanonicalXML

public static CommonBaseEvent eventFromCanonicalXML(java.lang.String xmlFragmentString)
                                             throws FormattingException

De-serializes a Common Base Event XML fragment to a CommonBaseEvent.

The Common Base Event XML fragment is not validated using the Common Base Event V1.0.1 schema (XSD) by default.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: xmlFragmentString - The string with the Common Base Event XML fragment to be de-serialized to a CommonBaseEvent.
Returns:: A CommonBaseEvent, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

eventFromCanonicalXML

public static CommonBaseEvent eventFromCanonicalXML(java.lang.String xmlFragmentString,
                                                    boolean validate)
                                             throws FormattingException

De-serializes a Common Base Event XML fragment to a CommonBaseEvent.

The Common Base Event XML fragment is not validated using the Common Base Event V1.0.1 schema (XSD) based on the validate parameter.

De-serialization is based on the Common Base Event Situation Data Specification v1.0.1 and the Common Base Event XML schema.

Parameters:: xmlFragmentString - The string with the Common Base Event XML fragment to be de-serialized to a CommonBaseEvent.; validate - If the Common Base Event XML fragment is validated using the Common Base Event V1.0.1 schema (XSD).
Returns:: A CommonBaseEvent, otherwise null.
Throws:: FormattingException - A de-serialization error has occurred.

Overview

Package

Class

Tree

Deprecated

Index

Help

TPTP 4.5.0 Platform Project
Public API Specification

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.tptp.logging.events.cbe.util Class EventFormatter

EventFormatter

toCanonicalXMLDocString

toCanonicalXMLDocString

toCanonicalXMLDocString

toCanonicalXMLDocString

toCanonicalXMLString

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEnginesFromCanonicalXMLDoc

associationEngineFromCanonicalXML

associationEngineFromCanonicalXML

toCanonicalXMLDocString

toCanonicalXMLDocString

toCanonicalXMLDocString

toCanonicalXMLDocString

toCanonicalXMLString

toCanonicalXMLString

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventsFromCanonicalXMLDoc

eventFromCanonicalXML

eventFromCanonicalXML

org.eclipse.tptp.logging.events.cbe.util
Class EventFormatter