org.kawanfw.sql.util.HtmlConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aceql-http Show documentation

AceQL HTTP is a framework of REST like http APIs that allow to access to remote SQL databases over http from any device that supports http. AceQL HTTP is provided with four client SDK: - The AceQL C# Client SDK allows to wrap the HTTP APIs using Microsoft SQL Server like calls in their code, just like they would for a local database. - The AceQL Java Client SDK allows to wrap the HTTP APIs using JDBC calls in their code, just like they would for a local database. - The AceQL Python Client SDK allows SQL calls to be encoded with standard unmodified DB-API 2.0 syntax

The newest version!

/*
 * Copyright (c)2023 KawanSoft S.A.S. All rights reserved.
 * 
 * Use of this software is governed by the Business Source License included
 * in the LICENSE.TXT file in the project's root directory.
 *
 * Change Date: 2026-02-21
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by version 2.0 of the Apache License.
 */
package org.kawanfw.sql.util;

import java.util.List;
import java.util.Vector;

import org.apache.commons.lang3.StringEscapeUtils;
import org.apache.commons.lang3.text.translate.NumericEntityEscaper;

/**
 * Static methods to convert special characters to HTML equivalent and
 * vice-versa.
 *
 * @author Nicolas de Pomereu
 *
 */

@SuppressWarnings("deprecation")
public class HtmlConverter {

    private static boolean DO_NOTHING = false;

    /**
     *
     * Converts special HTML values of characters to their original values. 

     * Example : "&eacute;""is converted to "�"
     * 
     *
     * @param string
     *            A String to convert from HTML to original
     *            

     * @return A String of char converted to original values
     *
     */

    public static String fromHtml(String string) {

	if (DO_NOTHING) {
	    return string;
	}

	if (string == null) {
	    return string;
	}

	if (string.contains("&")) {
	    return StringEscapeUtils.unescapeHtml4(string);
	} else {
	    return string;
	}

    }

    /**
     * Converts special characters to their HTML values. 

     * Example : "?" is converted to "&eacute;"
     * 

     *
     * @param string
     *            A String to convert from original to HTML
     *            

     * @return A String of char converted to HTML equivalent.
     *
     */

    public static String toHtml(final String string) {

	if (DO_NOTHING) {
	    return string;
	}

	String stringNew = StringEscapeUtils.ESCAPE_HTML4
		.with(NumericEntityEscaper.between(0x7f, Integer.MAX_VALUE))
		.translate(string);

	if (stringNew != null) {
	    stringNew = stringNew.replaceAll("&", "&"); // To keep same result if
						      // multi-call
	}

	return string;
    }

    /**
     *
     * Converts special HTML values of characters to their original values. 

     * Example : "é"is converted to "?"
     * 

     *
     * @param list
     *            A list of String to convert from HTML to original
     *            

     * @return A list of String char converted to original values
     *
     */

    public static List fromHtml(List list) {

	List newList = new Vector();

	for (String string : list) {
	    string = HtmlConverter.fromHtml(string);
	    newList.add(string);
	}

	return newList;
    }

    /**
     * Converts special characters to their HTML values. 

     * Example : "�" is converted to "é"
     * 

     *
     * @param list
     *            A list of String to convert from original to HTML
     *            
     * @return A list of String of char converted to HTML equivalent.
     *
     */

    public static List toHtml(List list) {

	List newList = new Vector();

	for (String string : list) {
	    string = HtmlConverter.toHtml(string);
	    newList.add(string);
	}

	return newList;
    }

}