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.
* * @author David Winterfeldt * @version $Revision: 1.1.1.1 $ $Date: 2004/02/13 10:02:01 $ * @see org.apache.commons.validator.Form */ public class Field implements Cloneable, Serializable { /** * This is the value that will be used as a key if theArg
* name field has no value.
*/
public final static String ARG_DEFAULT = "org.apache.commons.validator.Field.DEFAULT";
/**
* This indicates an indexed property is being referenced.
*/
public final static String TOKEN_INDEXED = "[]";
protected final static String TOKEN_START = "${";
protected final static String TOKEN_END = "}";
protected final static String TOKEN_VAR = "var:";
protected String property = null;
protected String indexedProperty = null;
protected String indexedListProperty = null;
protected String key = null;
protected String depends = null;
protected int page = 0;
protected int fieldOrder = 0;
protected FastHashMap hDependencies = new FastHashMap();
protected FastHashMap hVars = new FastHashMap();
protected FastHashMap hMsgs = new FastHashMap();
protected FastHashMap hArg0 = new FastHashMap();
protected FastHashMap hArg1 = new FastHashMap();
protected FastHashMap hArg2 = new FastHashMap();
protected FastHashMap hArg3 = new FastHashMap();
/**
* Gets the page value that the Field is associated with for
* validation.
*/
public int getPage() {
return page;
}
/**
* Sets the page value that the Field is associated with for
* validation.
*/
public void setPage(int page) {
this.page = page;
}
/**
* Gets the position of the Field in the validation list.
*/
public int getFieldOrder() {
return fieldOrder;
}
/**
* Sets the position of the Field in the validation list.
*/
public void setFieldOrder(int fieldOrder) {
this.fieldOrder = fieldOrder;
}
/**
* Gets the property name of the field.
*/
public String getProperty() {
return property;
}
/**
* Sets the property name of the field.
*/
public void setProperty(String property) {
this.property = property;
}
/**
* Gets the indexed property name of the field. This
* is the method name that can take an int as
* a parameter for indexed property value retrieval.
*/
public String getIndexedProperty() {
return indexedProperty;
}
/**
* Sets the indexed property name of the field.
*/
public void setIndexedProperty(String indexedProperty) {
this.indexedProperty = indexedProperty;
}
/**
* Gets the indexed property name of the field. This
* is the method name that will return an array or a
* Collection used to retrieve the
* list and then loop through the list performing the specified
* validations.
*/
public String getIndexedListProperty() {
return indexedListProperty;
}
/**
* Sets the indexed property name of the field.
*/
public void setIndexedListProperty(String indexedListProperty) {
this.indexedListProperty = indexedListProperty;
}
/**
* Gets the validation rules for this field.
*/
public String getDepends() {
return depends;
}
/**
* Sets the validation rules for this field.
*/
public void setDepends(String depends) {
this.depends = depends;
}
/**
* Add a Msg to the Field.
*/
public void addMsg(Msg msg) {
if (msg != null && msg.getKey() != null && msg.getKey().length() > 0 &&
msg.getName() != null && msg.getName().length() > 0) {
hMsgs.put(msg.getName(), msg.getKey());
}
}
/**
* Retrieve a message value.
*/
public String getMsg(String key) {
return (String)hMsgs.get(key);
}
/**
* Add a Arg to the arg0 list.
*/
public void addArg0(Arg arg) {
if (arg != null && arg.getKey() != null && arg.getKey().length() > 0) {
if (arg.getName() != null && arg.getName().length() > 0) {
hArg0.put(arg.getName(), arg);
} else {
hArg0.put(ARG_DEFAULT, arg);
}
}
}
/**
* Gets the default arg0 Arg object.
*/
public Arg getArg0() {
return (Arg)hArg0.get(ARG_DEFAULT);
}
/**
* Gets the arg0 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 Arg getArg0(String key) {
Object o = hArg0.get(key);
return ((o != null) ? (Arg)o : getArg0());
}
/**
* Add a Arg to the arg1 list.
*/
public void addArg1(Arg arg) {
if (arg != null && arg.getKey() != null && arg.getKey().length() > 0) {
if (arg.getName() != null && arg.getName().length() > 0) {
hArg1.put(arg.getName(), arg);
} else {
hArg1.put(ARG_DEFAULT, arg);
}
}
}
/**
* Gets the default arg1 Arg object.
*/
public Arg getArg1() {
return (Arg)hArg1.get(ARG_DEFAULT);
}
/**
* Gets the arg1 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 Arg getArg1(String key) {
Object o = hArg1.get(key);
return ((o != null) ? (Arg)o : getArg1());
}
/**
* Add a Arg to the arg2 list.
*/
public void addArg2(Arg arg) {
if (arg != null && arg.getKey() != null && arg.getKey().length() > 0) {
if (arg.getName() != null && arg.getName().length() > 0) {
hArg2.put(arg.getName(), arg);
} else {
hArg2.put(ARG_DEFAULT, arg);
}
}
}
/**
* Gets the default arg2 Arg object.
*/
public Arg getArg2() {
return (Arg)hArg2.get(ARG_DEFAULT);
}
/**
* Gets the arg2 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 Arg getArg2(String key) {
Object o = hArg2.get(key);
return ((o != null) ? (Arg)o : getArg2());
}
/**
* Add a Arg to the arg3 list.
*/
public void addArg3(Arg arg) {
if (arg != null && arg.getKey() != null && arg.getKey().length() > 0) {
if (arg.getName() != null && arg.getName().length() > 0) {
hArg3.put(arg.getName(), arg);
} else {
hArg3.put(ARG_DEFAULT, arg);
}
}
}
/**
* Gets the default arg3 Arg object.
*/
public Arg getArg3() {
return (Arg)hArg3.get(ARG_DEFAULT);
}
/**
* Gets the arg3 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 Arg getArg3(String key) {
Object o = hArg3.get(key);
return ((o != null) ? (Arg)o : getArg3());
}
/**
* Add a Var to the Field.
*/
public void addVar(Var v) {
if (v != null && v.getName() != null && v.getName().length() > 0 && v.getValue() != null) {
hVars.put(v.getName(), v);
}
}
/**
* Add a Var, based on the values passed in, to the Field.
*/
public void addVarParam(String name, String value, String jsType) {
if (name != null && name.length() > 0 && value != null) {
hVars.put(name, new Var(name, value, jsType));
}
}
/**
* Retrieve a variable.
*/
public Var getVar(String mainKey) {
return ((Var)hVars.get(mainKey));
}
/**
* Retrieve a variable's value.
*/
public String getVarValue(String mainKey) {
String value = null;
Object o = hVars.get(mainKey);
if (o != null && o instanceof Var) {
Var v = (Var)o;
value = v.getValue();
}
return value;
}
/**
* The Field's variables are returned as an
* unmodifiable Map.
*/
public Map getVars() {
return Collections.unmodifiableMap(hVars);
}
/**
* Gets a unique key based on the property and indexedProperty fields.
*/
public String getKey() {
if (key == null) {
generateKey();
}
return key;
}
/**
* Sets a unique key for the field. This can be used to change
* the key temporarily to have a unique key for an indexed field.
*/
public void setKey(String key) {
this.key = key;
}
/**
* If there is a value specified for the indexedProperty field then
* true will be returned. Otherwise it will be false.
*/
public boolean isIndexed() {
return ((indexedListProperty != null && indexedListProperty.length() > 0));
}
/**
* Generate correct key value.
*/
public void generateKey() {
if (isIndexed()) {
key = indexedListProperty + TOKEN_INDEXED + "." + property;
} else {
key = property;
}
}
/**
* Replace constants with values in fields and process the depends field
* to create the dependency Map.
*/
public void process(Map globalConstants, Map constants) {
hMsgs.setFast(false);
hArg0.setFast(true);
hArg1.setFast(true);
hArg2.setFast(true);
hArg3.setFast(true);
hVars.setFast(true);
generateKey();
// Process FormSet Constants
for (Iterator i = constants.keySet().iterator(); i.hasNext(); ) {
String key = (String)i.next();
String key2 = TOKEN_START + key + TOKEN_END;
String replaceValue = (String)constants.get(key);
property = ValidatorUtil.replace(property, key2, replaceValue);
processVars(key2, replaceValue);
processMessageComponents(key2, replaceValue);
}
// Process Global Constants
for (Iterator i = globalConstants.keySet().iterator(); i.hasNext(); ) {
String key = (String)i.next();
String key2 = TOKEN_START + key + TOKEN_END;
String replaceValue = (String)globalConstants.get(key);
property = ValidatorUtil.replace(property, key2, replaceValue);
processVars(key2, replaceValue);
processMessageComponents(key2, replaceValue);
}
// Process Var Constant Replacement
for (Iterator i = hVars.keySet().iterator(); i.hasNext(); ) {
String key = (String)i.next();
String key2 = TOKEN_START + TOKEN_VAR + key + TOKEN_END;
Var var = (Var)hVars.get(key);
String replaceValue = var.getValue();
processMessageComponents(key2, replaceValue);
}
if (getDepends() != null) {
StringTokenizer st = new StringTokenizer(getDepends(), ",");
String value = "";
while (st.hasMoreTokens()) {
String depend = st.nextToken().trim();
if (depend != null && depend.length() > 0) {
hDependencies.put(depend, value);
}
}
hDependencies.setFast(true);
}
hMsgs.setFast(true);
}
/**
* Replace the vars value with the key/value pairs passed in.
*/
private void processVars(String key, String replaceValue) {
for (Iterator i = hVars.keySet().iterator(); i.hasNext(); ) {
String varKey = (String)i.next();
Var var = (Var)hVars.get(varKey);
var.setValue(ValidatorUtil.replace(var.getValue(), key, replaceValue));
}
}
/**
* Replace the args key value with the key/value pairs passed in.
*/
public void processMessageComponents(String key, String replaceValue) {
String varKey = TOKEN_START + TOKEN_VAR;
// Process Messages
if (key != null && !key.startsWith(varKey)) {
for (Iterator i = hMsgs.keySet().iterator(); i.hasNext(); ) {
String msgKey = (String)i.next();
String value = (String)hMsgs.get(msgKey);
hMsgs.put(msgKey, ValidatorUtil.replace(value, key, replaceValue));
}
}
processArg(hArg0, key, replaceValue);
processArg(hArg1, key, replaceValue);
processArg(hArg2, key, replaceValue);
processArg(hArg3, key, replaceValue);
}
/**
* Replace the arg Collection key value with the key/value pairs passed in.
*/
private void processArg(Map hArgs, String key, String replaceValue) {
for (Iterator i = hArgs.values().iterator(); i.hasNext(); ) {
Arg arg = (Arg)i.next();
if (arg != null) {
arg.setKey(ValidatorUtil.replace(arg.getKey(), key, replaceValue));
}
}
}
/**
* Checks if the key is listed as a dependency.
*/
public boolean isDependency(String key) {
if (hDependencies != null) {
return hDependencies.containsKey(key);
} else {
return false;
}
}
/**
* Gets an unmodifiable Set of the dependencies.
*/
public Collection getDependencies() {
return Collections.unmodifiableMap(hDependencies).keySet();
}
/**
* Creates and returns a copy of this object.
*/
public Object clone() {
try {
Field field = (Field)super.clone();
if (key != null) {
field.setKey(new String(key));
}
if (property != null) {
field.setProperty(new String(property));
}
if (indexedProperty != null) {
field.setIndexedProperty(new String(indexedProperty));
}
if (indexedListProperty != null) {
field.setIndexedListProperty(new String(indexedListProperty));
}
if (depends != null) {
field.setDepends(new String(depends));
}
// page & fieldOrder should be taken care of by clone method
field.hDependencies = ValidatorUtil.copyFastHashMap(hDependencies);
field.hVars = ValidatorUtil.copyFastHashMap(hVars);
field.hMsgs = ValidatorUtil.copyFastHashMap(hMsgs);
field.hArg0 = ValidatorUtil.copyFastHashMap(hArg0);
field.hArg1 = ValidatorUtil.copyFastHashMap(hArg1);
field.hArg2 = ValidatorUtil.copyFastHashMap(hArg2);
field.hArg3 = ValidatorUtil.copyFastHashMap(hArg3);
return field;
} catch (CloneNotSupportedException e) {
throw new InternalError(e.toString());
}
}
/**
* Returns a string representation of the object.
*/
public String toString() {
StringBuffer results = new StringBuffer();
results.append("\t\tkey= " + key + "\n");
results.append("\t\tproperty= " + property + "\n");
results.append("\t\tindexedProperty= " + indexedProperty + "\n");
results.append("\t\tindexedListProperty= " + indexedListProperty + "\n");
results.append("\t\tdepends= " + depends + "\n");
results.append("\t\tpage= " + page + "\n");
results.append("\t\tfieldOrder= " + fieldOrder + "\n");
if (hVars != null) {
results.append("\t\tVars:\n");
for (Iterator i = hVars.keySet().iterator(); i.hasNext(); ) {
Object key = i.next();
results.append("\t\t\t");
results.append(key);
results.append("=");
results.append(hVars.get(key));
results.append("\n");
}
}
return results.toString();
}
}