org.apache.juneau.dto.cognos

Class DataSet

java.lang.Object

org.apache.juneau.dto.cognos.DataSet

@Bean(typeName="dataset",
      bpi="metadata,data")
public class DataSet
extends Object

Represents a Cognos dataset.

When serialized to XML, creates the following construct (example pulled from AddressBookResource):

<?xml version='1.0' encoding='UTF-8'?> <c:dataset xmlns:c='http://developer.cognos.com/schemas/xmldata/1/'> <c:metadata> <c:item name='name' type='xs:String' length='255'/> <c:item name='age' type='xs:int'/> <c:item name='numAddresses' type='xs:int'/> </c:metadata> <c:data> <c:row> <c:value>Barack Obama</c:value> <c:value>52</c:value> <c:value>2</c:value> </c:row> <c:row> <c:value>George Walker Bush</c:value> <c:value>67</c:value> <c:value>2</c:value> </c:row> </c:data> </c:dataset>

Only 2-dimensional POJOs (arrays or collections of maps or beans) can be serialized to Cognos.

Example:

The construct shown above is a serialized AddressBook object which is a subclass of LinkedList<Person>. The code for generating the XML is as follows...

Column[] items = { new Column("name", "xs:String", 255), new Column("age", "xs:int"), new Column("numAddresses", "xs:int") .addPojoSwap( new PojoSwap<Person,Integer>() { @Override public Integer swap(Person p) { return p.addresses.size(); } } ) }; DataSet ds = new DataSet(items, addressBook, BeanContext.DEFAULT); String xml = XmlSerializer.DEFAULT_SQ.serialize(ds);

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSet.Row Represents a row of data.

Constructor Summary

Constructors

Constructor and Description
DataSet() Bean constructor.
DataSet(Column[] columns, Object o, BeanSession session) Constructor.

Method Summary

Modifier and Type	Method and Description
List<DataSet.Row>	getData() Bean property getter: data.
Column[]	getMetaData() Bean property getter: metadata.
DataSet	setData(List<DataSet.Row> data) Bean property setter: data.
DataSet	setMetaData(Column[] metaData) Bean property setter: metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSet

public DataSet()

Bean constructor.

DataSet

public DataSet(Column[] columns,
               Object o,
               BeanSession session)
        throws Exception

Constructor.

Parameters:

columns - The meta-data that represents the columns in the dataset.

o - The POJO being serialized to Cognos. Must be an array/collection of beans/maps.

session - The bean session used to convert POJOs to strings.

Throws:

Exception - An error occurred trying to serialize the POJO.

Method Detail

getMetaData

@Beanp(value="metadata")
public Column[] getMetaData()

Bean property getter: metadata.

Returns:

The value of the metadata property on this bean, or null if it is not set.

setMetaData

@Beanp(value="metadata")
public DataSet setMetaData(Column[] metaData)

Bean property setter: metadata.

Parameters:

metaData - The new value for the metadata property on this bean.

Returns:

This object (for method chaining).

getData

@Beanp(value="data")
public List<DataSet.Row> getData()

Bean property getter: data.

Returns:

The value of the data property on this bean, or null if it is not set.

setData

@Beanp(value="data")
public DataSet setData(List<DataSet.Row> data)

Bean property setter: data.

Parameters:

data - The new value for the data property on this bean.

Returns:

This object (for method chaining).