org.apache.taglibs.rdc
Class ZipCode

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

public class ZipCode
extends BaseModel

Datamodel for the zipCode RDC. The zipCode RDC is associated with the zip code input, the length which the inputs should have, and a pattern to which the input must conform.

Author:
Raghavendra Udupa, 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_INCORRECT_LENGTH_ZIP_CODE
          A constant for Error Code stating Invalid length of Zip Code
static int ERR_INVALID_ZIP_CODE
          A constant for Error Code stating Invalid Zip Code
 
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
ZipCode()
          Sets default values for all data members
 
Method Summary
 java.lang.String getLength()
          Gets the length as a string
 java.lang.String getPattern()
          Gets the pattern string
 void setLength(java.lang.String length)
          Sets the allowed length of input
 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 input against the given constraints
 
Methods inherited from class org.apache.taglibs.rdc.core.BaseModel
baseCanonicalize, baseValidate, calculateCanonicalizedValue, 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_ZIP_CODE

public static final int ERR_INVALID_ZIP_CODE
A constant for Error Code stating Invalid Zip Code

See Also:
Constant Field Values

ERR_INCORRECT_LENGTH_ZIP_CODE

public static final int ERR_INCORRECT_LENGTH_ZIP_CODE
A constant for Error Code stating Invalid length of Zip Code

See Also:
Constant Field Values
Constructor Detail

ZipCode

public ZipCode()
Sets default values for all data members

Method Detail

setLength

public void setLength(java.lang.String length)
Sets the allowed length of input

Parameters:
length - the allowed length of input

getLength

public java.lang.String getLength()
Gets the length as a string

Returns:
the length 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

getPattern

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

Returns:
the pattern string

validate

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

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


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