com.atlassian.confluence.macro

Class ContentFilteringMacro

java.lang.Object

com.atlassian.renderer.v2.macro.BaseMacro

com.atlassian.confluence.macro.ContentFilteringMacro

All Implemented Interfaces:

com.atlassian.renderer.v2.macro.Macro

public abstract class ContentFilteringMacro
extends com.atlassian.renderer.v2.macro.BaseMacro

Convenience class that provides default values for macros which retrieve content from somewhere else in Confluence.

Since:

2.9

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorParameter	authorParam Parameter to handle the creator/author of the content.
protected ContentTypeParameter	contentTypeParam Parameter to handle content type filtering.
static String	DEFAULT_MAX_RESULTS Default value for a maxResults parameter.
static String	DEFAULT_SPACE_KEY Default value for a spaceKey parameter.
protected LabelParameter	labelParam Parameter to handle label filtering.
protected MaxResultsParameter	maxResultsParam Parameter to handle the maximum number of results.
protected SearchManager	searchManager SearchManager instance for handling queries based on parameter values.
protected SearchSortParameter	sortParam Parameter that describes the type of sort to perform on the content.
protected SpaceKeyParameter	spaceKeyParam Parameter to handle space key filtering.

Fields inherited from interface com.atlassian.renderer.v2.macro.Macro

RAW_PARAMS_KEY

Constructor Summary

Constructors

Constructor and Description
ContentFilteringMacro()

Method Summary

Modifier and Type	Method and Description
protected abstract String	execute(MacroExecutionContext ctx) Subclasses must override macro-specific functionality in this method.
String	execute(Map params, String body, com.atlassian.renderer.RenderContext renderContext) This implementation is final to ensure that subclasses are provided with a valid MacroExecutionContext.
void	setSearchManager(SearchManager searchManager) Injector for SearchManager.

Methods inherited from class com.atlassian.renderer.v2.macro.BaseMacro

getTokenType, getWysiwygBodyType, isInline, suppressMacroRenderingDuringWysiwyg, suppressSurroundingTagDuringWysiwygRendering

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.renderer.v2.macro.Macro

getBodyRenderMode, hasBody

Field Detail

DEFAULT_MAX_RESULTS

public static final String DEFAULT_MAX_RESULTS

Default value for a maxResults parameter.

See Also:

Constant Field Values

DEFAULT_SPACE_KEY

public static final String DEFAULT_SPACE_KEY

Default value for a spaceKey parameter.

See Also:

Constant Field Values

labelParam

protected final LabelParameter labelParam

Parameter to handle label filtering.

contentTypeParam

protected final ContentTypeParameter contentTypeParam

Parameter to handle content type filtering.

spaceKeyParam

protected final SpaceKeyParameter spaceKeyParam

Parameter to handle space key filtering.

authorParam

protected final AuthorParameter authorParam

Parameter to handle the creator/author of the content.

maxResultsParam

protected final MaxResultsParameter maxResultsParam

Parameter to handle the maximum number of results.

sortParam

protected final SearchSortParameter sortParam

Parameter that describes the type of sort to perform on the content.

searchManager

protected SearchManager searchManager

SearchManager instance for handling queries based on parameter values.

Constructor Detail

ContentFilteringMacro

public ContentFilteringMacro()

Method Detail

execute

public final String execute(Map params,
                            String body,
                            com.atlassian.renderer.RenderContext renderContext)
                     throws com.atlassian.renderer.v2.macro.MacroException

This implementation is final to ensure that subclasses are provided with a valid MacroExecutionContext.

Parameters:

params - the macro parameters

body - the macro body

renderContext - the RenderContext provided to the macro

Returns:

the processed wiki or HTML for displaying

Throws:

com.atlassian.renderer.v2.macro.MacroException - if the macro fails to execute

execute

protected abstract String execute(MacroExecutionContext ctx)
                           throws com.atlassian.renderer.v2.macro.MacroException

Subclasses must override macro-specific functionality in this method.

Parameters:

ctx - the MacroExecutionContext for this invocation

Returns:

the processed wiki or HTML for displaying

Throws:

com.atlassian.renderer.v2.macro.MacroException - if the macro fails to execute

setSearchManager

public void setSearchManager(SearchManager searchManager)

Injector for SearchManager.

Parameters:

searchManager - the SearchManager to inject