org.apache.taglibs.rdc
Class Percent

java.lang.Object
  extended by org.apache.taglibs.rdc.core.BaseModel
      extended by org.apache.taglibs.rdc.Percent
All Implemented Interfaces:
java.io.Serializable

public class Percent
extends BaseModel

Datamodel for the percent RDC. The percent RDC will be associated with the percentages (say 10%), the maximum and minimum percentage length within which the input's length must lie, and a pattern to which the input must conform.

Author:
Sindhu Unnikrishnan, Rahul Akolkar
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.taglibs.rdc.core.BaseModel
BaseModel.ValueInterpreter
 
Field Summary
static int ERR_INVALID_PERCENT
          A constant for Error Code stating Invalid percent
static int ERR_NEED_HIGHER_VALUE
          A constant for Error Code stating the percent entered is smaller than allowed
static int ERR_NEED_LOWER_VALUE
          A constant for Error Code stating the percent entered is larger than allowed
 
Fields inherited from class org.apache.taglibs.rdc.core.BaseModel
ambiguousValues, candidates, canonicalizedValue, className, configuration, confirm, confirmed, DEFAULT_INITIAL_GRAMMAR_NAME, DEFAULT_MIN_CONFIDENCE, DEFAULT_NUM_N_BEST, echo, ERR_NO_DEFAULT, ERR_NONE, errorCode, exitStatus, grammars, id, initial, initialGrammar, interpretation, isAmbiguous, isValid, locale, maxNoInput, maxNoMatch, minConfidence, numNBest, paramsMap, PROPERTY_INITIAL_GRAMMAR, rdcLocale, rdcResourceBundle, skipSubmit, state, subdialog, submit, utterance, value
 
Constructor Summary
Percent()
          Sets default values for all data model members
 
Method Summary
protected  java.lang.String calculateCanonicalizedValue(java.lang.Object newValue)
          Custom canonicalized value calculation
 java.lang.String getMaxPercent()
          Gets the maximum allowed value for the percentage.
 java.lang.String getMinPercent()
          Gets the minimum allowed value for the percentage
 java.lang.String getPattern()
          Gets the pattern string
 void setMaxPercent(java.lang.String maxPercent)
          Sets the maximum allowed value for the percentage
 void setMinPercent(java.lang.String minPercent)
          Sets the minimum allowed value for the percentage
 void setPattern(java.lang.String pattern)
          Sets the pattern string to which the input must conform
protected  java.lang.Boolean validate(java.lang.Object newValue, boolean setErrorCode)
          Validates the percent value against the given constraints
 
Methods inherited from class org.apache.taglibs.rdc.core.BaseModel
baseCanonicalize, baseValidate, canonicalize, getAmbiguousValues, getCandidates, getCanonicalizedValue, getClassName, getConfiguration, getConfirm, getConfirmed, getEcho, getERR_NO_DEFAULT, getERR_NONE, getErrorCode, getExitStatus, getGrammars, getId, getInitial, getInterpretation, getIsAmbiguous, getIsValid, getLocale, getMaxNoInput, getMaxNoMatch, getMinConfidence, getNumNBest, getParamsMap, getRdcLocale, getRdcResourceBundle, getSerializedValue, getSkipSubmit, getState, getSubdialog, getSubmit, getUtterance, getValue, setAmbiguousValues, setCandidates, setCanonicalizedValue, setConfiguration, setConfirm, setConfirmed, setEcho, setErrorCode, setExitStatus, setGrammar, setId, setInitial, setInterpretation, setIsAmbiguous, setIsValid, setLocale, setMaxNoInput, setMaxNoMatch, setMinConfidence, setNumNBest, setSkipSubmit, setState, setSubdialog, setSubmit, setUtterance, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ERR_INVALID_PERCENT

public static final int ERR_INVALID_PERCENT
A constant for Error Code stating Invalid percent

See Also:
Constant Field Values

ERR_NEED_LOWER_VALUE

public static final int ERR_NEED_LOWER_VALUE
A constant for Error Code stating the percent entered is larger than allowed

See Also:
Constant Field Values

ERR_NEED_HIGHER_VALUE

public static final int ERR_NEED_HIGHER_VALUE
A constant for Error Code stating the percent entered is smaller than allowed

See Also:
Constant Field Values
Constructor Detail

Percent

public Percent()
Sets default values for all data model members

Method Detail

getMaxPercent

public java.lang.String getMaxPercent()
Gets the maximum allowed value for the percentage.

Returns:
the maximum allowed value for the percentage

setMaxPercent

public void setMaxPercent(java.lang.String maxPercent)
Sets the maximum allowed value for the percentage

Parameters:
maxPercent - The maximum allowed value for the percentage

getMinPercent

public java.lang.String getMinPercent()
Gets the minimum allowed value for the percentage

Returns:
the minimum allowed value for the percentage

setMinPercent

public void setMinPercent(java.lang.String minPercent)
Sets the minimum allowed value for the percentage

Parameters:
minPercent - The minimum allowed value.

getPattern

public java.lang.String getPattern()
Gets the pattern string

Returns:
the pattern string

setPattern

public void setPattern(java.lang.String pattern)
Sets the pattern string to which the input must conform

Parameters:
pattern - the pattern string to which the input must conform

validate

protected java.lang.Boolean validate(java.lang.Object newValue,
                                     boolean setErrorCode)
Validates the percent value against the given constraints

Overrides:
validate in class BaseModel
Returns:
TRUE if valid, FALSE otherwise

calculateCanonicalizedValue

protected java.lang.String calculateCanonicalizedValue(java.lang.Object newValue)
Custom canonicalized value calculation

Overrides:
calculateCanonicalizedValue in class BaseModel
Returns:
String The canonical value


Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.