org.symphonyoss.symphony.messageml

Class MessageMLContext

java.lang.Object

org.symphonyoss.symphony.messageml.MessageMLContext

public class MessageMLContext
extends Object

The main entry point for parsing string message data in MessageML or Markdown formats and associated JSON entity data into MessageML document trees and converting them to output formats (PresentationML and Markdown). To generate a messageML tree, use one of parseMessageML() or parseMarkdown(). Once the message has been parsed, use one of the get() methods to retrieve the desired output format.

Since:

3/21/17

Author:

lukasz

Constructor Summary

Constructors

Constructor and Description
MessageMLContext(IDataProvider dataProvider)

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getEntities() Retrieve message entities (tags, mentions, urls) in the legacy JSON format.
com.fasterxml.jackson.databind.node.ObjectNode	getEntityJson() Retrieve a JSON representation of entity data (EntityJSON).
String	getMarkdown() Retrieve a string representation of the message in Markdown.
MessageML	getMessageML() Retrieve the MessageML document tree.
String	getPresentationML() Retrieve a string representation of the message in PresentationML.
String	getText() Retrieve a string representation of the message by getting the values of its PresentationML elements.
String	getText(boolean preserveWhitespace) Retrieve a string representation of the message by getting the values of its PresentationML elements.
void	parseMarkdown(String message, com.fasterxml.jackson.databind.JsonNode entities, com.fasterxml.jackson.databind.JsonNode media) Parse a Markdown message into its MessageMLV2 representation.
void	parseMessageML(String message, String entityJson, String version) Parse the text contents of the message and optionally EntityJSON into a MessageMLV2 message.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageMLContext

public MessageMLContext(IDataProvider dataProvider)

Method Detail

parseMessageML

public void parseMessageML(String message,
                           String entityJson,
                           String version)
                    throws InvalidInputException,
                           IOException,
                           ProcessingException

Parse the text contents of the message and optionally EntityJSON into a MessageMLV2 message. Expands Freemarker templates and generates document tree structures for serialization into output formats with the respective get() methods.

Parameters:

message - string containing a MessageMLV2 message with optional Freemarker templates

entityJson - string containing EntityJSON data

version - string containing the version of the message format

Throws:

InvalidInputException - thrown on invalid MessageMLV2 input

ProcessingException - thrown on errors generating the document tree

IOException - thrown on invalid EntityJSON input

parseMarkdown

public void parseMarkdown(String message,
                          com.fasterxml.jackson.databind.JsonNode entities,
                          com.fasterxml.jackson.databind.JsonNode media)
                   throws InvalidInputException

Parse a Markdown message into its MessageMLV2 representation. Generates document tree structures for serialization into output formats with the respective get() methods.

Parameters:

message - string containing a message in Markdown

entities - additional entity data in JSON

Throws:

InvalidInputException

getMessageML

public MessageML getMessageML()
                       throws IllegalStateException

Retrieve the MessageML document tree.

Throws:

IllegalStateException - thrown if the message hasn't been parsed yet

getPresentationML

public String getPresentationML()
                         throws IllegalStateException

Retrieve a string representation of the message in PresentationML.

Throws:

IllegalStateException - thrown if the message hasn't been parsed yet

getEntityJson

public com.fasterxml.jackson.databind.node.ObjectNode getEntityJson()

Retrieve a JSON representation of entity data (EntityJSON).

getMarkdown

public String getMarkdown()
                   throws IllegalStateException

Retrieve a string representation of the message in Markdown.

Throws:

IllegalStateException - thrown if the message hasn't been parsed yet

getEntities

public com.fasterxml.jackson.databind.JsonNode getEntities()
                                                    throws IllegalStateException

Retrieve message entities (tags, mentions, urls) in the legacy JSON format.

Throws:

IllegalStateException - thrown if the message hasn't been parsed yet

getText

public String getText()
               throws InvalidInputException,
                      ProcessingException,
                      IllegalStateException

Retrieve a string representation of the message by getting the values of its PresentationML elements. This method returns Node.getTextContent() of the top-level document tree.

Throws:

IllegalStateException - thrown if the message hasn't been parsed yet

InvalidInputException

ProcessingException

getText

public String getText(boolean preserveWhitespace)
               throws InvalidInputException,
                      ProcessingException,
                      IllegalStateException

Retrieve a string representation of the message by getting the values of its PresentationML elements. This method returns Node.getTextContent() of each individual element of the tree, separated by a single space

Parameters:

preserveWhitespace - if false, trims the leading and trailing whitespce of each element

Throws:

IllegalStateException - thrown if the message hasn't been parsed yet

InvalidInputException

ProcessingException