org.adroitlogic.x.feature.db

Class DBResultsSetFormat

java.lang.Object

org.adroitlogic.x.feature.db.DBResultsSetFormat

All Implemented Interfaces:

org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>>

public class DBResultsSetFormat
extends Object
implements org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>>

DBResultsSetFormat is used to include the database result in XMessage.

Since:

17.01

Author:

Dulaj Atapattu

Constructor Summary

Constructors

Constructor and Description
DBResultsSetFormat(List<Map<String,Object>> content)

Method Summary

Modifier and Type	Method and Description
org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>>	copyOf()
List<Map<String,Object>>	readAsNative()
InputStream	readAsStream()
String	readAsString(int maxNoOfItems) Returns the json representation of the result set retrieved from the database.
long	size() Returns the total number of items of the result set retrieved from the database.
void	writeTo(OutputStream outputStream)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.adroitlogic.x.api.XMessageFormat

markAsAttachedToaMessage, releaseResources

Constructor Detail

DBResultsSetFormat

public DBResultsSetFormat(List<Map<String,Object>> content)

Method Detail

readAsStream

public InputStream readAsStream()

Specified by:

readAsStream in interface org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>>

readAsString

public String readAsString(int maxNoOfItems)

Returns the json representation of the result set retrieved from the database.

Specified by:

readAsString in interface org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>>

Parameters:

maxNoOfItems - - Max no of items to be included in the json string. Pass -1 to read all items.

Returns:

- Json formatted string

readAsNative

public List<Map<String,Object>> readAsNative()

Specified by:

readAsNative in interface org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>>

writeTo

public void writeTo(OutputStream outputStream)
             throws IOException

Specified by:

writeTo in interface org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>>

Throws:

IOException

copyOf

public org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>> copyOf()

Specified by:

copyOf in interface org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>>

size

public long size()

Returns the total number of items of the result set retrieved from the database.

Specified by:

size in interface org.adroitlogic.x.api.XMessageFormat<List<Map<String,Object>>>

Returns:

- Number of items in the content.