com.hcl.domino.keep.dbfunctions

Class ItemJsonHelper

java.lang.Object

com.hcl.domino.keep.dbfunctions.ItemJsonHelper

public class ItemJsonHelper
extends java.lang.Object

Helper class to convert Items from a Domino document into their value suitable for inclusion in JSON

Method Summary

Modifier and Type	Method and Description
static io.vertx.core.json.JsonArray	fromList(com.hcl.domino.data.Item item) Converts TYPE_TEXT_LIST and TYPE_NUMBER_RANGE to a JsonArray
static java.lang.String	fromRichText(com.hcl.domino.DominoClient client, com.hcl.domino.data.Document doc, java.lang.String itemName) Converts a RichText Item into HTML or errors with null when item doesn’t exist or is not RichText
static java.lang.Object	fromTextOrJson(com.hcl.domino.data.Item item) Converts a TYPE_TEXT item into text or when it looks like JSON into a JSON Object or array
static java.lang.String	fromTime(com.hcl.domino.data.Item item) Converts item into a ISO date-time string
static io.vertx.core.json.JsonArray	fromTimeRange(com.hcl.domino.data.Item item) Converts a time range into a Json Array A time range can contain discrete values or ranges again
static java.lang.Object	fromUnknown(com.hcl.domino.data.Item item) Converts unknown Domino data on a best effort basis
static java.lang.Object	itemDataTypeMapper(java.lang.Object incoming) Boils down the item data type to those that are supported by JsonObject

Methods inherited from class java.lang.Object

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

Method Detail

fromList

public static io.vertx.core.json.JsonArray fromList(com.hcl.domino.data.Item item)

Converts TYPE_TEXT_LIST and TYPE_NUMBER_RANGE to a JsonArray

Parameters:

item - Domino Item to convert

Returns:

JsonArray with values

fromRichText

public static java.lang.String fromRichText(com.hcl.domino.DominoClient client,
                                            com.hcl.domino.data.Document doc,
                                            java.lang.String itemName)

Converts a RichText Item into HTML or errors with null when item doesn’t exist or is not RichText

Parameters:

client - Domino client to run the conversion

doc - Domino document containing the item

itemName - itemName (conversion doesn’t need item itself)

Returns:

String - converted HTML

fromTextOrJson

public static java.lang.Object fromTextOrJson(com.hcl.domino.data.Item item)

Converts a TYPE_TEXT item into text or when it looks like JSON into a JSON Object or array

Parameters:

item - Domino Item

Returns:

text if it is a String or JSON if it looks and smells like JSON

fromTime

public static java.lang.String fromTime(com.hcl.domino.data.Item item)

Converts item into a ISO date-time string

Parameters:

item - Domino item containing date

Returns:

ISO Date string

fromTimeRange

public static io.vertx.core.json.JsonArray fromTimeRange(com.hcl.domino.data.Item item)

Converts a time range into a Json Array A time range can contain discrete values or ranges again

Parameters:

item - TimeRange item

Returns:

JsonArray with ISA values

fromUnknown

public static java.lang.Object fromUnknown(com.hcl.domino.data.Item item)

Converts unknown Domino data on a best effort basis

Parameters:

item - Domino Item

Returns:

scalar value or a JsonArray

itemDataTypeMapper

public static java.lang.Object itemDataTypeMapper(java.lang.Object incoming)

Boils down the item data type to those that are supported by JsonObject

Parameters:

incoming - original object

Returns:

same object if supported, String if not