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

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

All Implemented Interfaces:

java.io.Serializable

public class XmlGroup

extends java.lang.Object

implements java.io.Serializable

A Class for holding data about a grouping of inputs used in an Application.

Version:

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

Author:

Serialized Form

Constructor Summary

XmlGroup()
Constructs a input group object

Method Summary

XmlField	addField(org.xml.sax.Attributes attrib) A utility function to create a new field from attrib and add it to this input group.
void	addField(XmlField field) Adds a new field to the fields list and set the parent group of the field to the current group
boolean	containsField(java.lang.String name) Returns true if the input group contains a specified field
boolean	containsField(XmlField field) Returns true if the input group contains a spesified field
AppData	getAppData() Get the parent of the input group
XmlField	getField(java.lang.String name) Returns a Specified field.
java.util.List	getFields() Returns a collection of fields in this input group
java.lang.String	getKey() Get the key used to reference this group in input (form)
java.util.List	getMapToObjects()
java.lang.String	getName() Get the name that handles this group
int	getNumFields() Utility method to get the number of fields in this input group
java.lang.String	getPoolCapacity() The maximum number of classes specific to this group allowed at one time.
java.lang.String	getVariable() A String which might be used as a variable of this class
void	loadFromXML(org.xml.sax.Attributes attrib) Load the input group object from an xml tag.
void	setAppData(AppData parent) Set the parent of the group
void	setKey(java.lang.String newKey) Set the key used to reference this group in input (form)
void	setName(java.lang.String newGroupName) Set the name that handles this group
java.lang.String	toString() Creates a string representation of this input group.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlGroup

public XmlGroup()

Constructs a input group object

Method Detail

loadFromXML

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

Load the input group object from an xml tag.

getName

public java.lang.String getName()

Get the name that handles this group

setName

public void setName(java.lang.String newGroupName)

Set the name that handles this group

getKey

public java.lang.String getKey()

Get the key used to reference this group in input (form)

setKey

public void setKey(java.lang.String newKey)

Set the key used to reference this group in input (form)

getPoolCapacity

public java.lang.String getPoolCapacity()

The maximum number of classes specific to this group allowed at one time.

Returns:

an String value

addField

public XmlField addField(org.xml.sax.Attributes attrib)

A utility function to create a new field from attrib and add it to this input group.

addField

public void addField(XmlField field)

Adds a new field to the fields list and set the parent group of the field to the current group

getFields

public java.util.List getFields()

Returns a collection of fields in this input group

getNumFields

public int getNumFields()

Utility method to get the number of fields in this input group

getField

public XmlField getField(java.lang.String name)

Returns a Specified field.

Returns:

Return a XmlField object or null if it does not exist.

containsField

public boolean containsField(XmlField field)

Returns true if the input group contains a spesified field

containsField

public boolean containsField(java.lang.String name)

Returns true if the input group contains a specified field

getMapToObjects

public java.util.List getMapToObjects()

setAppData

public void setAppData(AppData parent)

Set the parent of the group

getAppData

public AppData getAppData()

Get the parent of the input group

getVariable

public java.lang.String getVariable()

A String which might be used as a variable of this class

toString

public java.lang.String toString()

Creates a string representation of this input group. This is an xml representation.