org.hisp.grid.writer.HtmlGridWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grid Show documentation
Grid structure with rendering in many formats.
The newest version!
/*
 * Copyright (c) 2004-2024, University of Oslo
 * 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.
 * Neither the name of the HISP project nor the names of its contributors may
 * 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.hisp.grid.writer;

import java.io.IOException;
import java.io.Writer;
import java.util.List;
import org.apache.commons.lang3.ObjectUtils;
import org.apache.commons.lang3.StringUtils;
import org.hisp.grid.Grid;
import org.hisp.grid.GridHeader;
import org.hisp.grid.options.HtmlWriteOptions;
import org.owasp.encoder.Encode;

/** {@link GridWriter} implementation for HTML format. */
public class HtmlGridWriter implements GridWriter {
  /** HTML writing options. */
  private final HtmlWriteOptions options;

  /**
   * Constructor.
   *
   * @param options the {@link HtmlWriteOptions}.
   */
  public HtmlGridWriter(HtmlWriteOptions options) {
    this.options = options;
  }

  @Override
  public void write(Grid grid, Writer writer) throws IOException {
    writer.write(getHtmlDocument(grid));
  }

  /**
   * Returns a HTML document.
   *
   * @param grid the {@link Grid}.
   * @return a HTML document.
   */
  private String getHtmlDocument(Grid grid) {
    return String.format(
        """
        
        
        
        
        %s
        %s
        
        
        %s
        
        
        .gridDiv {
          font-family: sans-serif, arial;
        }
        table.gridTable {
          border-collapse: collapse;
          font-size: 11pt;
        }
        .gridTable th, .gridTable td {
          padding: 8px;
          border: 1px solid #e7e7e7;
          white-space-collapse: preserve;
          text-wrap-mode: nowrap;
        }
        .gridTable th {
          background-color: #f3f3f3;
          font-weight: bold;
        }
        """;
  }

  /**
   * Returns a HTML table section.
   *
   * @param grid the {@link Grid}.
   * @return a HTML table section.
   */
  private String getHtmlTable(Grid grid) {
    StringBuilder b = new StringBuilder();

    b.append(
        String.format(
            """
            
            %s
            %s
            
            """,
            escape(grid.getTitle()), escape(grid.getSubtitle())));

    if (options.isLineNumbers()) {
      b.append("");
    }

    for (GridHeader header : grid.getVisibleHeaders()) {
      b.append("");
    }

    b.append("""
        """);

    int r = 0;

    for (List");

      if (options.isLineNumbers()) {
        b.append("");
      }

      for (Object value : row) {
        b.append("");
      }
      b.append("");
    }

    return b.append("""
        
            
            ").append(escape(header.getName())).append("
        
        ").append(++r).append(" ").append(escape(value)).append("
        
        """).toString();
  }

  /**
   * Returns the given input object as an HTML-escaped string value.
   *
   * @param input the input object.
   * @return a string value.
   */
  private String escape(Object input) {
    String value = String.valueOf(ObjectUtils.firstNonNull(input, StringUtils.EMPTY));
    return Encode.forHtml(StringUtils.trimToEmpty(value));
  }
}