org.apache.fulcrum.intake.xmlmodel
Class XmlGroup

java.lang.Object
  extended by org.apache.fulcrum.intake.xmlmodel.XmlGroup
All Implemented Interfaces:
Serializable

public class XmlGroup
extends Object
implements Serializable

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

Version:
$Id: XmlGroup.java 535465 2007-05-05 06:58:06Z tv $
Author:
Thomas Vandahl
See Also:
Serialized Form

Constructor Summary
XmlGroup()
          Constructs a input group object
 
Method Summary
 XmlField addField(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(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(String name)
          Returns a Specified field.
 List getFields()
          Returns a collection of fields in this input group
 String getKey()
          Get the key used to reference this group in input (form)
 List getMapToObjects()
           
 String getName()
          Get the name that handles this group
 int getNumFields()
          Utility method to get the number of fields in this input group
 String getPoolCapacity()
          The maximum number of classes specific to this group allowed at one time.
 String getVariable()
          A String which might be used as a variable of this class
 void loadFromXML(Attributes attrib)
          Load the input group object from an xml tag.
 void setAppData(AppData parent)
          Set the parent of the group
 void setKey(String newKey)
          Set the key used to reference this group in input (form)
 void setName(String newGroupName)
          Set the name that handles this group
 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(Attributes attrib)
Load the input group object from an xml tag.


getName

public String getName()
Get the name that handles this group


setName

public void setName(String newGroupName)
Set the name that handles this group


getKey

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


setKey

public void setKey(String newKey)
Set the key used to reference this group in input (form)


getPoolCapacity

public String getPoolCapacity()
The maximum number of classes specific to this group allowed at one time.

Returns:
an String value

addField

public XmlField addField(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 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(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(String name)
Returns true if the input group contains a specified field


getMapToObjects

public 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 String getVariable()
A String which might be used as a variable of this class


toString

public String toString()
Creates a string representation of this input group. This is an xml representation.

Overrides:
toString in class Object


Copyright © 2005-2009 The Apache Software Foundation. All Rights Reserved.