Package com.microstrategy.web.preferences

Class EmptyNumericStringPreferenceDefinition

java.lang.Object

com.microstrategy.web.preferences.PreferenceDefinitionBase

com.microstrategy.web.preferences.PreferenceDefinitionImpl

com.microstrategy.web.preferences.EmptyNumericStringPreferenceDefinition

All Implemented Interfaces:

PreferenceDefinition

public class EmptyNumericStringPreferenceDefinition
extends PreferenceDefinitionImpl

This class checks the string to validate as a possible preference value it's either an empty string or if it has a value, it is a valid integer with the limits specified...

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from class com.microstrategy.web.preferences.PreferenceDefinitionImpl

Att_Class, Att_ClusterPropagate, Att_DescriptionID, Att_Scope, Tag_AllowableValue, Tag_AllowableValues

Fields inherited from class com.microstrategy.web.preferences.PreferenceDefinitionBase

_allowableValues, _clusterPropagate, _description, _levels, _name, _scope, _type, _value

Fields inherited from interface com.microstrategy.web.preferences.PreferenceDefinition

TYPE_BOOLEAN, TYPE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
EmptyNumericStringPreferenceDefinition()	Constructor for creating PreferenceDefinition objects from XML parsing.
EmptyNumericStringPreferenceDefinition(java.lang.String name, PreferenceLevels lvls)

Method Summary

Modifier and Type	Method	Description
protected void	buildXmlAttributes(XMLBuilder builder)	Constructs an XML representation of the preference definition.
protected void	setAttributes(org.xml.sax.Attributes attrs, PreferenceLevels group, boolean update)	Populates the object with attributes from parsing the definition XML.
protected java.lang.String	validateTransmute(java.lang.String value, Preferences pref, java.lang.Object validationObject)	This method is triggered by callback when setting preference values.

Methods inherited from class com.microstrategy.web.preferences.PreferenceDefinitionImpl

setAttributes, toString, validate, validateAllowableValues

Methods inherited from class com.microstrategy.web.preferences.PreferenceDefinitionBase

clusterPropagate, getAllowableValues, getDescription, getEnumPreferenceLevels, getName, getScope, getType, getValue, setClusterPropagate, setDescription, setEnumPreferenceLevels, setName, setScope, setType, setValue, validateDataType

Methods inherited from class java.lang.Object

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

Constructor Detail

EmptyNumericStringPreferenceDefinition

public EmptyNumericStringPreferenceDefinition(java.lang.String name,
                                              PreferenceLevels lvls)
                                       throws MSTRUncheckedException

Throws:

MSTRUncheckedException

EmptyNumericStringPreferenceDefinition

public EmptyNumericStringPreferenceDefinition()

Constructor for creating PreferenceDefinition objects from XML parsing.

Method Detail

validateTransmute

protected java.lang.String validateTransmute(java.lang.String value,
                                             Preferences pref,
                                             java.lang.Object validationObject)
                                      throws PreferencesException

This method is triggered by callback when setting preference values. By default, this method doesn't do anything.

Overrides:

validateTransmute in class PreferenceDefinitionImpl

Parameters:

value - value to validate.

pref - the Preferences hierarchy in the validation context.

Returns:

transmuted preference value

Throws:

PreferencesException

Since:

MicroStrategy Web 8.0.0

setAttributes

protected void setAttributes(org.xml.sax.Attributes attrs,
                             PreferenceLevels group,
                             boolean update)
                      throws PreferencesException

Populates the object with attributes from parsing the definition XML.

Overrides:

setAttributes in class PreferenceDefinitionImpl

Parameters:

attrs - properties of the definition in XML form.

group - used to check the scope of the definition.

Throws:

PreferencesException - if errors occur during the population.

Since:

MicroStrategy Web 9.0.1

See Also:

PreferenceDefinitionBase.setAttributes(Attributes, PreferenceLevels)

buildXmlAttributes

protected void buildXmlAttributes(XMLBuilder builder)

Description copied from class: PreferenceDefinitionImpl

Constructs an XML representation of the preference definition. Persists the following attributes: name, value, description, type, scope, and the implementation class of PreferenceDefinition (omitted if PreferenceDefinitionImpl).

Overrides:

buildXmlAttributes in class PreferenceDefinitionImpl

See Also:

PreferenceDefinitionBase.buildXmlAttributes(XMLBuilder)