DataForm (Tinder XMPP library 1.3.0 API)

java.lang.Object
- org.xmpp.packet.PacketExtension
- - org.xmpp.forms.DataForm

```
@NotThreadSafe
public class DataForm
extends PacketExtension
```
Represents a form that could be use for gathering data as well as for reporting data returned from a search.
The form could be of the following types:
- form -> Indicates a form to fill out.
- submit -> The form is filled out, and this is the data that is being returned from the form.
- cancel -> The form was cancelled. Tell the asker that piece of information.
- result -> Data results being returned from a search, or some other query.
In case the form represents a search, the report will be structured in columns and rows. Use addReportedField(String,String,FormField.Type) to set the columns of the report whilst the report's rows can be configured using addItemFields(Map).
Author:

Gaston Dombiak

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataForm.Type
Type-safe enumeration to represent the type of the Data forms.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataForm.Type` Type-safe enumeration to represent the type of the Data forms.

Field Summary

Fields
Modifier and Type Field and Description

static String ELEMENT_NAME
Element name of the packet extension.

static String NAMESPACE
Namespace of the packet extension.
- Fields inherited from class org.xmpp.packet.PacketExtension
  docFactory, element, registeredExtensions

Fields
Modifier and Type	Field and Description
`static String`	`ELEMENT_NAME` Element name of the packet extension.
`static String`	`NAMESPACE` Namespace of the packet extension.

Constructor Summary

Constructors
Constructor and Description

DataForm(DataForm.Type type)

DataForm(org.dom4j.Element element)

Constructors
Constructor and Description
`DataForm(DataForm.Type type)`
`DataForm(org.dom4j.Element element)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FormField`	`addField()` Adds a new field as part of the form.
`FormField`	`addField(String variable, String label, FormField.Type type)` Adds a new field as part of the form.
`void`	`addInstruction(String instruction)` Adds a new instruction to the list of instructions that explain how to fill out the form and what the form is about.
`void`	`addItemFields(Map<String,Object> fields)` Adds a new row of items of reported data.
`void`	`addReportedField(String variable, String label, FormField.Type type)` Adds a field to the list of fields that will be returned from a search.
`void`	`clearInstructions()` Clears all the stored instructions in this packet extension.
`DataForm`	`createCopy()` Creates a deep copy of this packet extension.
`FormField`	`getField(String variable)` Returns the field whose variable matches the specified variable.
`List<FormField>`	`getFields()` Returns the fields that are part of the form.
`List<String>`	`getInstructions()` Returns an unmodifiable list of instructions that explain how to fill out the form and what the form is about.
`String`	`getTitle()` Returns the description of the data form.
`DataForm.Type`	`getType()` Returns the type of this data form.
`static boolean`	`parseBoolean(String booleanString)`
`static Date`	`parseDate(String date)` Returns the Date obtained by parsing the specified date representation.
`boolean`	`removeField(String variable)` Removes the field whose variable matches the specified variable.
`void`	`setTitle(String title)` Sets the description of the data.

Methods inherited from class org.xmpp.packet.PacketExtension
getElement, getExtensionClass

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ELEMENT_NAME
```
public static final String ELEMENT_NAME
```
    Element name of the packet extension.
    
    See Also:
    
    Constant Field Values
  - NAMESPACE
```
public static final String NAMESPACE
```
    Namespace of the packet extension.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataForm
```
public DataForm(DataForm.Type type)
```
  - DataForm
```
public DataForm(org.dom4j.Element element)
```
- Method Detail
  - parseDate
```
public static Date parseDate(String date)
                      throws ParseException
```
    Returns the Date obtained by parsing the specified date representation. The date representation is expected to be in the UTC GMT+0 format.
    
    Parameters:
    
    date - date representation in the UTC GMT+0 format.
    
    Returns:
    
    the Date obtained by parsing the specified date representation.
    
    Throws:
    
    ParseException - if an error occurs while parsing the date representation.
  - parseBoolean
```
public static boolean parseBoolean(String booleanString)
                            throws ParseException
```
    Throws:
    
    ParseException
  - getType
```
public DataForm.Type getType()
```
    Returns the type of this data form.
    
    Returns:
    
    the data form type.
    
    See Also:
    
    DataForm.Type
  - setTitle
```
public void setTitle(String title)
```
    Sets the description of the data. It is similar to the title on a web page or an X window. You can put a on either a form to fill out, or a set of data results.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>title</code> - description of the data.</dd> </dl> </li> </ul> <a name="getTitle--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getTitle</h4> <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getTitle()</pre> <div class="block">Returns the description of the data form. It is similar to the title on a web page or an X window. You can put a <title/> on either a form to fill out, or a set of data results.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>description of the data.</dd> </dl> </li> </ul> <a name="getInstructions--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getInstructions</h4> <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getInstructions()</pre> <div class="block">Returns an unmodifiable list of instructions that explain how to fill out the form and what the form is about. The dataform could include multiple instructions since each instruction could not contain newlines characters.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>an unmodifiable list of instructions that explain how to fill out the form.</dd> </dl> </li> </ul> <a name="addInstruction-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>addInstruction</h4> <pre>public void addInstruction(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> instruction)</pre> <div class="block">Adds a new instruction to the list of instructions that explain how to fill out the form and what the form is about. The dataform could include multiple instructions since each instruction could not contain newlines characters. <p> Nothing will be set, if the provided argument is <tt>null</tt> or an empty String.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>instruction</code> - the new instruction that explain how to fill out the form.</dd> </dl> </li> </ul> <a name="clearInstructions--">  </a> <ul class="blockList"> <li class="blockList"> <h4>clearInstructions</h4> <pre>public void clearInstructions()</pre> <div class="block">Clears all the stored instructions in this packet extension.</div> </li> </ul> <a name="addField--">  </a> <ul class="blockList"> <li class="blockList"> <h4>addField</h4> <pre>public <a href="../../../org/xmpp/forms/FormField.html" title="class in org.xmpp.forms">FormField</a> addField()</pre> <div class="block">Adds a new field as part of the form.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the newly created field.</dd> </dl> </li> </ul> <a name="addField-java.lang.String-java.lang.String-org.xmpp.forms.FormField.Type-">  </a> <ul class="blockList"> <li class="blockList"> <h4>addField</h4> <pre>public <a href="../../../org/xmpp/forms/FormField.html" title="class in org.xmpp.forms">FormField</a> addField(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> variable, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> label, <a href="../../../org/xmpp/forms/FormField.Type.html" title="enum in org.xmpp.forms">FormField.Type</a> type)</pre> <div class="block">Adds a new field as part of the form. The provided arguments are optional (they are allowed to be <tt>null</tt>).</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>variable</code> - the unique identifier of the field in the context of the form. Optional parameter.</dd> <dd><code>type</code> - an indicative of the format for the data. Optional parameter.</dd> <dd><code>label</code> - the label of the question. Optional parameter.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the newly created field.</dd> </dl> </li> </ul> <a name="getFields--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getFields</h4> <pre>public <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../org/xmpp/forms/FormField.html" title="class in org.xmpp.forms">FormField</a>> getFields()</pre> <div class="block">Returns the fields that are part of the form.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>fields that are part of the form.</dd> </dl> </li> </ul> <a name="getField-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>getField</h4> <pre>public <a href="../../../org/xmpp/forms/FormField.html" title="class in org.xmpp.forms">FormField</a> getField(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> variable)</pre> <div class="block">Returns the field whose variable matches the specified variable.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>variable</code> - the variable name of the field to search.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the field whose variable matches the specified variable</dd> </dl> </li> </ul> <a name="removeField-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>removeField</h4> <pre>public boolean removeField(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> variable)</pre> <div class="block">Removes the field whose variable matches the specified variable.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>variable</code> - the variable name of the field to remove.</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if the field was removed.</dd> </dl> </li> </ul> <a name="addReportedField-java.lang.String-java.lang.String-org.xmpp.forms.FormField.Type-">  </a> <ul class="blockList"> <li class="blockList"> <h4>addReportedField</h4> <pre>public void addReportedField(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> variable, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> label, <a href="../../../org/xmpp/forms/FormField.Type.html" title="enum in org.xmpp.forms">FormField.Type</a> type)</pre> <div class="block">Adds a field to the list of fields that will be returned from a search. Each field represents a column in the report. The order of the columns in the report will honor the sequence in which they were added.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>variable</code> - variable name of the new column. This value will be used in <a href="../../../org/xmpp/forms/DataForm.html#addItemFields-java.util.Map-"><code>addItemFields(java.util.Map<java.lang.String, java.lang.Object>)</code></a> when adding reported items.</dd> <dd><code>label</code> - label that corresponds to the new column. Optional parameter.</dd> <dd><code>type</code> - indicates the type of field of the new column. Optional parameter.</dd> </dl> </li> </ul> <a name="addItemFields-java.util.Map-">  </a> <ul class="blockList"> <li class="blockList"> <h4>addItemFields</h4> <pre>public void addItemFields(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> fields)</pre> <div class="block">Adds a new row of items of reported data. For each entry in the <tt>fields</tt> parameter a <tt>field</tt> element will be added to the <item> element. The variable of the new <tt>field</tt> will be the key of the entry. The new <tt>field</tt> will have several values if the entry's value is a <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>. Since the value is of type <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang"><code>Object</code></a> it is possible to include any type of object as a value. The actual value to include in the data form is the result of the <a href="../../../org/xmpp/forms/DataForm.html#encode-java.lang.Object-"><code>encode(Object)</code></a> method.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>fields</code> - list of <variable,value> to be added as a new item.</dd> </dl> </li> </ul> <a name="createCopy--">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>createCopy</h4> <pre>public <a href="../../../org/xmpp/forms/DataForm.html" title="class in org.xmpp.forms">DataForm</a> createCopy()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../org/xmpp/packet/PacketExtension.html#createCopy--">PacketExtension</a></code></span></div> <div class="block">Creates a deep copy of this packet extension.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../org/xmpp/packet/PacketExtension.html#createCopy--">createCopy</a></code> in class <code><a href="../../../org/xmpp/packet/PacketExtension.html" title="class in org.xmpp.packet">PacketExtension</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a deep copy of this packet extension.</dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <div class="bottomNav"><a name="navbar.bottom">  </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow">  </a> <ul class="navList" title="Navigation"> <li><a href="../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/DataForm.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> <li><a href="../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li>Prev Class</li> <li><a href="../../../org/xmpp/forms/DataForm.Type.html" title="enum in org.xmpp.forms"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?org/xmpp/forms/DataForm.html" target="_top">Frames</a></li> <li><a href="DataForm.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom">  </a></div>  <p class="legalCopy"><small>Copyright © 2009–2017 <a href="http://www.igniterealtime.org">Ignite Realtime</a>. All rights reserved.</small></p> </body> </html>

Class DataForm

Nested Class Summary

Field Summary

Fields inherited from class org.xmpp.packet.PacketExtension

Constructor Summary

Method Summary

Methods inherited from class org.xmpp.packet.PacketExtension

Methods inherited from class java.lang.Object

Field Detail

ELEMENT_NAME

NAMESPACE

Constructor Detail

DataForm

DataForm

Method Detail

parseDate

parseBoolean

getType

setTitle