com.sas.prompts.definitions
Class StringRangeDefinition

com.sas.prompts.definitions.StringRangeDefinition
All Implemented Interfaces:
com.sas.models.VersionInterface, com.sas.prompts.definitions.BaseDefinitionRangeInterface, com.sas.prompts.definitions.HintableDefinitionInterface, com.sas.prompts.definitions.HintableDefinitionV2Interface, com.sas.prompts.definitions.MutableBaseDefinitionRangeInterface, com.sas.prompts.definitions.MutableHintableDefinitionInterface, com.sas.prompts.definitions.MutableHintableDefinitionV2Interface, com.sas.prompts.definitions.MutablePromptDefinitionInterface, com.sas.prompts.definitions.MutablePromptDefinitionV2Interface, com.sas.prompts.definitions.MutablePromptDefinitionV3Interface, MutableRequiredDefinitionInterface, com.sas.prompts.definitions.MutableStringRangeDefinitionInterface, PromptDefinitionInterface, com.sas.prompts.definitions.PromptDefinitionV2Interface, com.sas.prompts.definitions.PromptDefinitionV3Interface, com.sas.prompts.definitions.StringRangeDefinitionInterface, com.sas.prompts.IdentifiablePromptInterface, com.sas.prompts.MutableIdentifiablePromptInterface, com.sas.prompts.MutablePromptHelpInterface, com.sas.prompts.PromptHelpInterface, com.sas.PublicClonable, com.sas.storage.editableproperties.LocalizableProperties, com.sas.storage.editableproperties.MultiLocaleProperties, com.sas.uiconfig.ContextEnabledObject, com.sas.util.AttributeConfigurationInterface, com.sas.util.AttributeDescription, com.sas.util.log.ComponentLogFactoryInterface, com.sas.util.macrovar.MacroVariableOptionInterface, com.sas.util.macrovar.MutableMacroVariableOptionInterface, com.sas.util.ResourceReferencesInterface, com.sas.util.xmlpersist.PersistenceInterface, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable

public class StringRangeDefinition
implements com.sas.prompts.definitions.MutableStringRangeDefinitionInterface

StringRangeDefinition is a prompt type which allows the specification of an string range consisting of a minimum and maximum value. The string range allows the specification of two strings which indicate the minimum and maximum extents.

See Also:
Serialized Form

Field Summary
static java.lang.String RB_KEY
           
 
Fields inherited from interface com.sas.prompts.definitions.PromptDefinitionInterface
PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM, PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_DECIMAL_PLACES, PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_LINES, PROMPT_VALIDATION_ERROR_ABOVE_MAXIMUM_VALUE_COUNT, PROMPT_VALIDATION_ERROR_BELOW_MINIMUM, PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_LENGTH, PROMPT_VALIDATION_ERROR_BELOW_MINIMUM_VALUE_COUNT, PROMPT_VALIDATION_ERROR_DATA_SOURCE_COLUMN_TYPE_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_DATA_SOURCE_CONTAINS_NO_DATA_ITEMS, PROMPT_VALIDATION_ERROR_DATA_SOURCE_NOT_AVAILABLE, PROMPT_VALIDATION_ERROR_DATA_SOURCE_TYPE_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_EMPTY_STATIC_LIST_AND_REQUIRED_WITH_NO_ADDITIONAL_VALUES_ALLOWED, PROMPT_VALIDATION_ERROR_ERROR_LOADING_SHARED_PROMPT, PROMPT_VALIDATION_ERROR_FILE_TYPE_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_FROM_SCRIPT, PROMPT_VALIDATION_ERROR_INCORRECT_RELATIVE_DATE_VALUE, PROMPT_VALIDATION_ERROR_INPUT_DOES_NOT_MATCH_PATTERN, PROMPT_VALIDATION_ERROR_INVALID_INPUT_PATTERN, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_ABOVE_UPPER_RANGE_VALUE, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM, PROMPT_VALIDATION_ERROR_LOWER_RANGE_VALUE_BELOW_MINIMUM_LENGTH, PROMPT_VALIDATION_ERROR_MASKED_HIDDEN_REQUIRED, PROMPT_VALIDATION_ERROR_MAX_DECIMAL_PLACES_ABOVE_MAX_PERCISION, PROMPT_VALIDATION_ERROR_MAXIMUM_LENGTH_BELOW_ZERO, PROMPT_VALIDATION_ERROR_MIN_DECIMAL_PLACES_ABOVE_MAX_PERCISION, PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM, PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_DECIMAL_PLACES, PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_MINIMUM_ABOVE_MAXIMUM_VALUE_COUNT, PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_MINIMUM_LENGTH_BELOW_ZERO, PROMPT_VALIDATION_ERROR_MORE_THAN_ONE_SPECIAL_VALUE_SPECIFIED, PROMPT_VALIDATION_ERROR_MULTIPLE_DATA_SOURCES_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_NO_DATA_SOURCE, PROMPT_VALIDATION_ERROR_NON_EDITABLE_REQUIRED_WITH_NO_DEFAULT_NOT_ALLOWED, PROMPT_VALIDATION_ERROR_NOT_VALID_OBJECT, PROMPT_VALIDATION_ERROR_ONLY_DIRECTORIES_ALLOWED, PROMPT_VALIDATION_ERROR_ONLY_FILES_ALLOWED, PROMPT_VALIDATION_ERROR_PERIOD_ENDS_200_YEARS_AHEAD, PROMPT_VALIDATION_ERROR_PERIOD_STARTS_200_YEARS_AGO, PROMPT_VALIDATION_ERROR_SPECIAL_VALUE_MIXED_WITH_OTHER_VALUES, PROMPT_VALIDATION_ERROR_STATIC_VALUE_INVALID, PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM, PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_ABOVE_MAXIMUM_LENGTH, PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM, PROMPT_VALIDATION_ERROR_UPPER_RANGE_VALUE_BELOW_MINIMUM_LENGTH, PROMPT_VALIDATION_NO_ERRORS
 
Constructor Summary
StringRangeDefinition()
          Constructor
StringRangeDefinition(java.lang.String promptName)
          Constructor
 
Method Summary
 void configureAttributes(java.util.Map<java.lang.String,?> options, java.util.Map<java.lang.String,?> context)
           
 java.util.List getAttributeDescriptors(java.util.Locale locale)
           
protected  java.util.Map<java.lang.String,java.lang.String> getConstraints(java.util.Locale locale)
           
protected  java.lang.String getDefaultMaxLabel(java.util.Locale locale)
          Returns the default label for the maximum field when one is not set by the user.
protected  java.lang.String getDefaultMinLabel(java.util.Locale locale)
          Returns the default label for the minimum field when one is not set by the user.
 java.lang.String getMaximum()
          Returns the maximum valid value for the prompt value.
 int getMaximumLength()
          Returns the maximum allowed length of a valid value.
 java.lang.String getMinimum()
          Returns the minimum valid value for the prompt value.
 int getMinimumLength()
          Returns the minimum allowed length of a valid value.
 com.sas.datatypes.DataTypeInterface getPromptDataType()
          Returns the data type used to manipulate the value for the prompt definition.
 java.util.Collection getPromptValueValidationErrors(java.lang.Object value, java.util.Locale locale)
          Returns a Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.
 boolean isPromptValueValid(java.lang.Object value, java.util.Locale locale)
          Returns whether the value passed in is a valid value for this prompt definition.
 void setMaximum(java.lang.String maximum)
          Sets the maximum valid value for the prompt value.
 void setMaximumLength(int maximumLength)
          Sets the maximum allowed length of a valid value.
 void setMinimum(java.lang.String minimum)
          Sets the minimum valid value for the prompt value.
 void setMinimumLength(int minimumLength)
          Sets the minimum allowed length of a valid value.
 java.util.Collection validateDefinition(java.util.Locale locale)
          This method is used to validate that the various attributes of the definition all contain valid values.
 
Methods inherited from class com.sas.prompts.definitions.BaseDefinitionRange
getMaxLabel, getMaxLabels, getMinLabel, getMinLabels, isRequired, populateErrorsForMinMax, populateMapWithErrorsForValue, setMaxLabel, setMaxLabels, setMinLabel, setMinLabels, setRequired
 
Methods inherited from class com.sas.prompts.definitions.PromptDefinition
addUserInfo, clearDefaultValue, getApplicationContext, getCustomErrorMessage, getCustomErrorMessages, getDefaultValue, getDependentPromptsForAttributes, getHint, getHintPlacement, getHints, getInlineHint, getInlineHints, getLabelPlacement, getLocalizableProperties, getMutableUserInfo, getPromptDescription, getPromptDescriptions, getPromptHelp, getPromptID, getPromptLabel, getPromptLabels, getPromptName, getScript, getScripts, getUIConfiguration, getUserInfo, getUserInfoAsText, getVersion, isDefaultValueSet, isDisplayDefaultValueAsBlank, isFixed, isHidden, isPromptValueValid, isValueClearedForNonSelectedModalChoiceGroup, removeScript, removeUserInfo, setAdditionalCascadeDependencies, setApplicationContext, setCustomErrorMessage, setCustomErrorMessages, setDefaultValue, setDependentPromptsForAttributes, setDisplayDefaultValueAsBlank, setFixed, setHidden, setHint, setHintPlacement, setHints, setInlineHint, setInlineHints, setLabelPlacement, setLocalizableProperties, setPromptDescription, setPromptDescriptions, setPromptHelp, setPromptLabel, setPromptLabels, setPromptName, setScript, setUIConfiguration, setUserInfo, setValueClearedForNonSelectedModalChoiceGroup, toString
 
Methods inherited from interface com.sas.prompts.definitions.PromptDefinitionInterface
clearDefaultValue, getDefaultValue, getPromptDescription, getPromptDescriptions, getPromptLabel, getPromptLabels, getPromptName, getUserInfo, isDefaultValueSet, isFixed, isHidden, isPromptValueValid
 
Methods inherited from interface com.sas.prompts.definitions.MutableRequiredDefinitionInterface
setRequired
 

Field Detail

RB_KEY

public static final java.lang.String RB_KEY
See Also:
Constant Field Values
Constructor Detail

StringRangeDefinition

public StringRangeDefinition()
Constructor


StringRangeDefinition

public StringRangeDefinition(java.lang.String promptName)
Constructor

Parameters:
promptName - The name of the prompt as String
Method Detail

getDefaultMaxLabel

protected java.lang.String getDefaultMaxLabel(java.util.Locale locale)
Returns the default label for the maximum field when one is not set by the user.

Overrides:
getDefaultMaxLabel in class BaseDefinitionRange
Parameters:
locale - The locale the retrieve the label for
Returns:
the default label for the maximum field when one is not set by the user.

getDefaultMinLabel

protected java.lang.String getDefaultMinLabel(java.util.Locale locale)
Returns the default label for the minimum field when one is not set by the user.

Overrides:
getDefaultMinLabel in class BaseDefinitionRange
Parameters:
locale - The locale the retrieve the label for
Returns:
the default label for the minimum field when one is not set by the user.

getMinimum

public java.lang.String getMinimum()
Returns the minimum valid value for the prompt value.

Specified by:
getMinimum in interface com.sas.prompts.definitions.StringRangeDefinitionInterface
Returns:
the minimum valid value for the prompt value.

setMinimum

public void setMinimum(java.lang.String minimum)
Sets the minimum valid value for the prompt value.

Specified by:
setMinimum in interface com.sas.prompts.definitions.MutableStringRangeDefinitionInterface
Parameters:
minimum - the minimum valid value for the prompt value.

getMaximum

public java.lang.String getMaximum()
Returns the maximum valid value for the prompt value.

Specified by:
getMaximum in interface com.sas.prompts.definitions.StringRangeDefinitionInterface
Returns:
the maximum valid value for the prompt value.

setMaximum

public void setMaximum(java.lang.String maximum)
Sets the maximum valid value for the prompt value.

Specified by:
setMaximum in interface com.sas.prompts.definitions.MutableStringRangeDefinitionInterface
Parameters:
maximum - the maximum valid value for the prompt value.

getMinimumLength

public int getMinimumLength()
Returns the minimum allowed length of a valid value.

Specified by:
getMinimumLength in interface com.sas.prompts.definitions.StringRangeDefinitionInterface
Returns:
the minimum allowed length of a valid value

setMinimumLength

public void setMinimumLength(int minimumLength)
Sets the minimum allowed length of a valid value.

Specified by:
setMinimumLength in interface com.sas.prompts.definitions.MutableStringRangeDefinitionInterface
Parameters:
minimumLength - the minimum allowed length of a valid value

getMaximumLength

public int getMaximumLength()
Returns the maximum allowed length of a valid value.

Specified by:
getMaximumLength in interface com.sas.prompts.definitions.StringRangeDefinitionInterface
Returns:
the maximum allowed length of a valid value

setMaximumLength

public void setMaximumLength(int maximumLength)
Sets the maximum allowed length of a valid value.

Specified by:
setMaximumLength in interface com.sas.prompts.definitions.MutableStringRangeDefinitionInterface
Parameters:
maximumLength - the maximum allowed length of a valid value

isPromptValueValid

public boolean isPromptValueValid(java.lang.Object value,
                                  java.util.Locale locale)
Returns whether the value passed in is a valid value for this prompt definition. The value should already have been coerced with the data type returned from getPromptDataType().

Specified by:
isPromptValueValid in interface com.sas.prompts.definitions.PromptDefinitionV2Interface
Overrides:
isPromptValueValid in class PromptDefinition
Parameters:
value - The value to check for validity
Returns:
whether the value passed in is a valid value for this prompt definition.
See Also:
PromptDefinitionV2Interface.isPromptValueValid(java.lang.Object, java.util.Locale)

getPromptValueValidationErrors

public java.util.Collection getPromptValueValidationErrors(java.lang.Object value,
                                                           java.util.Locale locale)
Returns a Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.

Specified by:
getPromptValueValidationErrors in interface PromptDefinitionInterface
Overrides:
getPromptValueValidationErrors in class PromptDefinition
Parameters:
value - The value to check for errors
locale - The locale to return the error messages in
Returns:
A Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.
See Also:
PromptDefinitionInterface.getPromptValueValidationErrors(Object, Locale)

validateDefinition

public java.util.Collection validateDefinition(java.util.Locale locale)
This method is used to validate that the various attributes of the definition all contain valid values. If the definition is valid, and empty collection will be returned, otherwise the collection with contain ValidationEntry objects for each error. This method should be called before the definition is to be used. Subclasses should override this method to return the appropriate validation errors.

Specified by:
validateDefinition in interface PromptDefinitionInterface
Overrides:
validateDefinition in class PromptDefinition
Parameters:
locale - The locale to return the error messages in
Returns:
A Collection containing the set of ValidationEntry objects or an empty collection if no errors were found.
See Also:
PromptDefinitionInterface.validateDefinition(Locale)

getPromptDataType

public com.sas.datatypes.DataTypeInterface getPromptDataType()
Returns the data type used to manipulate the value for the prompt definition. Returns com.sas.datatypes.StringRangeType.

Specified by:
getPromptDataType in interface PromptDefinitionInterface
Specified by:
getPromptDataType in class PromptDefinition
Returns:
the data type used to manipulate the value for the prompt definition.
See Also:
PromptDefinitionInterface.getPromptDataType()

getAttributeDescriptors

public java.util.List getAttributeDescriptors(java.util.Locale locale)
Specified by:
getAttributeDescriptors in interface com.sas.util.AttributeDescription
Overrides:
getAttributeDescriptors in class BaseDefinitionRange

configureAttributes

public void configureAttributes(java.util.Map<java.lang.String,?> options,
                                java.util.Map<java.lang.String,?> context)
Specified by:
configureAttributes in interface com.sas.util.AttributeConfigurationInterface
Overrides:
configureAttributes in class BaseDefinitionRange

getConstraints

protected java.util.Map<java.lang.String,java.lang.String> getConstraints(java.util.Locale locale)
Overrides:
getConstraints in class PromptDefinition



Copyright © 2009 SAS Institute Inc. All Rights Reserved.