|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.commons.validator.Field
This contains the list of pluggable validators to run on a field and any message information and variables to perform the validations and generate error messages.
Form
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ARG_DEFAULT
This is the value that will be used as a key if the Arg
name field has no value. |
protected java.lang.String |
depends
|
protected int |
fieldOrder
|
protected org.apache.commons.collections.FastHashMap |
hArg0
|
protected org.apache.commons.collections.FastHashMap |
hArg1
|
protected org.apache.commons.collections.FastHashMap |
hArg2
|
protected org.apache.commons.collections.FastHashMap |
hArg3
|
protected org.apache.commons.collections.FastHashMap |
hDependencies
|
protected org.apache.commons.collections.FastHashMap |
hMsgs
|
protected org.apache.commons.collections.FastHashMap |
hVars
|
protected java.lang.String |
indexedListProperty
|
protected java.lang.String |
indexedProperty
|
protected java.lang.String |
key
|
protected int |
page
|
protected java.lang.String |
property
|
protected static java.lang.String |
TOKEN_END
|
static java.lang.String |
TOKEN_INDEXED
This indicates an indexed property is being referenced. |
protected static java.lang.String |
TOKEN_START
|
protected static java.lang.String |
TOKEN_VAR
|
Constructor Summary | |
---|---|
Field()
|
Method Summary | |
---|---|
void |
addArg0(Arg arg)
Add a Arg to the arg0 list. |
void |
addArg1(Arg arg)
Add a Arg to the arg1 list. |
void |
addArg2(Arg arg)
Add a Arg to the arg2 list. |
void |
addArg3(Arg arg)
Add a Arg to the arg3 list. |
void |
addMsg(Msg msg)
Add a Msg to the Field . |
void |
addVar(Var v)
Add a Var to the Field . |
void |
addVarParam(java.lang.String name,
java.lang.String value,
java.lang.String jsType)
Add a Var , based on the values passed in, to the Field . |
java.lang.Object |
clone()
Creates and returns a copy of this object. |
void |
generateKey()
Generate correct key value. |
Arg |
getArg0()
Gets the default arg0 Arg object. |
Arg |
getArg0(java.lang.String key)
Gets the arg0 Arg object based on the key passed in. |
Arg |
getArg1()
Gets the default arg1 Arg object. |
Arg |
getArg1(java.lang.String key)
Gets the arg1 Arg object based on the key passed in. |
Arg |
getArg2()
Gets the default arg2 Arg object. |
Arg |
getArg2(java.lang.String key)
Gets the arg2 Arg object based on the key passed in. |
Arg |
getArg3()
Gets the default arg3 Arg object. |
Arg |
getArg3(java.lang.String key)
Gets the arg3 Arg object based on the key passed in. |
java.util.Collection |
getDependencies()
Gets an unmodifiable Set of the dependencies. |
java.lang.String |
getDepends()
Gets the validation rules for this field. |
int |
getFieldOrder()
Gets the position of the Field in the validation list. |
java.lang.String |
getIndexedListProperty()
Gets the indexed property name of the field. |
java.lang.String |
getIndexedProperty()
Gets the indexed property name of the field. |
java.lang.String |
getKey()
Gets a unique key based on the property and indexedProperty fields. |
java.lang.String |
getMsg(java.lang.String key)
Retrieve a message value. |
int |
getPage()
Gets the page value that the Field is associated with for validation. |
java.lang.String |
getProperty()
Gets the property name of the field. |
Var |
getVar(java.lang.String mainKey)
Retrieve a variable. |
java.util.Map |
getVars()
The Field 's variables are returned as an
unmodifiable Map . |
java.lang.String |
getVarValue(java.lang.String mainKey)
Retrieve a variable's value. |
boolean |
isDependency(java.lang.String key)
Checks if the key is listed as a dependency. |
boolean |
isIndexed()
If there is a value specified for the indexedProperty field then true will be returned. |
void |
process(java.util.Map globalConstants,
java.util.Map constants)
Replace constants with values in fields and process the depends field to create the dependency Map . |
private void |
processArg(java.util.Map hArgs,
java.lang.String key,
java.lang.String replaceValue)
Replace the arg Collection key value with the key/value pairs passed in. |
void |
processMessageComponents(java.lang.String key,
java.lang.String replaceValue)
Replace the args key value with the key/value pairs passed in. |
private void |
processVars(java.lang.String key,
java.lang.String replaceValue)
Replace the vars value with the key/value pairs passed in. |
void |
setDepends(java.lang.String depends)
Sets the validation rules for this field. |
void |
setFieldOrder(int fieldOrder)
Sets the position of the Field in the validation list. |
void |
setIndexedListProperty(java.lang.String indexedListProperty)
Sets the indexed property name of the field. |
void |
setIndexedProperty(java.lang.String indexedProperty)
Sets the indexed property name of the field. |
void |
setKey(java.lang.String key)
Sets a unique key for the field. |
void |
setPage(int page)
Sets the page value that the Field is associated with for validation. |
void |
setProperty(java.lang.String property)
Sets the property name of the field. |
java.lang.String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String ARG_DEFAULT
Arg
name field has no value.
public static final java.lang.String TOKEN_INDEXED
protected static final java.lang.String TOKEN_START
protected static final java.lang.String TOKEN_END
protected static final java.lang.String TOKEN_VAR
protected java.lang.String property
protected java.lang.String indexedProperty
protected java.lang.String indexedListProperty
protected java.lang.String key
protected java.lang.String depends
protected int page
protected int fieldOrder
protected org.apache.commons.collections.FastHashMap hDependencies
protected org.apache.commons.collections.FastHashMap hVars
protected org.apache.commons.collections.FastHashMap hMsgs
protected org.apache.commons.collections.FastHashMap hArg0
protected org.apache.commons.collections.FastHashMap hArg1
protected org.apache.commons.collections.FastHashMap hArg2
protected org.apache.commons.collections.FastHashMap hArg3
Constructor Detail |
public Field()
Method Detail |
public int getPage()
public void setPage(int page)
public int getFieldOrder()
Field
in the validation list.
public void setFieldOrder(int fieldOrder)
Field
in the validation list.
public java.lang.String getProperty()
public void setProperty(java.lang.String property)
public java.lang.String getIndexedProperty()
int
as
a parameter for indexed property value retrieval.
public void setIndexedProperty(java.lang.String indexedProperty)
public java.lang.String getIndexedListProperty()
Collection
used to retrieve the
list and then loop through the list performing the specified
validations.
public void setIndexedListProperty(java.lang.String indexedListProperty)
public java.lang.String getDepends()
public void setDepends(java.lang.String depends)
public void addMsg(Msg msg)
Msg
to the Field
.
public java.lang.String getMsg(java.lang.String key)
public void addArg0(Arg arg)
Arg
to the arg0 list.
public Arg getArg0()
Arg
object.
public Arg getArg0(java.lang.String key)
Arg
object based on the key passed in. If the key
finds a null
value then the default value will try to be retrieved.
public void addArg1(Arg arg)
Arg
to the arg1 list.
public Arg getArg1()
Arg
object.
public Arg getArg1(java.lang.String key)
Arg
object based on the key passed in. If the key
finds a null
value then the default value will try to be retrieved.
public void addArg2(Arg arg)
Arg
to the arg2 list.
public Arg getArg2()
Arg
object.
public Arg getArg2(java.lang.String key)
Arg
object based on the key passed in. If the key
finds a null
value then the default value will try to be retrieved.
public void addArg3(Arg arg)
Arg
to the arg3 list.
public Arg getArg3()
Arg
object.
public Arg getArg3(java.lang.String key)
Arg
object based on the key passed in. If the key
finds a null
value then the default value will try to be retrieved.
public void addVar(Var v)
Var
to the Field
.
public void addVarParam(java.lang.String name, java.lang.String value, java.lang.String jsType)
Var
, based on the values passed in, to the Field
.
public Var getVar(java.lang.String mainKey)
public java.lang.String getVarValue(java.lang.String mainKey)
public java.util.Map getVars()
Field
's variables are returned as an
unmodifiable Map
.
public java.lang.String getKey()
public void setKey(java.lang.String key)
public boolean isIndexed()
true
will be returned. Otherwise it will be false
.
public void generateKey()
key
value.
public void process(java.util.Map globalConstants, java.util.Map constants)
Map
.
private void processVars(java.lang.String key, java.lang.String replaceValue)
public void processMessageComponents(java.lang.String key, java.lang.String replaceValue)
private void processArg(java.util.Map hArgs, java.lang.String key, java.lang.String replaceValue)
Collection
key value with the key/value pairs passed in.
public boolean isDependency(java.lang.String key)
public java.util.Collection getDependencies()
Set
of the dependencies.
public java.lang.Object clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |