Modified:
websites/production/turbine/content/fulcrum/fulcrum-intake/apidocs/org/apache/fulcrum/intake/model/Field.html
==============================================================================
---
websites/production/turbine/content/fulcrum/fulcrum-intake/apidocs/org/apache/fulcrum/intake/model/Field.html
(original)
+++
websites/production/turbine/content/fulcrum/fulcrum-intake/apidocs/org/apache/fulcrum/intake/model/Field.html
Sun Feb 11 15:37:56 2018
@@ -2,38 +2,24 @@
<!-- NewPage -->
<html lang="de">
<head>
-<!-- Generated by javadoc -->
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Field (Fulcrum Intake Service 1.2.3 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css"
title="Style">
-<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="Field (Fulcrum Intake Service 1.2.3 API)";
- }
- }
- catch(err) {
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="Field (Fulcrum Intake Service 1.2.3 API)";
}
//-->
-var methods =
{"i0":10,"i1":6,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":6,"i35":10,"i36":6,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10};
-var tabs = {65535:["t0","All Methods"],2:["t2","Instance
Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
-var altColor = "altColor";
-var rowColor = "rowColor";
-var tableTab = "tableTab";
-var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
-<div class="topNav"><a name="navbar.top">
+<div class="topNav"><a name="navbar_top">
<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation
links">Skip navigation links</a></div>
-<a name="navbar.top.firstrow">
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a
name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
@@ -49,15 +35,15 @@ var activeTableTab = "activeTableTab";
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/fulcrum/intake/model/DoubleField.html"
title="class in org.apache.fulcrum.intake.model"><span
class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/fulcrum/intake/model/FieldAdapter.html"
title="class in org.apache.fulcrum.intake.model"><span
class="typeNameLink">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/fulcrum/intake/model/DoubleField.html"
title="class in org.apache.fulcrum.intake.model"><span class="strong">Prev
Class</span></a></li>
+<li><a href="../../../../../org/apache/fulcrum/intake/model/FieldAdapter.html"
title="class in org.apache.fulcrum.intake.model"><span class="strong">Next
Class</span></a></li>
</ul>
<ul class="navList">
<li><a
href="../../../../../index.html?org/apache/fulcrum/intake/model/Field.html"
target="_top">Frames</a></li>
-<li><a href="Field.html" target="_top">No Frames</a></li>
+<li><a href="Field.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
-<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -75,18 +61,18 @@ var activeTableTab = "activeTableTab";
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field.summary">Field</a> | </li>
-<li><a href="#constructor.summary">Constr</a> | </li>
-<li><a href="#method.summary">Method</a></li>
+<li><a href="#field_summary">Field</a> | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#field.detail">Field</a> | </li>
-<li><a href="#constructor.detail">Constr</a> | </li>
-<li><a href="#method.detail">Method</a></li>
+<li><a href="#field_detail">Field</a> | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
</ul>
</div>
-<a name="skip.navbar.top">
+<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
@@ -121,14 +107,11 @@ var activeTableTab = "activeTableTab";
extends <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a>
implements <a
href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true"
title="class or interface in java.io">Serializable</a>,
org.apache.avalon.framework.logger.LogEnabled</pre>
<div class="block">Base class for Intake generated input processing
classes.</div>
-<dl>
-<dt><span class="simpleTagLabel">Version:</span></dt>
-<dd>$Id: Field.java 1823842 2018-02-11 14:55:11Z tv $</dd>
-<dt><span class="simpleTagLabel">Author:</span></dt>
-<dd><a href="mailto:[email protected]">John McNally</a>, <a
href="mailto:[email protected]">Daniel Rall</a>, <a
href="mailto:[email protected]">Henning P. Schmiedehausen</a>, <a
href="mailto:[email protected]">Quinton McCombs</a>, <a
href="mailto:[email protected]">Jürgen Hoffmann</a>, <a
href="mailto:[email protected]">Thomas Vandahl</a></dd>
-<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a
href="../../../../../serialized-form.html#org.apache.fulcrum.intake.model.Field">Serialized
Form</a></dd>
-</dl>
+<dl><dt><span class="strong">Version:</span></dt>
+ <dd>$Id: Field.java 1823842 2018-02-11 14:55:11Z tv $</dd>
+<dt><span class="strong">Author:</span></dt>
+ <dd><a href="mailto:[email protected]">John McNally</a>, <a
href="mailto:[email protected]">Daniel Rall</a>, <a
href="mailto:[email protected]">Henning P. Schmiedehausen</a>, <a
href="mailto:[email protected]">Quinton McCombs</a>, <a
href="mailto:[email protected]">Jürgen Hoffmann</a>, <a
href="mailto:[email protected]">Thomas Vandahl</a></dd>
+<dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../serialized-form.html#org.apache.fulcrum.intake.model.Field">Serialized
Form</a></dd></dl>
</li>
</ul>
</div>
@@ -137,11 +120,11 @@ implements <a href="http://docs.oracle.c
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="field.summary">
+<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
-<table class="memberSummary" border="0" cellpadding="3" cellspacing="0"
summary="Field Summary table, listing fields, and an explanation">
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
@@ -149,43 +132,43 @@ implements <a href="http://docs.oracle.c
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#defaultFieldPackage">defaultFieldPackage</a></span></code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#defaultFieldPackage">defaultFieldPackage</a></strong></code>
<div class="block">Default Field Package</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#defaultValidatorPackage">defaultValidatorPackage</a></span></code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#defaultValidatorPackage">defaultValidatorPackage</a></strong></code>
<div class="block">Default Validator Package</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#defaultValue">defaultValue</a></span></code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#defaultValue">defaultValue</a></strong></code>
<div class="block">Default value of the field</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#emptyValue">emptyValue</a></span></code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#emptyValue">emptyValue</a></strong></code>
<div class="block">Value of the field to use if the mapped parameter is empty
or non-existent</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected
org.apache.avalon.framework.logger.Logger</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#log">log</a></span></code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#log">log</a></strong></code>
<div class="block">Logging</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#mapToObject">mapToObject</a></span></code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#mapToObject">mapToObject</a></strong></code>
<div class="block">Class name of the object to which the field is mapped</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected
org.apache.fulcrum.parser.ValueParser</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#parser">parser</a></span></code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#parser">parser</a></strong></code>
<div class="block">The object containing the field data.</div>
</td>
</tr>
@@ -194,18 +177,18 @@ implements <a href="http://docs.oracle.c
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
-<li class="blockList"><a name="constructor.summary">
+<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
-<table class="memberSummary" border="0" cellpadding="3" cellspacing="0"
summary="Constructor Summary table, listing constructors, and an explanation">
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
-<td class="colOne"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#Field-org.apache.fulcrum.intake.model.XmlField-org.apache.fulcrum.intake.model.Group-">Field</a></span>(<a
href="../../../../../org/apache/fulcrum/intake/model/XmlField.html"
title="class in org.apache.fulcrum.intake.model">XmlField</a> field,
- <a href="../../../../../org/apache/fulcrum/intake/model/Group.html"
title="class in org.apache.fulcrum.intake.model">Group</a> group)</code>
+<td class="colOne"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#Field(org.apache.fulcrum.intake.model.XmlField,
org.apache.fulcrum.intake.model.Group)">Field</a></strong>(<a
href="../../../../../org/apache/fulcrum/intake/model/XmlField.html"
title="class in org.apache.fulcrum.intake.model">XmlField</a> field,
+ <a href="../../../../../org/apache/fulcrum/intake/model/Group.html"
title="class in org.apache.fulcrum.intake.model">Group</a> group)</code>
<div class="block">Constructs a field based on data in the xml specification
and assigns it to a Group.</div>
</td>
@@ -215,311 +198,311 @@ implements <a href="http://docs.oracle.c
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
-<li class="blockList"><a name="method.summary">
+<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
-<table class="memberSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
-<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span
class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a
href="javascript:show(2);">Instance Methods</a></span><span
class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a
href="javascript:show(4);">Abstract Methods</a></span><span
class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a
href="javascript:show(8);">Concrete Methods</a></span><span
class="tabEnd"> </span></span></caption>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0"
summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
-<tr id="i0" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#dispose--">dispose</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#dispose()">dispose</a></strong>()</code>
<div class="block">Disposes the object after use.</div>
</td>
</tr>
-<tr id="i1" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>protected abstract void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#doSetValue--">doSetValue</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#doSetValue()">doSetValue</a></strong>()</code>
<div class="block">Sets the value of the field from data in the parser.</div>
</td>
</tr>
-<tr id="i2" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#enableLogging-org.apache.avalon.framework.logger.Logger-">enableLogging</a></span>(org.apache.avalon.framework.logger.Logger logger)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#enableLogging(org.apache.avalon.framework.logger.Logger)">enableLogging</a></strong>(org.apache.avalon.framework.logger.Logger logger)</code>
<div class="block">Enable Avalon Logging</div>
</td>
</tr>
-<tr id="i3" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDefault--">getDefault</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDefault()">getDefault</a></strong>()</code>
<div class="block">Loads the default value from the object</div>
</td>
</tr>
-<tr id="i4" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>protected <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDefaultValidator--">getDefaultValidator</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDefaultValidator()">getDefaultValidator</a></strong>()</code>
<div class="block">Produces the fully qualified class name of the default
validator.</div>
</td>
</tr>
-<tr id="i5" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDefaultValue--">getDefaultValue</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDefaultValue()">getDefaultValue</a></strong>()</code>
<div class="block">Get the default Value</div>
</td>
</tr>
-<tr id="i6" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDisplayName--">getDisplayName</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDisplayName()">getDisplayName</a></strong>()</code>
<div class="block">Get the display name of the field.</div>
</td>
</tr>
-<tr id="i7" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDisplaySize--">getDisplaySize</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getDisplaySize()">getDisplaySize</a></strong>()</code>
<div class="block">Gets the display size of the field.</div>
</td>
</tr>
-<tr id="i8" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getEmptyValue--">getEmptyValue</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getEmptyValue()">getEmptyValue</a></strong>()</code>
<div class="block">Get the Value to use if the field is empty</div>
</td>
</tr>
-<tr id="i9" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><a
href="../../../../../org/apache/fulcrum/intake/model/Group.html" title="class
in org.apache.fulcrum.intake.model">Group</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getGroup--">getGroup</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getGroup()">getGroup</a></strong>()</code>
<div class="block">Returns the <code>Group</code> this field belongs to
or <code>null</code> if unknown.</div>
</td>
</tr>
-<tr id="i10" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getHTMLString--">getHTMLString</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getHTMLString()">getHTMLString</a></strong>()</code>
<div class="block">Calls toString() on the object returned by getValue(),
unless null; and then it returns "", the empty String.</div>
</td>
</tr>
-<tr id="i11" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getInitialValue--">getInitialValue</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getInitialValue()">getInitialValue</a></strong>()</code>
<div class="block">Get the value used as a default.</div>
</td>
</tr>
-<tr id="i12" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getKey--">getKey</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getKey()">getKey</a></strong>()</code>
<div class="block">Get the key used to identify the field.</div>
</td>
</tr>
-<tr id="i13" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true"
title="class or interface in java.util">Locale</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getLocale--">getLocale</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getLocale()">getLocale</a></strong>()</code>
<div class="block">Returns the <code>Locale</code> used when localizing data
for
this field, or <code>null</code> if unknown.</div>
</td>
</tr>
-<tr id="i14" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getMapToObject--">getMapToObject</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getMapToObject()">getMapToObject</a></strong>()</code>
<div class="block">Get the name of the object that takes this input</div>
</td>
</tr>
-<tr id="i15" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getMaxSize--">getMaxSize</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getMaxSize()">getMaxSize</a></strong>()</code>
<div class="block">Gets the maximum size of the field.</div>
</td>
</tr>
-<tr id="i16" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getMessage--">getMessage</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getMessage()">getMessage</a></strong>()</code>
<div class="block">Get any error message resulting from invalid input.</div>
</td>
</tr>
-<tr id="i17" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getName--">getName</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getName()">getName</a></strong>()</code>
<div class="block">Gets the name of the field.</div>
</td>
</tr>
-<tr id="i18" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getProperty-java.lang.Object-">getProperty</a></span>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a> obj)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getProperty(java.lang.Object)">getProperty</a></strong>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a> obj)</code>
<div class="block">Loads the valid value from a bean</div>
</td>
</tr>
-<tr id="i19" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>protected <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getSafeEmptyValue--">getSafeEmptyValue</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getSafeEmptyValue()">getSafeEmptyValue</a></strong>()</code>
<div class="block">Provides access to emptyValue such that the value returned
will be
acceptable as an argument parameter to Method.invoke.</div>
</td>
</tr>
-<tr id="i20" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getStringValue--">getStringValue</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getStringValue()">getStringValue</a></strong>()</code>
<div class="block">Gets the String representation of the Value.</div>
</td>
</tr>
-<tr id="i21" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><TT> TT</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getTestValue--">getTestValue</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getTestValue()">getTestValue</a></strong>()</code>
<div class="block">Get the value input by a user that will be validated.</div>
</td>
</tr>
-<tr id="i22" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="../../../../../org/apache/fulcrum/intake/validator/Validator.html"
title="interface in org.apache.fulcrum.intake.validator">Validator</a><<a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a>></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getValidator--">getValidator</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getValidator()">getValidator</a></strong>()</code>
<div class="block">Gets the Validator object for this field.</div>
</td>
</tr>
-<tr id="i23" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getValue--">getValue</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getValue()">getValue</a></strong>()</code>
<div class="block">Get the value of the field.</div>
</td>
</tr>
-<tr id="i24" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getValueIfAbsent--">getValueIfAbsent</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#getValueIfAbsent()">getValueIfAbsent</a></strong>()</code>
<div class="block">Use in a hidden field assign a default value in the event
the
field is absent from the query parameters.</div>
</td>
</tr>
-<tr id="i25" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="class
in org.apache.fulcrum.intake.model">Field</a><<a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a>></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#init-org.apache.fulcrum.intake.Retrievable-">init</a></span>(<a
href="../../../../../org/apache/fulcrum/intake/Retrievable.html"
title="interface in org.apache.fulcrum.intake">Retrievable</a> obj)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#init(org.apache.fulcrum.intake.Retrievable)">init</a></strong>(<a
href="../../../../../org/apache/fulcrum/intake/Retrievable.html"
title="interface in org.apache.fulcrum.intake">Retrievable</a> obj)</code>
<div class="block">Method called when this field or the group it belongs to is
pulled from the pool.</div>
</td>
</tr>
-<tr id="i26" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="class
in org.apache.fulcrum.intake.model">Field</a><<a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a>></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#init-org.apache.fulcrum.parser.ValueParser-">init</a></span>(org.apache.fulcrum.parser.ValueParser pp)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#init(org.apache.fulcrum.parser.ValueParser)">init</a></strong>(org.apache.fulcrum.parser.ValueParser pp)</code>
<div class="block">Method called when this field (the group it belongs to) is
pulled from the pool.</div>
</td>
</tr>
-<tr id="i27" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#initGetterAndSetter--">initGetterAndSetter</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#initGetterAndSetter()">initGetterAndSetter</a></strong>()</code>
<div class="block">Initialize getter and setter from properties</div>
</td>
</tr>
-<tr id="i28" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isMultiValued--">isMultiValued</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isMultiValued()">isMultiValued</a></strong>()</code>
<div class="block">Flag to determine whether the field has been declared as
multi-valued.</div>
</td>
</tr>
-<tr id="i29" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isRequired--">isRequired</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isRequired()">isRequired</a></strong>()</code>
<div class="block">Flag to determine whether the field has been declared as
required.</div>
</td>
</tr>
-<tr id="i30" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isSet--">isSet</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isSet()">isSet</a></strong>()</code>
<div class="block">Flag set to true, if the test value has been set by the
parser (even to
an empty value, so don't used this to determine if the field contains a
non-empty value).</div>
</td>
</tr>
-<tr id="i31" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isValid--">isValid</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isValid()">isValid</a></strong>()</code>
<div class="block">Flag set to true, if the test value met the
constraints.</div>
</td>
</tr>
-<tr id="i32" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isValidated--">isValidated</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#isValidated()">isValidated</a></strong>()</code>
<div class="block">Flag to determine whether the field has been
validated.</div>
</td>
</tr>
-<tr id="i33" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#removeFromRequest--">removeFromRequest</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#removeFromRequest()">removeFromRequest</a></strong>()</code>
<div class="block">Removes references to this group and its fields from the
query parameters</div>
</td>
</tr>
-<tr id="i34" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setDefaultValue-java.lang.String-">setDefaultValue</a></span>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> prop)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setDefaultValue(java.lang.String)">setDefaultValue</a></strong>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> prop)</code>
<div class="block">Set the default Value.</div>
</td>
</tr>
-<tr id="i35" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setDisplayName-java.lang.String-">setDisplayName</a></span>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> newDisplayName)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setDisplayName(java.lang.String)">setDisplayName</a></strong>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> newDisplayName)</code>
<div class="block">Set the display name of the field.</div>
</td>
</tr>
-<tr id="i36" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>abstract void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setEmptyValue-java.lang.String-">setEmptyValue</a></span>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> prop)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setEmptyValue(java.lang.String)">setEmptyValue</a></strong>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> prop)</code>
<div class="block">Set the empty Value.</div>
</td>
</tr>
-<tr id="i37" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setMessage-java.lang.String-">setMessage</a></span>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> message)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setMessage(java.lang.String)">setMessage</a></strong>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> message)</code>
<div class="block">Sets an error message.</div>
</td>
</tr>
-<tr id="i38" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setProperty-java.lang.Object-">setProperty</a></span>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a> obj)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setProperty(java.lang.Object)">setProperty</a></strong>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a> obj)</code>
<div class="block">Calls a setter method on obj, if this field has been
set.</div>
</td>
</tr>
-<tr id="i39" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setRequired-boolean-">setRequired</a></span>(boolean v)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setRequired(boolean)">setRequired</a></strong>(boolean v)</code>
<div class="block">Set whether this field is required to have a value.</div>
</td>
</tr>
-<tr id="i40" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setRequired-boolean-java.lang.String-">setRequired</a></span>(boolean v,
- <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> message)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setRequired(boolean,
java.lang.String)">setRequired</a></strong>(boolean v,
+ <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> message)</code>
<div class="block">Set the value of required.</div>
</td>
</tr>
-<tr id="i41" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setSet-boolean-">setSet</a></span>(boolean setFlag)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setSet(boolean)">setSet</a></strong>(boolean setFlag)</code>
<div class="block">Set the internal flag that the field has been set</div>
</td>
</tr>
-<tr id="i42" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setValid-boolean-">setValid</a></span>(boolean validFlag)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setValid(boolean)">setValid</a></strong>(boolean validFlag)</code>
<div class="block">Set the internal flag that the field is valid</div>
</td>
</tr>
-<tr id="i43" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setValidated-boolean-">setValidated</a></span>(boolean validated)</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#setValidated(boolean)">setValidated</a></strong>(boolean validated)</code>
<div class="block">Set the internal flag that the field has been
validated</div>
</td>
</tr>
-<tr id="i44" class="altColor">
+<tr class="altColor">
<td class="colFirst"><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a></code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#toString--">toString</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#toString()">toString</a></strong>()</code>
<div class="block">Calls toString() on the object returned by getValue(),
unless null; and then it returns "", the empty String.</div>
</td>
</tr>
-<tr id="i45" class="rowColor">
+<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
-<td class="colLast"><code><span class="memberNameLink"><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#validate--">validate</a></span>()</code>
+<td class="colLast"><code><strong><a
href="../../../../../org/apache/fulcrum/intake/model/Field.html#validate()">validate</a></strong>()</code>
<div class="block">Compares request data with constraints and sets the valid
flag.</div>
</td>
</tr>
</table>
<ul class="blockList">
-<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
+<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a></h3>
-<code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone--"
title="class or interface in java.lang">clone</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"
title="class or interface in java.lang">equals</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize--"
title="class or interface in java.lang">finalize</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass--"
title="class or interface in java.lang">getClass</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode--"
title="class or interface in java.lang">hashCode</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify--"
title="class or interface in java.lang">notify</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang
/Object.html?is-external=true#notifyAll--" title="class or interface in
java.lang">notifyAll</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait--"
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-"
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"
title="class or interface in java.lang">wait</a></code></li>
+<code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()"
title="class or interface in java.lang">clone</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)"
title="class or interface in java.lang">equals</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()"
title="class or interface in java.lang">finalize</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()"
title="class or interface in java.lang">getClass</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()"
title="class or interface in java.lang">hashCode</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()"
title="class or interface in java.lang">notify</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang
/Object.html?is-external=true#notifyAll()" title="class or interface in
java.lang">notifyAll</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()"
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)"
title="class or interface in java.lang">wait</a>, <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,
int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
@@ -531,7 +514,7 @@ implements <a href="http://docs.oracle.c
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
-<li class="blockList"><a name="field.detail">
+<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
@@ -543,10 +526,7 @@ implements <a href="http://docs.oracle.c
<h4>defaultValidatorPackage</h4>
<pre>public static final <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.64">defaultValidatorPackage</a></pre>
<div class="block">Default Validator Package</div>
-<dl>
-<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a
href="../../../../../constant-values.html#org.apache.fulcrum.intake.model.Field.defaultValidatorPackage">Constant
Field Values</a></dd>
-</dl>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../constant-values.html#org.apache.fulcrum.intake.model.Field.defaultValidatorPackage">Constant
Field Values</a></dd></dl>
</li>
</ul>
<a name="defaultFieldPackage">
@@ -557,10 +537,7 @@ implements <a href="http://docs.oracle.c
<h4>defaultFieldPackage</h4>
<pre>public static final <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.67">defaultFieldPackage</a></pre>
<div class="block">Default Field Package</div>
-<dl>
-<dt><span class="seeLabel">See Also:</span></dt>
-<dd><a
href="../../../../../constant-values.html#org.apache.fulcrum.intake.model.Field.defaultFieldPackage">Constant
Field Values</a></dd>
-</dl>
+<dl><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../constant-values.html#org.apache.fulcrum.intake.model.Field.defaultFieldPackage">Constant
Field Values</a></dd></dl>
</li>
</ul>
<a name="mapToObject">
@@ -617,40 +594,36 @@ implements <a href="http://docs.oracle.c
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
-<li class="blockList"><a name="constructor.detail">
+<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
-<a
name="Field-org.apache.fulcrum.intake.model.XmlField-org.apache.fulcrum.intake.model.Group-">
+<a name="Field(org.apache.fulcrum.intake.model.XmlField,
org.apache.fulcrum.intake.model.Group)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Field</h4>
<pre>public <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.181">Field</a>(<a
href="../../../../../org/apache/fulcrum/intake/model/XmlField.html"
title="class in org.apache.fulcrum.intake.model">XmlField</a> field,
- <a
href="../../../../../org/apache/fulcrum/intake/model/Group.html" title="class
in org.apache.fulcrum.intake.model">Group</a> group)
+ <a href="../../../../../org/apache/fulcrum/intake/model/Group.html"
title="class in org.apache.fulcrum.intake.model">Group</a> group)
throws <a
href="../../../../../org/apache/fulcrum/intake/IntakeException.html"
title="class in org.apache.fulcrum.intake">IntakeException</a></pre>
<div class="block">Constructs a field based on data in the xml specification
and assigns it to a Group.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>field</code> - a <code>XmlField</code> value</dd>
-<dd><code>group</code> - a <code>Group</code> value</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>field</code> - a
<code>XmlField</code> value</dd><dd><code>group</code> - a <code>Group</code>
value</dd>
+<dt><span class="strong">Throws:</span></dt>
<dd><code><a
href="../../../../../org/apache/fulcrum/intake/IntakeException.html"
title="class in org.apache.fulcrum.intake">IntakeException</a></code> -
indicates the validator was not valid or
- could not be loaded.</dd>
-</dl>
+ could not be loaded.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
-<li class="blockList"><a name="method.detail">
+<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
-<a name="enableLogging-org.apache.avalon.framework.logger.Logger-">
+<a name="enableLogging(org.apache.avalon.framework.logger.Logger)">
<!-- -->
</a>
<ul class="blockList">
@@ -659,12 +632,12 @@ implements <a href="http://docs.oracle.c
<pre>public void <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.248">enableLogging</a>(org.apache.avalon.framework.logger.Logger logger)</pre>
<div class="block">Enable Avalon Logging</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
+<dt><strong>Specified by:</strong></dt>
<dd><code>enableLogging</code> in
interface <code>org.apache.avalon.framework.logger.LogEnabled</code></dd>
</dl>
</li>
</ul>
-<a name="initGetterAndSetter--">
+<a name="initGetterAndSetter()">
<!-- -->
</a>
<ul class="blockList">
@@ -674,7 +647,7 @@ implements <a href="http://docs.oracle.c
<div class="block">Initialize getter and setter from properties</div>
</li>
</ul>
-<a name="init-org.apache.fulcrum.parser.ValueParser-">
+<a name="init(org.apache.fulcrum.parser.ValueParser)">
<!-- -->
</a>
<ul class="blockList">
@@ -686,18 +659,14 @@ implements <a href="http://docs.oracle.c
pulled from the pool. The request data is searched to determine
if a value has been supplied for this field. If so, the value
is validated.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>pp</code> - a <code>ValueParser</code> value</dd>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <code>Field</code> value</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pp</code> - a
<code>ValueParser</code> value</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <code>Field</code>
value</dd>
+<dt><span class="strong">Throws:</span></dt>
<dd><code><a
href="../../../../../org/apache/fulcrum/intake/IntakeException.html"
title="class in org.apache.fulcrum.intake">IntakeException</a></code> - this
exception is only thrown by subclasses
- overriding this implementation.</dd>
-</dl>
+ overriding this implementation.</dd></dl>
</li>
</ul>
-<a name="init-org.apache.fulcrum.intake.Retrievable-">
+<a name="init(org.apache.fulcrum.intake.Retrievable)">
<!-- -->
</a>
<ul class="blockList">
@@ -708,15 +677,11 @@ implements <a href="http://docs.oracle.c
pulled from the pool. The retrievable object can provide
a default value for the field, or using setProperty the field's
value can be transferred to the retrievable.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>obj</code> - a <code>Retrievable</code> value</dd>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <code>Field</code> value</dd>
-</dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - a
<code>Retrievable</code> value</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <code>Field</code>
value</dd></dl>
</li>
</ul>
-<a name="getGroup--">
+<a name="getGroup()">
<!-- -->
</a>
<ul class="blockList">
@@ -725,13 +690,10 @@ implements <a href="http://docs.oracle.c
<pre>public <a
href="../../../../../org/apache/fulcrum/intake/model/Group.html" title="class
in org.apache.fulcrum.intake.model">Group</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.362">getGroup</a>()</pre>
<div class="block">Returns the <code>Group</code> this field belongs to
or <code>null</code> if unknown.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>The group this field belongs to.</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>The group this field
belongs to.</dd></dl>
</li>
</ul>
-<a name="getLocale--">
+<a name="getLocale()">
<!-- -->
</a>
<ul class="blockList">
@@ -740,13 +702,10 @@ implements <a href="http://docs.oracle.c
<pre>public <a
href="http://docs.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true"
title="class or interface in java.util">Locale</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.373">getLocale</a>()</pre>
<div class="block">Returns the <code>Locale</code> used when localizing data
for
this field, or <code>null</code> if unknown.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>Where to localize for.</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>Where to localize
for.</dd></dl>
</li>
</ul>
-<a name="getDefaultValidator--">
+<a name="getDefaultValidator()">
<!-- -->
</a>
<ul class="blockList">
@@ -754,13 +713,10 @@ implements <a href="http://docs.oracle.c
<h4>getDefaultValidator</h4>
<pre>protected <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.383">getDefaultValidator</a>()</pre>
<div class="block">Produces the fully qualified class name of the default
validator.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>class name of the default validator</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>class name of the default
validator</dd></dl>
</li>
</ul>
-<a name="getValidator--">
+<a name="getValidator()">
<!-- -->
</a>
<ul class="blockList">
@@ -768,13 +724,10 @@ implements <a href="http://docs.oracle.c
<h4>getValidator</h4>
<pre>public <a
href="../../../../../org/apache/fulcrum/intake/validator/Validator.html"
title="interface in org.apache.fulcrum.intake.validator">Validator</a><<a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a>> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.392">getValidator</a>()</pre>
<div class="block">Gets the Validator object for this field.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <code>Validator</code> object</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>Validator</code>
object</dd></dl>
</li>
</ul>
-<a name="getMapToObject--">
+<a name="getMapToObject()">
<!-- -->
</a>
<ul class="blockList">
@@ -782,13 +735,10 @@ implements <a href="http://docs.oracle.c
<h4>getMapToObject</h4>
<pre>public <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.413">getMapToObject</a>()</pre>
<div class="block">Get the name of the object that takes this input</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the name of the mapped object</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the name of the mapped
object</dd></dl>
</li>
</ul>
-<a name="isMultiValued--">
+<a name="isMultiValued()">
<!-- -->
</a>
<ul class="blockList">
@@ -796,13 +746,10 @@ implements <a href="http://docs.oracle.c
<h4>isMultiValued</h4>
<pre>public boolean <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.423">isMultiValued</a>()</pre>
<div class="block">Flag to determine whether the field has been declared as
multi-valued.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>value of isMultiValued.</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>value of
isMultiValued.</dd></dl>
</li>
</ul>
-<a name="isRequired--">
+<a name="isRequired()">
<!-- -->
</a>
<ul class="blockList">
@@ -810,13 +757,10 @@ implements <a href="http://docs.oracle.c
<h4>isRequired</h4>
<pre>public boolean <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.433">isRequired</a>()</pre>
<div class="block">Flag to determine whether the field has been declared as
required.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>value of required.</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>value of
required.</dd></dl>
</li>
</ul>
-<a name="setRequired-boolean-">
+<a name="setRequired(boolean)">
<!-- -->
</a>
<ul class="blockList">
@@ -826,29 +770,22 @@ implements <a href="http://docs.oracle.c
<div class="block">Set whether this field is required to have a value. If the
field
is already required due to a setting in the XML file, this method
can not set it to false.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>v</code> - Value to assign to required.</dd>
-</dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - Value
to assign to required.</dd></dl>
</li>
</ul>
-<a name="setRequired-boolean-java.lang.String-">
+<a name="setRequired(boolean, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRequired</h4>
<pre>public void <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.456">setRequired</a>(boolean v,
- <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> message)</pre>
+ <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> message)</pre>
<div class="block">Set the value of required.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>v</code> - a <code>boolean</code> value</dd>
-<dd><code>message</code> - override the value from intake.xml</dd>
-</dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>v</code> - a
<code>boolean</code> value</dd><dd><code>message</code> - override the value
from intake.xml</dd></dl>
</li>
</ul>
-<a name="removeFromRequest--">
+<a name="removeFromRequest()">
<!-- -->
</a>
<ul class="blockList">
@@ -859,7 +796,7 @@ implements <a href="http://docs.oracle.c
query parameters</div>
</li>
</ul>
-<a name="dispose--">
+<a name="dispose()">
<!-- -->
</a>
<ul class="blockList">
@@ -871,7 +808,7 @@ implements <a href="http://docs.oracle.c
if overridden, super.dispose() should be called.</div>
</li>
</ul>
-<a name="getKey--">
+<a name="getKey()">
<!-- -->
</a>
<ul class="blockList">
@@ -879,13 +816,10 @@ implements <a href="http://docs.oracle.c
<h4>getKey</h4>
<pre>public <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.505">getKey</a>()</pre>
<div class="block">Get the key used to identify the field.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the query data key.</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the query data
key.</dd></dl>
</li>
</ul>
-<a name="getValueIfAbsent--">
+<a name="getValueIfAbsent()">
<!-- -->
</a>
<ul class="blockList">
@@ -895,13 +829,10 @@ implements <a href="http://docs.oracle.c
<div class="block">Use in a hidden field assign a default value in the event
the
field is absent from the query parameters. Used to track checkboxes,
since they only show up if checked.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the value if not in the request</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the value if not in the
request</dd></dl>
</li>
</ul>
-<a name="isValid--">
+<a name="isValid()">
<!-- -->
</a>
<ul class="blockList">
@@ -911,13 +842,10 @@ implements <a href="http://docs.oracle.c
<div class="block">Flag set to true, if the test value met the constraints.
Is also true, in the case the test value was not set,
unless this field has been marked as required.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <code>boolean</code> value</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>boolean</code>
value</dd></dl>
</li>
</ul>
-<a name="isValidated--">
+<a name="isValidated()">
<!-- -->
</a>
<ul class="blockList">
@@ -925,13 +853,10 @@ implements <a href="http://docs.oracle.c
<h4>isValidated</h4>
<pre>public boolean <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.539">isValidated</a>()</pre>
<div class="block">Flag to determine whether the field has been
validated.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>value of validated.</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>value of
validated.</dd></dl>
</li>
</ul>
-<a name="isSet--">
+<a name="isSet()">
<!-- -->
</a>
<ul class="blockList">
@@ -942,13 +867,10 @@ implements <a href="http://docs.oracle.c
an empty value, so don't used this to determine if the field contains a
non-empty value). Validation will only be executed for fields that have
been set in this manner.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <code>boolean</code> value</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>boolean</code>
value</dd></dl>
</li>
</ul>
-<a name="getDisplayName--">
+<a name="getDisplayName()">
<!-- -->
</a>
<ul class="blockList">
@@ -958,13 +880,10 @@ implements <a href="http://docs.oracle.c
<div class="block">Get the display name of the field. Useful for building
data entry forms. Returns name of field if no display
name has been assigned to the field by xml input file.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <code>String</code> value</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
value</dd></dl>
</li>
</ul>
-<a name="setDisplayName-java.lang.String-">
+<a name="setDisplayName(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
@@ -975,13 +894,10 @@ implements <a href="http://docs.oracle.c
used in building data entry forms and serve as a
user friendly description of the data contained in
the field.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>newDisplayName</code> - the new display name for the field</dd>
-</dl>
+<dl><dt><span
class="strong">Parameters:</span></dt><dd><code>newDisplayName</code> - the new
display name for the field</dd></dl>
</li>
</ul>
-<a name="getMessage--">
+<a name="getMessage()">
<!-- -->
</a>
<ul class="blockList">
@@ -989,13 +905,10 @@ implements <a href="http://docs.oracle.c
<h4>getMessage</h4>
<pre>public <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.587">getMessage</a>()</pre>
<div class="block">Get any error message resulting from invalid input.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <code>String</code> value</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
value</dd></dl>
</li>
</ul>
-<a name="setMessage-java.lang.String-">
+<a name="setMessage(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
@@ -1003,13 +916,10 @@ implements <a href="http://docs.oracle.c
<h4>setMessage</h4>
<pre>public void <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.597">setMessage</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> message)</pre>
<div class="block">Sets an error message. The field is also marked as
invalid.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>message</code> - the new error message</dd>
-</dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>message</code> -
the new error message</dd></dl>
</li>
</ul>
-<a name="setSet-boolean-">
+<a name="setSet(boolean)">
<!-- -->
</a>
<ul class="blockList">
@@ -1017,13 +927,10 @@ implements <a href="http://docs.oracle.c
<h4>setSet</h4>
<pre>protected void <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.608">setSet</a>(boolean setFlag)</pre>
<div class="block">Set the internal flag that the field has been set</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>setFlag</code> - the setFlag to set</dd>
-</dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>setFlag</code> -
the setFlag to set</dd></dl>
</li>
</ul>
-<a name="setValid-boolean-">
+<a name="setValid(boolean)">
<!-- -->
</a>
<ul class="blockList">
@@ -1031,13 +938,10 @@ implements <a href="http://docs.oracle.c
<h4>setValid</h4>
<pre>protected void <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.618">setValid</a>(boolean validFlag)</pre>
<div class="block">Set the internal flag that the field is valid</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>validFlag</code> - the validFlag to set</dd>
-</dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>validFlag</code>
- the validFlag to set</dd></dl>
</li>
</ul>
-<a name="setValidated-boolean-">
+<a name="setValidated(boolean)">
<!-- -->
</a>
<ul class="blockList">
@@ -1045,13 +949,10 @@ implements <a href="http://docs.oracle.c
<h4>setValidated</h4>
<pre>protected void <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.628">setValidated</a>(boolean validated)</pre>
<div class="block">Set the internal flag that the field has been
validated</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>validated</code> - the validated to set</dd>
-</dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>validated</code>
- the validated to set</dd></dl>
</li>
</ul>
-<a name="validate--">
+<a name="validate()">
<!-- -->
</a>
<ul class="blockList">
@@ -1059,13 +960,10 @@ implements <a href="http://docs.oracle.c
<h4>validate</h4>
<pre>public boolean <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.638">validate</a>()</pre>
<div class="block">Compares request data with constraints and sets the valid
flag.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>true if the validation succeeded</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if the validation
succeeded</dd></dl>
</li>
</ul>
-<a name="setDefaultValue-java.lang.String-">
+<a name="setDefaultValue(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
@@ -1074,13 +972,10 @@ implements <a href="http://docs.oracle.c
<pre>public abstract void <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.724">setDefaultValue</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> prop)</pre>
<div class="block">Set the default Value. This value is used if
Intake should map this field to a new object.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>prop</code> - The value to use if the field is mapped to a new
object.</dd>
-</dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prop</code> -
The value to use if the field is mapped to a new object.</dd></dl>
</li>
</ul>
-<a name="setEmptyValue-java.lang.String-">
+<a name="setEmptyValue(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
@@ -1091,13 +986,10 @@ implements <a href="http://docs.oracle.c
maps a field to a parameter returned by the user and
the corresponding field is either empty (empty string)
or non-existent.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>prop</code> - The value to use if the field is empty.</dd>
-</dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prop</code> -
The value to use if the field is empty.</dd></dl>
</li>
</ul>
-<a name="doSetValue--">
+<a name="doSetValue()">
<!-- -->
</a>
<ul class="blockList">
@@ -1107,7 +999,7 @@ implements <a href="http://docs.oracle.c
<div class="block">Sets the value of the field from data in the parser.</div>
</li>
</ul>
-<a name="getInitialValue--">
+<a name="getInitialValue()">
<!-- -->
</a>
<ul class="blockList">
@@ -1119,16 +1011,13 @@ implements <a href="http://docs.oracle.c
not been set and a <code>Retrievable</code> object has
been associated with this field, the objects property will
be used as the initial value.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>an <code>Object</code> value</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Object</code>
value</dd>
+<dt><span class="strong">Throws:</span></dt>
<dd><code><a
href="../../../../../org/apache/fulcrum/intake/IntakeException.html"
title="class in org.apache.fulcrum.intake">IntakeException</a></code> -
indicates the value could not be
- returned from the mapped object</dd>
-</dl>
+ returned from the mapped object</dd></dl>
</li>
</ul>
-<a name="getTestValue--">
+<a name="getTestValue()">
<!-- -->
</a>
<ul class="blockList">
@@ -1136,15 +1025,11 @@ implements <a href="http://docs.oracle.c
<h4>getTestValue</h4>
<pre>public <TT> TT <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.796">getTestValue</a>()</pre>
<div class="block">Get the value input by a user that will be validated.</div>
-<dl>
-<dt><span class="paramLabel">Type Parameters:</span></dt>
-<dd><code>TT</code> - the type of the test value</dd>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>an <code>TT</code> value</dd>
-</dl>
+<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>TT</code> -
the type of the test value</dd>
+<dt><span class="strong">Returns:</span></dt><dd>an <code>TT</code>
value</dd></dl>
</li>
</ul>
-<a name="getValue--">
+<a name="getValue()">
<!-- -->
</a>
<ul class="blockList">
@@ -1157,13 +1042,10 @@ implements <a href="http://docs.oracle.c
is returned even though invalid, so that it can be returned to
the user to make modifications. If the test value is not set
the initial value is returned.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>an <code>Object</code> value</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an <code>Object</code>
value</dd></dl>
</li>
</ul>
-<a name="toString--">
+<a name="toString()">
<!-- -->
</a>
<ul class="blockList">
@@ -1173,14 +1055,12 @@ implements <a href="http://docs.oracle.c
<div class="block">Calls toString() on the object returned by getValue(),
unless null; and then it returns "", the empty String.</div>
<dl>
-<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
-<dd><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString--"
title="class or interface in java.lang">toString</a></code> in
class <code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a></code></dd>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <code>String</code> value</dd>
-</dl>
+<dt><strong>Overrides:</strong></dt>
+<dd><code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()"
title="class or interface in java.lang">toString</a></code> in
class <code><a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
value</dd></dl>
</li>
</ul>
-<a name="getHTMLString--">
+<a name="getHTMLString()">
<!-- -->
</a>
<ul class="blockList">
@@ -1191,13 +1071,10 @@ implements <a href="http://docs.oracle.c
unless null; and then it returns "", the empty String.
Escapes " characters to be able to display these
in HTML form fields.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>a <code>String</code> value</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>String</code>
value</dd></dl>
</li>
</ul>
-<a name="getProperty-java.lang.Object-">
+<a name="getProperty(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
@@ -1206,16 +1083,13 @@ implements <a href="http://docs.oracle.c
<pre>public void <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.876">getProperty</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a> obj)
throws <a
href="../../../../../org/apache/fulcrum/intake/IntakeException.html"
title="class in org.apache.fulcrum.intake">IntakeException</a></pre>
<div class="block">Loads the valid value from a bean</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>obj</code> - the object whose getter to call</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - the
object whose getter to call</dd>
+<dt><span class="strong">Throws:</span></dt>
<dd><code><a
href="../../../../../org/apache/fulcrum/intake/IntakeException.html"
title="class in org.apache.fulcrum.intake">IntakeException</a></code> -
indicates a problem during the execution of the
- object's getter method</dd>
-</dl>
+ object's getter method</dd></dl>
</li>
</ul>
-<a name="getDefault--">
+<a name="getDefault()">
<!-- -->
</a>
<ul class="blockList">
@@ -1225,7 +1099,7 @@ implements <a href="http://docs.oracle.c
<div class="block">Loads the default value from the object</div>
</li>
</ul>
-<a name="setProperty-java.lang.Object-">
+<a name="setProperty(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
@@ -1234,16 +1108,13 @@ implements <a href="http://docs.oracle.c
<pre>public void <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.918">setProperty</a>(<a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a> obj)
throws <a
href="../../../../../org/apache/fulcrum/intake/IntakeException.html"
title="class in org.apache.fulcrum.intake">IntakeException</a></pre>
<div class="block">Calls a setter method on obj, if this field has been
set.</div>
-<dl>
-<dt><span class="paramLabel">Parameters:</span></dt>
-<dd><code>obj</code> - the object whose setter to call</dd>
-<dt><span class="throwsLabel">Throws:</span></dt>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - the
object whose setter to call</dd>
+<dt><span class="strong">Throws:</span></dt>
<dd><code><a
href="../../../../../org/apache/fulcrum/intake/IntakeException.html"
title="class in org.apache.fulcrum.intake">IntakeException</a></code> -
indicates a problem during the execution of the
- object's setter method</dd>
-</dl>
+ object's setter method</dd></dl>
</li>
</ul>
-<a name="getDefaultValue--">
+<a name="getDefaultValue()">
<!-- -->
</a>
<ul class="blockList">
@@ -1251,13 +1122,10 @@ implements <a href="http://docs.oracle.c
<h4>getDefaultValue</h4>
<pre>public <a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.1012">getDefaultValue</a>()</pre>
<div class="block">Get the default Value</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the default value</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the default
value</dd></dl>
</li>
</ul>
-<a name="getEmptyValue--">
+<a name="getEmptyValue()">
<!-- -->
</a>
<ul class="blockList">
@@ -1265,13 +1133,10 @@ implements <a href="http://docs.oracle.c
<h4>getEmptyValue</h4>
<pre>public <a
href="../../../../../org/apache/fulcrum/intake/model/Field.html" title="type
parameter in Field">T</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.1022">getEmptyValue</a>()</pre>
<div class="block">Get the Value to use if the field is empty</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the value to use if the field is empty.</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the value to use if the
field is empty.</dd></dl>
</li>
</ul>
-<a name="getSafeEmptyValue--">
+<a name="getSafeEmptyValue()">
<!-- -->
</a>
<ul class="blockList">
@@ -1283,14 +1148,11 @@ implements <a href="http://docs.oracle.c
that deal with primitive types should ensure that they return an
appropriate value wrapped in the object wrapper class for the
primitive type.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the value to use when the field is empty or an Object that
- wraps the empty value for primitive types.</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the value to use when the
field is empty or an Object that
+ wraps the empty value for primitive types.</dd></dl>
</li>
</ul>
-<a name="getName--">
+<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
@@ -1298,13 +1160,10 @@ implements <a href="http://docs.oracle.c
<h4>getName</h4>
<pre>public <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true"
title="class or interface in java.lang">String</a> <a
href="../../../../../src-html/org/apache/fulcrum/intake/model/Field.html#line.1047">getName</a>()</pre>
<div class="block">Gets the name of the field.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>name of the field as specified in the XML file.</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>name of the field as
specified in the XML file.</dd></dl>
</li>
</ul>
-<a name="getDisplaySize--">
+<a name="getDisplaySize()">
<!-- -->
</a>
<ul class="blockList">
@@ -1314,13 +1173,10 @@ implements <a href="http://docs.oracle.c
<div class="block">Gets the display size of the field. This is useful when
building the HTML input tag. If no displaySize was set,
an empty string is returned.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the size information for this field</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the size information for
this field</dd></dl>
</li>
</ul>
-<a name="getMaxSize--">
+<a name="getMaxSize()">
<!-- -->
</a>
<ul class="blockList">
@@ -1330,13 +1186,10 @@ implements <a href="http://docs.oracle.c
<div class="block">Gets the maximum size of the field. This is useful when
building the HTML input tag. The maxSize is set with the maxLength
rule. If this rule was not set, an empty string is returned.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the maximum size information of the field</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the maximum size
information of the field</dd></dl>
</li>
</ul>
-<a name="getStringValue--">
+<a name="getStringValue()">
<!-- -->
</a>
<ul class="blockListLast">
@@ -1349,10 +1202,7 @@ implements <a href="http://docs.oracle.c
method which returns the actual Object.
This is useful for displaying correctly formatted data such as dates,
such as 18/11/1968 instead of the toString dump of a Date Object.</div>
-<dl>
-<dt><span class="returnLabel">Returns:</span></dt>
-<dd>the String Value</dd>
-</dl>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the String Value</dd></dl>
</li>
</ul>
</li>
@@ -1363,11 +1213,9 @@ implements <a href="http://docs.oracle.c
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
-<div class="bottomNav"><a name="navbar.bottom">
+<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
-</a>
-<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation
links">Skip navigation links</a></div>
-<a name="navbar.bottom.firstrow">
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a
name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
@@ -1383,15 +1231,15 @@ implements <a href="http://docs.oracle.c
</div>
<div class="subNav">
<ul class="navList">
-<li><a href="../../../../../org/apache/fulcrum/intake/model/DoubleField.html"
title="class in org.apache.fulcrum.intake.model"><span
class="typeNameLink">Prev Class</span></a></li>
-<li><a href="../../../../../org/apache/fulcrum/intake/model/FieldAdapter.html"
title="class in org.apache.fulcrum.intake.model"><span
class="typeNameLink">Next Class</span></a></li>
+<li><a href="../../../../../org/apache/fulcrum/intake/model/DoubleField.html"
title="class in org.apache.fulcrum.intake.model"><span class="strong">Prev
Class</span></a></li>
+<li><a href="../../../../../org/apache/fulcrum/intake/model/FieldAdapter.html"
title="class in org.apache.fulcrum.intake.model"><span class="strong">Next
Class</span></a></li>
</ul>
<ul class="navList">
<li><a
href="../../../../../index.html?org/apache/fulcrum/intake/model/Field.html"
target="_top">Frames</a></li>
-<li><a href="Field.html" target="_top">No Frames</a></li>
+<li><a href="Field.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
-<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
+<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
@@ -1409,18 +1257,18 @@ implements <a href="http://docs.oracle.c
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
-<li><a href="#field.summary">Field</a> | </li>
-<li><a href="#constructor.summary">Constr</a> | </li>
-<li><a href="#method.summary">Method</a></li>
+<li><a href="#field_summary">Field</a> | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
-<li><a href="#field.detail">Field</a> | </li>
-<li><a href="#constructor.detail">Constr</a> | </li>
-<li><a href="#method.detail">Method</a></li>
+<li><a href="#field_detail">Field</a> | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
</ul>
</div>
-<a name="skip.navbar.bottom">
+<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->