Package org.opencms.jsp.util

Class CmsMacroFormatterResolver

java.lang.Object

org.opencms.jsp.util.CmsMacroFormatterResolver

public class CmsMacroFormatterResolver
extends Object

Resolver for macro formatters.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_CMS	The parent macro key.
static final String	KEY_ELEMENT	The element macro key.
static final String	KEY_PARENT	The parent macro key.
static final String	KEY_SETTINGS	The settings macro key.
static final String	N_FORMATTER	Node name.
static final String	N_FORMATTERS	Node name.
static final String	N_MACRO	Node name.
static final String	N_MACRO_NAME	Node name.

Constructor Summary

Constructors

Constructor	Description
CmsMacroFormatterResolver(javax.servlet.jsp.PageContext context, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected I_CmsFormatterBean	getFormatterForMacro(String macro)	Returns the formatter bean for the given macro string, or null if none available.
protected Object	getMacroBeanValue(Object bean, String property)	Returns the property value read from the given JavaBean.
protected String	getMacroInput()	Returns the macro input string.
protected void	printMacroValue(String macro)	Prints the macro value to the output stream.
void	resolve()	Resolves the macro.

Methods inherited from class java.lang.Object

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

Field Details

KEY_CMS

public static final String KEY_CMS

The parent macro key.

See Also:

• Constant Field Values

KEY_ELEMENT

public static final String KEY_ELEMENT

The element macro key.

See Also:

• Constant Field Values

KEY_PARENT

public static final String KEY_PARENT

The parent macro key.

See Also:

• Constant Field Values

KEY_SETTINGS

public static final String KEY_SETTINGS

The settings macro key.

See Also:

• Constant Field Values

N_FORMATTER

public static final String N_FORMATTER

Node name.

See Also:

• Constant Field Values

N_FORMATTERS

public static final String N_FORMATTERS

Node name.

See Also:

• Constant Field Values

N_MACRO

public static final String N_MACRO

Node name.

See Also:

• Constant Field Values

N_MACRO_NAME

public static final String N_MACRO_NAME

Node name.

See Also:

• Constant Field Values

Constructor Details

CmsMacroFormatterResolver

public CmsMacroFormatterResolver(javax.servlet.jsp.PageContext context,
 javax.servlet.http.HttpServletRequest req,
 javax.servlet.http.HttpServletResponse res)

Constructor.

Parameters:

context - the page context

req - the request

res - the response

Method Details

resolve

public void resolve()
             throws IOException,
CmsException

Resolves the macro.

Throws:

IOException - in case writing to the page context output stream fails

CmsException - in case reading the macro settings fails

getFormatterForMacro

protected I_CmsFormatterBean getFormatterForMacro(String macro)

Returns the formatter bean for the given macro string, or null if none available.

Parameters:

macro - the macro

Returns:

the formatter bean

getMacroBeanValue

protected Object getMacroBeanValue(Object bean,
 String property)

Returns the property value read from the given JavaBean.

Parameters:

bean - the JavaBean to read the property from

property - the property to read

Returns:

the property value read from the given JavaBean

getMacroInput

protected String getMacroInput()

Returns the macro input string.

Returns:

the macro input string

printMacroValue

protected void printMacroValue(String macro)
                        throws IOException

Prints the macro value to the output stream.

Parameters:

macro - the macro string

Throws:

IOException - in case writing to the page context output stream fails