org.springframework.extensions.surf.extensibility.impl

Class DefaultExtensibilityDirectiveData

java.lang.Object

org.springframework.extensions.surf.extensibility.impl.DefaultExtensibilityDirectiveData

All Implemented Interfaces:

ExtensibilityDirectiveData

public class DefaultExtensibilityDirectiveData
extends Object
implements ExtensibilityDirectiveData

This is the default class for capturing the data contained within extensibility directives. It is required because directive instances are re-used so the data stored within them cannot be relied upon when building the content model.

Author:

David Draper

Constructor Summary

Constructors

Constructor and Description
DefaultExtensibilityDirectiveData(String id, String action, String target, String directiveName, freemarker.template.TemplateDirectiveBody body, freemarker.core.Environment env)

Method Summary

Methods

Modifier and Type	Method and Description
CloseModelElement	createClose() Creates a new instance of the type of CloseModelElement for with the associated ExtensibilityDirective.
ContentModelElement	createContentModelElement() Creates a new instance of the type of ContentModelElement for with the associated ExtensibilityDirective.
OpenModelElement	createOpen() Creates a new instance of the type of OpenModelElement for with the associated ExtensibilityDirective.
String	getAction() Gets the action being performed by the invocation of the associated ExtensibilityDirective type.
freemarker.template.TemplateDirectiveBody	getBody() Returns the TemplateDirectiveBody of the invocation of the associated ExtensibilityDirective type.
String	getDirectiveName() Returns the name of the associated ExtensibilityDirective type.
freemarker.core.Environment	getEnv()
String	getId() Returns the id of FreeMarker directive represented by implementing instance.
String	getTarget() Gets the id of the ExtensibilityDirective that the invocation of the associated ExtensibilityDirective type is targeting.
void	render(ModelWriter writer) Renders the output provided by the directive.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExtensibilityDirectiveData

public DefaultExtensibilityDirectiveData(String id,
                                 String action,
                                 String target,
                                 String directiveName,
                                 freemarker.template.TemplateDirectiveBody body,
                                 freemarker.core.Environment env)

Method Detail

getEnv

public freemarker.core.Environment getEnv()

getId

public String getId()

Description copied from interface: ExtensibilityDirectiveData

Returns the id of FreeMarker directive represented by implementing instance.

Specified by:

getId in interface ExtensibilityDirectiveData

Returns:

String

getAction

public String getAction()

Description copied from interface: ExtensibilityDirectiveData

Gets the action being performed by the invocation of the associated ExtensibilityDirective type. The default set of actions include "merge", "remove", "replace", "before" and "after".

Specified by:

getAction in interface ExtensibilityDirectiveData

Returns:

A String representing the action being performed by the invocation of the associated ExtensibilityDirective type.

getTarget

public String getTarget()

Description copied from interface: ExtensibilityDirectiveData

Gets the id of the ExtensibilityDirective that the invocation of the associated ExtensibilityDirective type is targeting. This will only be expected to return a non-null value when the ExtensibilityDirective is being processed as part of an extension. Any action that has an effect on the existing model (such as "remove" or "replace") will always require target information.

Specified by:

getTarget in interface ExtensibilityDirectiveData

Returns:

String

getDirectiveName

public String getDirectiveName()

Description copied from interface: ExtensibilityDirectiveData

Returns the name of the associated ExtensibilityDirective type.

Specified by:

getDirectiveName in interface ExtensibilityDirectiveData

Returns:

String

getBody

public freemarker.template.TemplateDirectiveBody getBody()

Description copied from interface: ExtensibilityDirectiveData

Returns the TemplateDirectiveBody of the invocation of the associated ExtensibilityDirective type.

Specified by:

getBody in interface ExtensibilityDirectiveData

Returns:

A TemplateDirectiveBody associated with a single invocation of the associated ExtensibilityDirective.

createOpen

public OpenModelElement createOpen()

Description copied from interface: ExtensibilityDirectiveData

Creates a new instance of the type of OpenModelElement for with the associated ExtensibilityDirective. In almost all cases this would be expected to be an instance of OpenModelElementImpl.

Specified by:

createOpen in interface ExtensibilityDirectiveData

Returns:

OpenModelElement

createContentModelElement

public ContentModelElement createContentModelElement()

Description copied from interface: ExtensibilityDirectiveData

Creates a new instance of the type of ContentModelElement for with the associated ExtensibilityDirective. The implementation returned could be varied depending upon the function of the ExtensibilityDirective. Where standard rendering of the associated TemplateDirectiveBody will occur, a DefaultExtensibilityContent will most likely be returned.

Specified by:

createContentModelElement in interface ExtensibilityDirectiveData

Returns:

OpenModelElement

createClose

public CloseModelElement createClose()

Description copied from interface: ExtensibilityDirectiveData

Creates a new instance of the type of CloseModelElement for with the associated ExtensibilityDirective. In almost all cases this would be expected to be an instance of CloseModelElementImpl.

Specified by:

createClose in interface ExtensibilityDirectiveData

Returns:

CloseModelElement

toString

public String toString()

Overrides:

toString in class Object

render

public void render(ModelWriter writer)
            throws freemarker.template.TemplateException,
                   IOException

Description copied from interface: ExtensibilityDirectiveData

Renders the output provided by the directive. In most cases this will probably call the render method of the associated TemplateDirectiveBody. However, it is possible that rendering may possible by directive with an empty body.

Specified by:

render in interface ExtensibilityDirectiveData

Parameters:

writer - ModelWriter to send the rendered output to.

Throws:

freemarker.template.TemplateException

IOException