com.agiletec.aps.system.common.entity.model.attribute.HypertextAttribute.java Source code

Introduction

Here is the source code for com.agiletec.aps.system.common.entity.model.attribute.HypertextAttribute.java

Source

/*
*
* Copyright 2013 Entando S.r.l. (http://www.entando.com) All rights reserved.
*
* This file is part of Entando software.
* Entando is a free software;
* You can redistribute it and/or modify it
* under the terms of the GNU General Public License (GPL) as published by the Free Software Foundation; version 2.
* 
* See the file License for the specific language governing permissions   
* and limitations under the License
* 
* 
* 
* Copyright 2013 Entando S.r.l. (http://www.entando.com) All rights reserved.
*
*/
package com.agiletec.aps.system.common.entity.model.attribute;

import java.util.Arrays;
import java.util.Iterator;
import java.util.List;

import org.apache.commons.lang.StringEscapeUtils;
import org.jdom.CDATA;
import org.jdom.Element;

import com.agiletec.aps.util.HtmlHandler;

/**
 * This class represents a 'Hypertext' Attribute.
 * @author W.Ambu
 */
public class HypertextAttribute extends TextAttribute {

    @Override
    public boolean needToConvertSpecialCharacter() {
        return false;
    }

    /**
     * Return the field to index after having eventually removed the HTML tags.
     * @return The text field to index
     */
    @Override
    public String getIndexeableFieldValue() {
        HtmlHandler htmlhandler = new HtmlHandler();
        String parsedText = htmlhandler.getParsedText(super.getText());
        return StringEscapeUtils.unescapeHtml(parsedText);
    }

    /** 
     * Return the requested number of characters of the text associated to this attribute, in the current 
     * language purged by the HTML tags, if any.
     * @param n The number of characters to return 
     * @return The string of text with the desired length.
     * @deprecated It might return less characters than requested. Use the getHeadEscaped instead
     */
    public String getHead(int n) {
        HtmlHandler htmlhandler = new HtmlHandler();
        String parsedText = htmlhandler.getParsedText(super.getText());
        String head = parsedText;
        if (n < parsedText.length()) {
            while ((Character.isLetterOrDigit(parsedText.charAt(n)) || (parsedText.charAt(n) == ';'))
                    && (n < parsedText.length())) {
                n++;
            }
            head = parsedText.substring(0, n);
        }
        return head;
    }

    /**
     * Return the requested number of characters rounded on word boundary of 
     * the text associated to this attribute, in the current language,
     * stripping HTML tags, if any. 
     * @param n The minimum number of characters to return
     * @return The string of text with the desired length.
     */
    public String getEscapedHead(int n) {
        String parsedText = super.getText().replaceAll("<[^<>]+>", "").trim();
        String head = parsedText;

        if (n < parsedText.length()) {
            while ((Character.isLetterOrDigit(parsedText.charAt(n)) || (parsedText.charAt(n) == ';'))
                    && (n < parsedText.length())) {
                n++;
            }
            head = parsedText.substring(0, n);
        }
        return head;
    }

    @Override
    public Element getJDOMElement() {
        Element attributeElement = this.createRootElement("attribute");
        Iterator<String> langIter = this.getTextMap().keySet().iterator();
        while (langIter.hasNext()) {
            String currentLangCode = langIter.next();
            String hypertext = (String) this.getTextMap().get(currentLangCode);
            if (null != hypertext && hypertext.trim().length() > 0) {
                Element hypertextElement = new Element("hypertext");
                hypertextElement.setAttribute("lang", currentLangCode);
                CDATA cdata = new CDATA(hypertext);
                hypertextElement.addContent(cdata);
                attributeElement.addContent(hypertextElement);
            }
        }
        return attributeElement;
    }

    /**
     * Since this kind of attribute cannot be searchable we have overridden the abstract so to
     * always return false.
     * @return Return always false.
     */
    @Override
    public boolean isSearchable() {
        return false;
    }

    @Override
    public boolean isSearchableOptionSupported() {
        return false;
    }

    @Override
    protected JAXBHypertextAttribute getJAXBAttributeInstance() {
        return new JAXBHypertextAttribute();
    }

    @Override
    public JAXBHypertextAttribute getJAXBAttribute(String langCode) {
        if (null == this.getValue()) {
            return null;
        }
        JAXBHypertextAttribute jaxbAttribute = this.getJAXBAttributeInstance();
        jaxbAttribute.setName(this.getName());
        jaxbAttribute.setType(this.getType());
        Object value = this.getJAXBValue(langCode);
        if (null != value) {
            jaxbAttribute.setHtmlValue(value.toString());
        }
        if (null != this.getRoles() && this.getRoles().length > 0) {
            List<String> roles = Arrays.asList(this.getRoles());
            jaxbAttribute.setRoles(roles);
        }
        return jaxbAttribute;
    }

    @Override
    public void valueFrom(DefaultJAXBAttribute jaxbAttribute) {
        super.valueFrom(jaxbAttribute);
        JAXBHypertextAttribute jaxbHypertextAttribute = (JAXBHypertextAttribute) jaxbAttribute;
        String value = jaxbHypertextAttribute.getHtmlValue();
        if (null != value) {
            this.getTextMap().put(this.getDefaultLangCode(), value);
        }
    }

}