org.apache.maven.continuum.web.tool
Class FormicaTool

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.continuum.web.tool.FormicaTool

All Implemented Interfaces:

org.codehaus.plexus.logging.LogEnabled, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

public class FormicaTool
extends org.codehaus.plexus.logging.AbstractLogEnabled
implements org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Version:

$Id: FormicaTool.java 321486 2005-10-15 20:44:42Z evenisse $

Author:

Trygve Laugstøl

Constructor Summary

FormicaTool()

Method Summary

void	contextualize(org.codehaus.plexus.context.Context context)
java.lang.String	getElementData(org.codehaus.plexus.formica.Form form, org.codehaus.plexus.formica.Element element, java.lang.Object item, org.codehaus.plexus.summit.rundata.RunData runData) For a given element in a form, get the data for that form whether it be from a request parameter or by applying an expression to the item in question.
org.codehaus.plexus.formica.Form	getForm(java.lang.String fid)
java.lang.String	getItem(org.codehaus.plexus.formica.Form form, org.codehaus.plexus.formica.Element element, java.lang.Object item)
java.lang.String	getItem(org.codehaus.plexus.formica.Form form, org.codehaus.plexus.formica.Element element, java.lang.String id)
java.lang.Object	getItem(org.codehaus.plexus.formica.Form form, java.lang.String id)

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

FormicaTool

public FormicaTool()

Method Detail

getForm

public org.codehaus.plexus.formica.Form getForm(java.lang.String fid)
                                         throws FormToolException

Throws:

FormToolException

getItem

public java.lang.String getItem(org.codehaus.plexus.formica.Form form,
                                org.codehaus.plexus.formica.Element element,
                                java.lang.String id)
                         throws FormToolException

Throws:

FormToolException

getItem

public java.lang.String getItem(org.codehaus.plexus.formica.Form form,
                                org.codehaus.plexus.formica.Element element,
                                java.lang.Object item)
                         throws FormToolException

Throws:

FormToolException

getElementData

public java.lang.String getElementData(org.codehaus.plexus.formica.Form form,
                                       org.codehaus.plexus.formica.Element element,
                                       java.lang.Object item,
                                       org.codehaus.plexus.summit.rundata.RunData runData)
                                throws FormToolException

For a given element in a form, get the data for that form whether it be from a request parameter or by applying an expression to the item in question.

Parameters:

form - Formica form object.

element - Form element.

item - The object from which the data will be extracted using an expression.

runData - The summit runData.

Returns:

Throws:

FormToolException

getItem

public java.lang.Object getItem(org.codehaus.plexus.formica.Form form,
                                java.lang.String id)
                         throws FormToolException

Throws:

FormToolException

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException