Package org.jivesoftware.smackx.search
Class ReportedData
- java.lang.Object
-
- org.jivesoftware.smackx.search.ReportedData
-
public class ReportedData extends java.lang.Object
Represents a set of data results returned as part of a search. The report is structured in columns and rows.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ReportedData.Column
Represents the columns definition of the reported data.static class
ReportedData.Field
static class
ReportedData.Row
-
Constructor Summary
Constructors Constructor Description ReportedData()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addColumn(ReportedData.Column column)
Adds a newColumn
.void
addRow(ReportedData.Row row)
Adds a newRow
.java.util.List<ReportedData.Column>
getColumns()
Returns a List of the columns returned from a search.static ReportedData
getReportedDataFrom(Stanza packet)
Returns a new ReportedData if the stanza is used for reporting data and includes an extension that matches the elementName and namespace "x","jabber:x:data".java.util.List<ReportedData.Row>
getRows()
Returns a List of the rows returned from a search.java.lang.String
getTitle()
Returns the report's title.
-
-
-
Constructor Detail
-
ReportedData
public ReportedData()
-
-
Method Detail
-
getReportedDataFrom
public static ReportedData getReportedDataFrom(Stanza packet)
Returns a new ReportedData if the stanza is used for reporting data and includes an extension that matches the elementName and namespace "x","jabber:x:data".- Parameters:
packet
- the stanza used for reporting data.- Returns:
- ReportedData from the packet if present, otherwise null.
-
addRow
public void addRow(ReportedData.Row row)
Adds a newRow
.- Parameters:
row
- the new row to add.
-
addColumn
public void addColumn(ReportedData.Column column)
Adds a newColumn
.- Parameters:
column
- the column to add.
-
getRows
public java.util.List<ReportedData.Row> getRows()
Returns a List of the rows returned from a search.- Returns:
- a List of the rows returned from a search.
-
getColumns
public java.util.List<ReportedData.Column> getColumns()
Returns a List of the columns returned from a search.- Returns:
- a List of the columns returned from a search.
-
getTitle
public java.lang.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.
-
-