org.jivesoftware.smackx.search

Class ReportedData.Column

java.lang.Object

org.jivesoftware.smackx.search.ReportedData.Column

Enclosing class:

ReportedData

public static class ReportedData.Column
extends Object

Represents the columns definition of the reported data.

Constructor Summary

Constructors

Constructor and Description
ReportedData.Column(String label, String variable, String type) Creates a new column with the specified definition.

Method Summary

Methods

Modifier and Type	Method and Description
String	getLabel() Returns the column's label.
String	getType() Returns the column's data format.
String	getVariable() Returns the variable name that the column is showing.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportedData.Column

public ReportedData.Column(String label,
                   String variable,
                   String type)

Creates a new column with the specified definition.

Parameters:

label - the columns's label.

variable - the variable name of the column.

type - the format for the returned data.

Method Detail

getLabel

public String getLabel()

Returns the column's label.

Returns:

label of the column.

getType

public String getType()

Returns the column's data format. Valid formats are:

• text-single -> single line or word of text
• text-private -> instead of showing the user what they typed, you show ***** to protect it
• text-multi -> multiple lines of text entry
• list-single -> given a list of choices, pick one
• list-multi -> given a list of choices, pick one or more
• boolean -> 0 or 1, true or false, yes or no. Default value is 0
• fixed -> fixed for putting in text to show sections, or just advertise your web site in the middle of the form
• hidden -> is not given to the user at all, but returned with the questionnaire
• jid-single -> Jabber ID - choosing a JID from your roster, and entering one based on the rules for a JID.
• jid-multi -> multiple entries for JIDs

Returns:

format for the returned data.

getVariable

public String getVariable()

Returns the variable name that the column is showing.

Returns:

the variable name of the column.