org.jivesoftware.smackx
Class ReportedData

java.lang.Object
  org.jivesoftware.smackx.ReportedData

public class ReportedData
extends Object

Represents a set of data results returned as part of a search. The report is structured in columns and rows.

Author:

Gaston Dombiak

Nested Class Summary

static class	ReportedData.Column Represents the columns definition of the reported data.
static class	ReportedData.Field
static class	ReportedData.Row

Constructor Summary

ReportedData()

Method Summary

void	addColumn(ReportedData.Column column) Adds a new Column
void	addRow(ReportedData.Row row) Adds a new Row.
Iterator<ReportedData.Column>	getColumns() Returns an Iterator for the columns returned from a search.
static ReportedData	getReportedDataFrom(Packet packet) Returns a new ReportedData if the packet is used for reporting data and includes an extension that matches the elementName and namespace "x","jabber:x:data".
Iterator<ReportedData.Row>	getRows() Returns an Iterator for the rows returned from a search.
String	getTitle() Returns the report's title.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportedData

public ReportedData()

Method Detail

getReportedDataFrom

public static ReportedData getReportedDataFrom(Packet packet)

Returns a new ReportedData if the packet is used for reporting data and includes an extension that matches the elementName and namespace "x","jabber:x:data".

Parameters:

packet - the packet used for reporting data.

addRow

public void addRow(ReportedData.Row row)

Adds a new Row.

Parameters:

row - the new row to add.

addColumn

public void addColumn(ReportedData.Column column)

Adds a new Column

Parameters:

column - the column to add.

getRows

public Iterator<ReportedData.Row> getRows()

Returns an Iterator for the rows returned from a search.

Returns:

an Iterator for the rows returned from a search.

getColumns

public Iterator<ReportedData.Column> getColumns()

Returns an Iterator for the columns returned from a search.

Returns:

an Iterator for the columns returned from a search.

getTitle

public String getTitle()

Returns the report's title. It is similar to the title on a web page or an X window.

Returns:

title of the report.