org.apache.turbine.services.intake.xmlmodel
Class XmlField

java.lang.Object
  org.apache.turbine.services.intake.xmlmodel.XmlField

All Implemented Interfaces:

java.io.Serializable

public class XmlField

extends java.lang.Object

implements java.io.Serializable

A Class for holding data about a property used in an Application.

Version:

$Id: XmlField.java 534527 2007-05-02 16:10:59Z tv $

Author:

John McNally, Henning P. Schmiedehausen, Quinton McCombs, Thomas Vandahl

See Also:

Serialized Form

Constructor Summary

XmlField()
Default Constructor

XmlField(java.lang.String name)
Creates a new column and set the name

Method Summary

Rule	addRule(org.xml.sax.Attributes attrib) A utility function to create a new input parameter from attrib and add it to this property.
void	addRule(Rule rule) Adds a new rule to the parameter Map and set the parent property of the Rule to this property
java.lang.String	getDefaultValue() Get the default Value.
java.lang.String	getDisplayName() Get the display name of the property
java.lang.String	getDisplaySize() Gets the display size of the field.
java.lang.String	getEmptyValue() Get the empty Value.
java.lang.String	getFieldClass() Get the value of fieldClass.
XmlGroup	getGroup() Get the parent XmlGroup of the property
java.lang.String	getIfRequiredMessage() Get the value of ifRequiredMessage.
java.lang.String	getKey() Get the parameter key of the property
java.lang.String	getMapToObject() Get the name of the object that takes this input
java.lang.String	getMapToProperty() Get the property method that takes this input
java.lang.String	getName() Get the name of the property
java.lang.String	getRawName() Get the name of the property
java.util.Map	getRuleMap() The collection of rules for this field keyed by parameter name.
java.util.List	getRules() The collection of rules for this field.
java.lang.String	getType() Get the type of the property
java.lang.String	getValidator() Get the className of the validator
java.lang.String	getVariable() Deprecated. No replacement
boolean	isMultiValued() can this field have several values?
void	loadFromXML(org.xml.sax.Attributes attrib) Imports a column from an XML specification
void	setDefaultValue(java.lang.String prop) Set the default Value.
void	setDisplayName(java.lang.String newDisplayName) Set the display name of the property
void	setEmptyValue(java.lang.String prop) Set the empty Value.
void	setFieldClass(java.lang.String v) Set the value of fieldClass.
void	setGroup(XmlGroup parent) Set the parent XmlGroup of the property
void	setIfRequiredMessage(java.lang.String v) Set the value of ifRequiredMessage.
void	setKey(java.lang.String newKey) Set the parameter key of the property
void	setMapToObject(java.lang.String objectName) Set the name of the object that takes this input
void	setMapToProperty(java.lang.String prop) Set the property method that takes this input
void	setMultiValued(java.lang.String newMultiValued) Set whether this class can have multiple values
void	setName(java.lang.String newName) Set the name of the property
void	setType(java.lang.String newType) Set the type of the property
void	setValidator(java.lang.String prop) Set the class name of the validator
java.lang.String	toString() String representation of the column.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XmlField

public XmlField()

Default Constructor

XmlField

public XmlField(java.lang.String name)

Creates a new column and set the name

Method Detail

loadFromXML

public void loadFromXML(org.xml.sax.Attributes attrib)

Imports a column from an XML specification

getRawName

public java.lang.String getRawName()

Get the name of the property

getName

public java.lang.String getName()

Get the name of the property

setName

public void setName(java.lang.String newName)

Set the name of the property

getDisplayName

public java.lang.String getDisplayName()

Get the display name of the property

setDisplayName

public void setDisplayName(java.lang.String newDisplayName)

Set the display name of the property

getDisplaySize

public java.lang.String getDisplaySize()

Gets the display size of the field. This is useful for constructing the HTML input tag.

setKey

public void setKey(java.lang.String newKey)

Set the parameter key of the property

getKey

public java.lang.String getKey()

Get the parameter key of the property

setType

public void setType(java.lang.String newType)

Set the type of the property

getType

public java.lang.String getType()

Get the type of the property

setMultiValued

public void setMultiValued(java.lang.String newMultiValued)

Set whether this class can have multiple values

isMultiValued

public boolean isMultiValued()

can this field have several values?

setMapToObject

public void setMapToObject(java.lang.String objectName)

Set the name of the object that takes this input

Parameters:

objectName - name of the class.

getMapToObject

public java.lang.String getMapToObject()

Get the name of the object that takes this input

setMapToProperty

public void setMapToProperty(java.lang.String prop)

Set the property method that takes this input

Parameters:

prop - Name of the property to which the field will be mapped.

getMapToProperty

public java.lang.String getMapToProperty()

Get the property method that takes this input

setValidator

public void setValidator(java.lang.String prop)

Set the class name of the validator

getValidator

public java.lang.String getValidator()

Get the className of the validator

setDefaultValue

public void setDefaultValue(java.lang.String prop)

Set the default Value.

Parameters:

prop - The parameter to use as default value.

getDefaultValue

public java.lang.String getDefaultValue()

Get the default Value.

Returns:

The default value for this field.

setEmptyValue

public void setEmptyValue(java.lang.String prop)

Set the empty Value.

Parameters:

prop - The parameter to use as empty value.

getEmptyValue

public java.lang.String getEmptyValue()

Get the empty Value.

Returns:

The empty value for this field.

getVariable

public java.lang.String getVariable()

Deprecated. No replacement

The name of the field making sure the first letter is lowercase.

Returns:

a String value

setGroup

public void setGroup(XmlGroup parent)

Set the parent XmlGroup of the property

getGroup

public XmlGroup getGroup()

Get the parent XmlGroup of the property

getIfRequiredMessage

public java.lang.String getIfRequiredMessage()

Get the value of ifRequiredMessage.

Returns:

value of ifRequiredMessage.

setIfRequiredMessage

public void setIfRequiredMessage(java.lang.String v)

Set the value of ifRequiredMessage.

Parameters:

v - Value to assign to ifRequiredMessage.

getFieldClass

public java.lang.String getFieldClass()

Get the value of fieldClass.

Returns:

value of fieldClass.

setFieldClass

public void setFieldClass(java.lang.String v)

Set the value of fieldClass.

Parameters:

v - Value to assign to fieldClass.

addRule

public Rule addRule(org.xml.sax.Attributes attrib)

A utility function to create a new input parameter from attrib and add it to this property.

addRule

public void addRule(Rule rule)

Adds a new rule to the parameter Map and set the parent property of the Rule to this property

getRules

public java.util.List getRules()

The collection of rules for this field.

Returns:

a List value

getRuleMap

public java.util.Map getRuleMap()

The collection of rules for this field keyed by parameter name.

Returns:

a Map value

toString

public java.lang.String toString()

String representation of the column. This is an xml representation.