Smack

org.jivesoftware.smackx
Class ReportedData

java.lang.Object
  extended by 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.Row
           
 
Method Summary
 Iterator 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 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
 

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.

getRows

public Iterator getRows()
Returns an Iterator for the rows returned from a search.

Returns:
an Iterator for the rows returned from a search.

getColumns

public Iterator 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.

Smack

Copyright © 2003 Jive Software.