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

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

All Implemented Interfaces:

java.io.Serializable

public class AppData

extends java.lang.Object

implements java.io.Serializable

A class for holding application data structures.

Version:

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

Author:

Henning P. Schmiedehausen

See Also:

Serialized Form

Constructor Summary

AppData()
Default Constructor

Method Summary

XmlGroup	addGroup(org.xml.sax.Attributes attrib) An utility method to add a new input group from an xml attribute.
void	addGroup(XmlGroup input) Add an input group to the vector and sets the AppData property to this AppData
java.lang.String	getBasePackage() Get the base package String that will be appended to any mapToObjects
XmlGroup	getGroup(java.lang.String groupName) Get a XmlGroup with the given name.
java.lang.String	getGroupPrefix() Get the prefix String that will be used to qualify intake groups when using multiple XML files
java.util.List	getGroups() Return a collection of input sections (<group>).
void	loadFromXML(org.xml.sax.Attributes attrib) Imports the top level element from an XML specification
void	setBasePackage(java.lang.String v) Set the base package String that will be appended to any mapToObjects
void	setGroupPrefix(java.lang.String groupPrefix) Set the prefix String that will be used to qualify intake groups when using multiple XML files
java.lang.String	toString() Creats a string representation of this AppData.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppData

public AppData()

Default Constructor

Method Detail

loadFromXML

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

Imports the top level element from an XML specification

getGroups

public java.util.List getGroups()

Return a collection of input sections (<group>). The names of the groups returned here are only unique to this AppData object and not qualified with the groupPrefix. This method is used in the IntakeService to register all the groups with and without prefix in the service.

getGroup

public XmlGroup getGroup(java.lang.String groupName)
                  throws IntakeException

Get a XmlGroup with the given name. It finds both qualified and unqualified names in this package.

Parameters:

groupName - a String value

Returns:

a XmlGroup value

Throws:

IntakeException - indicates that the groupName was null

addGroup

public XmlGroup addGroup(org.xml.sax.Attributes attrib)

An utility method to add a new input group from an xml attribute.

addGroup

public void addGroup(XmlGroup input)

Add an input group to the vector and sets the AppData property to this AppData

getBasePackage

public java.lang.String getBasePackage()

Get the base package String that will be appended to any mapToObjects

Returns:

value of basePackage.

setBasePackage

public void setBasePackage(java.lang.String v)

Set the base package String that will be appended to any mapToObjects

Parameters:

v - Value to assign to basePackage.

getGroupPrefix

public java.lang.String getGroupPrefix()

Get the prefix String that will be used to qualify intake groups when using multiple XML files

Returns:

value of groupPrefix

setGroupPrefix

public void setGroupPrefix(java.lang.String groupPrefix)

Set the prefix String that will be used to qualify intake groups when using multiple XML files

Parameters:

groupPrefix - Value to assign to basePackage.

toString

public java.lang.String toString()

Creats a string representation of this AppData. The representation is given in xml format.