/src/main/java/org/andya/confluence/plugins/metadata/MetadataReportMacro.java
Java | 70 lines | 33 code | 7 blank | 30 comment | 0 complexity | d92e2a45bf4a4816e90f0278bce57108 MD5 | raw file
- /*
- * Copyright (c) 2006, 2007 Andy Armstrong, Kelsey Grant and other contributors.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- * * Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- * * The names of contributors may not
- * be used to endorse or promote products derived from this software without
- * specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
- * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
- package org.andya.confluence.plugins.metadata;
-
- import com.atlassian.renderer.RenderContext;
- import com.atlassian.renderer.v2.RenderMode;
- import com.atlassian.renderer.v2.macro.MacroException;
-
- import org.andya.confluence.plugins.metadata.model.MetadataContent;
- import org.andya.confluence.plugins.metadata.renderers.MetadataRenderer;
- import org.andya.confluence.utils.MacroUtils;
-
- import java.util.List;
- import java.util.Map;
-
- /**
- * Macro allowing reports to be generated from metadata on matching pages.
- */
- public class MetadataReportMacro extends MetadataUsingMacro {
- public MetadataReportMacro() {
- super("metadata-report");
- }
-
- public RenderMode getBodyRenderMode()
- {
- return RenderMode.NO_RENDER;
- }
-
- @SuppressWarnings("unchecked")
- public String execute(Map parameters, String body, RenderContext renderContext) throws MacroException {
- try {
- String commaDelimitedColumns = MacroUtils.getStringParameter(parameters, "0", true);
- String linkColumn = MacroUtils.getStringParameter(parameters, LINK_PARAMETER, null);
- int maxResults = MacroUtils.getIntParameter(parameters, MAX_RESULTS_PARAMETER, DEFAULT_MAX_RESULTS);
- String commaDelimitedTotals = MacroUtils.getStringParameter(parameters, TOTALS_PARAMETER, "");
- List<MetadataContent> contents = getMatchingPages(parameters, getContentService(), renderContext, true);
- String[] columns = commaDelimitedColumns.split(",");
- MetadataRenderer renderer = getMetadataRenderer(parameters);
- return renderer.render(renderContext, contents, maxResults, columns, commaDelimitedTotals, linkColumn);
- } catch (Exception e) {
- return MacroUtils.showRenderedExceptionString(parameters, "Unable to render macro", e);
- }
- }
- }