org.jivesoftware.smackx.xdatavalidation.packet

Class ValidateElement

java.lang.Object

org.jivesoftware.smackx.xdatavalidation.packet.ValidateElement

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

Direct Known Subclasses:

ValidateElement.BasicValidateElement, ValidateElement.OpenValidateElement, ValidateElement.RangeValidateElement, ValidateElement.RegexValidateElement

public abstract class ValidateElement
extends Object
implements ExtensionElement

DataValidation Extension according to XEP-0122: Data Forms Validation. This specification defines a backwards-compatible extension to the XMPP Data Forms protocol that enables applications to specify additional validation guidelines related to a FormField in a DataForm, such as validation of standard XML datatypes, application-specific datatypes, value ranges, and regular expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValidateElement.BasicValidateElement Validation only against the datatype itself.
static class	ValidateElement.ListRange This element indicates for "list-multi", that a minimum and maximum number of options should be selected and/or entered.
static class	ValidateElement.OpenValidateElement For "list-single" or "list-multi", indicates that the user may enter a custom value (matching the datatype constraints) or choose from the predefined values.
static class	ValidateElement.RangeValidateElement Indicate that the value should fall within a certain range.
static class	ValidateElement.RegexValidateElement Indicates that the value should be restricted to a regular expression.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATATYPE_XS_STRING
static String	ELEMENT
static String	NAMESPACE

Method Summary

Modifier and Type	Method and Description
protected abstract void	appendXML(XmlStringBuilder buf)
abstract void	checkConsistency(FormField formField) Check if this element is consistent according to the business rules in XEP=0122.
protected void	checkListRangeConsistency(FormField formField) The >list-range/< element SHOULD be included only when the <field/> is of type "list-multi" and SHOULD be ignored otherwise.
protected void	checkNonMultiConsistency(FormField formField, String method)
String	getDatatype() Specifies the data type of any value contained within the FormField element.
String	getElementName() Returns the root element name.
ValidateElement.ListRange	getListRange() Get list range.
String	getNamespace() Returns the root element XML namespace.
void	setListRange(ValidateElement.ListRange listRange) Set list range.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

DATATYPE_XS_STRING

public static final String DATATYPE_XS_STRING

See Also:

Constant Field Values

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Method Detail

getDatatype

public String getDatatype()

Specifies the data type of any value contained within the FormField element. It MUST meet one of the following conditions:

• Start with "xs:", and be one of the "built-in" datatypes defined in XML Schema Part 2 [2]
• Start with a prefix registered with the XMPP Registrar [3]
• Start with "x:", and specify a user-defined datatype [4]

Returns:

the datatype

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

appendXML

protected abstract void appendXML(XmlStringBuilder buf)

Parameters:

buf -

setListRange

public void setListRange(ValidateElement.ListRange listRange)

Set list range.

Parameters:

listRange - the listRange to set

getListRange

public ValidateElement.ListRange getListRange()

Get list range.

Returns:

the listRange

checkConsistency

public abstract void checkConsistency(FormField formField)

Check if this element is consistent according to the business rules in XEP=0122.

Parameters:

formField -

checkListRangeConsistency

protected void checkListRangeConsistency(FormField formField)

The >list-range/< element SHOULD be included only when the <field/> is of type "list-multi" and SHOULD be ignored otherwise.

Parameters:

formField -

checkNonMultiConsistency

protected void checkNonMultiConsistency(FormField formField,
                                        String method)

Parameters:

formField -

method -