|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.turbine.om.OMTool
public class OMTool
A Pull tool to make om objects available to a template
| Nested Class Summary | |
|---|---|
protected class |
OMTool.PullHelper
Inner class to present a nice interface to the template designer |
| Field Summary | |
|---|---|
protected RetrieverFactory |
omFactory
The Factory responsible for retrieving the objects from storage |
protected java.util.HashMap<java.lang.String,java.lang.Object> |
omMap
|
| Constructor Summary | |
|---|---|
OMTool()
|
|
| Method Summary | |
|---|---|
void |
dispose()
Disposes the object after use. |
java.lang.Object |
get(java.lang.String omName)
|
java.lang.Object |
get(java.lang.String omName,
java.lang.String key)
|
java.lang.String |
getName()
|
void |
init(java.lang.Object runData)
Prepares tool for a single request |
boolean |
isDisposed()
Checks whether the recyclable has been disposed. |
void |
recycle()
Recycles the object for a new client. |
void |
refresh()
Implementation of ApplicationTool interface is not needed for this method as the tool is request scoped |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected java.util.HashMap<java.lang.String,java.lang.Object> omMap
protected RetrieverFactory omFactory
| Constructor Detail |
|---|
public OMTool()
throws java.lang.Exception
java.lang.Exception| Method Detail |
|---|
public void init(java.lang.Object runData)
init in interface ApplicationToolrunData - initialization datapublic void refresh()
refresh in interface ApplicationTool
public java.lang.Object get(java.lang.String omName)
throws java.lang.Exception
java.lang.Exception
public java.lang.Object get(java.lang.String omName,
java.lang.String key)
throws java.lang.Exception
java.lang.Exceptionpublic java.lang.String getName()
public void recycle()
recycle in interface org.apache.fulcrum.pool.Recyclablepublic void dispose()
dispose in interface org.apache.fulcrum.pool.Recyclablepublic boolean isDisposed()
isDisposed in interface org.apache.fulcrum.pool.Recyclable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||