Package org.apache.fulcrum.intake.model
Class XmlField
java.lang.Object
org.apache.fulcrum.intake.model.XmlField
- All Implemented Interfaces:
Serializable
,org.apache.avalon.framework.logger.LogEnabled
public class XmlField
extends Object
implements Serializable, org.apache.avalon.framework.logger.LogEnabled
A Class for holding data about a property used in an Application.
- Version:
- $Id$
- Author:
- John McNally, Henning P. Schmiedehausen, Quinton McCombs, Thomas Vandahl
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
afterUnmarshal
(jakarta.xml.bind.Unmarshaller um, Object parent) JAXB callback to set the parent objectvoid
enableLogging
(org.apache.avalon.framework.logger.Logger logger) Enable Avalon LoggingGet the default Value.Get the display name of the propertyGets the display size of the field.Get the empty Value.Get the value of fieldClass.getGroup()
Get the parent XmlGroup of the fieldgetKey()
Get the parameter key of the propertyorg.apache.avalon.framework.logger.Logger
Return Avalon loggerGet the name of the object that takes this inputGet the property method that takes this inputgetName()
Get the name of the propertyGet the name of the propertyThe collection of rules for this field keyed by parameter name.getRules()
The collection of rules for this field.getType()
Get the type of the propertyGet the className of the validatorboolean
Can this field have several values?void
Set the collection of rules for this fieldtoString()
String representation of the column.
-
Constructor Details
-
XmlField
public XmlField()Default Constructor
-
-
Method Details
-
enableLogging
public void enableLogging(org.apache.avalon.framework.logger.Logger logger) Enable Avalon Logging- Specified by:
enableLogging
in interfaceorg.apache.avalon.framework.logger.LogEnabled
-
getLogger
public org.apache.avalon.framework.logger.Logger getLogger()Return Avalon logger- Returns:
- the logger
-
getRawName
Get the name of the property- Returns:
- the raw name of the property
-
getName
Get the name of the property- Returns:
- the name of the property with underscores removed
-
getDisplayName
Get the display name of the property- Returns:
- the display name of the property
-
getDisplaySize
Gets the display size of the field. This is useful for constructing the HTML input tag.- Returns:
- the display size for the field
-
getKey
Get the parameter key of the property- Returns:
- the key of the property
-
getType
Get the type of the property- Returns:
- the type of the field
-
isMultiValued
public boolean isMultiValued()Can this field have several values?- Returns:
- true if the field can have multiple values
-
getMapToObject
Get the name of the object that takes this input- Returns:
- the name of the mapped object
-
getMapToProperty
Get the property method that takes this input- Returns:
- the property this field is mapped to
-
getValidator
Get the className of the validator- Returns:
- the validator class name
-
getDefaultValue
Get the default Value.- Returns:
- The default value for this field.
-
getEmptyValue
Get the empty Value.- Returns:
- The empty value for this field.
-
getGroup
Get the parent XmlGroup of the field- Returns:
- the group this field belongs to
-
getFieldClass
Get the value of fieldClass.- Returns:
- value of fieldClass.
-
getRules
The collection of rules for this field.- Returns:
- a
List
value
-
setRules
Set the collection of rules for this field- Parameters:
rules
- the rules to set
-
getRuleMap
The collection of rules for this field keyed by parameter name.- Returns:
- a
Map
value
-
afterUnmarshal
JAXB callback to set the parent object- Parameters:
um
- the Unmarshallerparent
- the parent object (an XmlGroup)
-
toString
String representation of the column. This is an xml representation.
-