fr.whimtrip.ext.jwhthtmltopojo.adapter.HtmlClassField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of whimtrip-ext-htmltopojo Show documentation

Fully featured highly pluggable and customizable Java html to pojo reflection converter

There is a newer version: 1.0.2

Show newest version





package fr.whimtrip.ext.jwhthtmltopojo.adapter;

import fr.whimtrip.ext.jwhthtmltopojo.HtmlToPojoEngine;
import fr.whimtrip.ext.jwhthtmltopojo.annotation.Selector;
import fr.whimtrip.ext.jwhthtmltopojo.exception.FieldShouldNotBeSetException;
import fr.whimtrip.ext.jwhthtmltopojo.intrf.AcceptIfResolver;
import fr.whimtrip.ext.jwhthtmltopojo.intrf.HtmlAdapter;
import org.jsoup.nodes.Element;

import java.lang.reflect.Field;

/**
 * Part of project jwht-htmltopojo
 *
 * 
 *     POJO class fields html parser. Given an HTML node and a selector, this
 *     class field can parse it to a corresponding POJO. Under the hood, it uses
 *     another {@link HtmlAdapter} to serialize the corresponding subnode into
 *     the correct POJO class.
 * 
 *
 * @param  the type of the field
 * @author Louis-wht
 * @since 1.0.0
 */
public class HtmlClassField extends AbstractHtmlFieldImpl {


    HtmlClassField(Field field, Selector selector) {
        super(field, selector);
    }


    /**
     * This method is supposed to extract from a node the value of the actual field.
     * @param htmlToPojoEngine to be used for list of POJOs fields and POJO fields in
     *                         order to retrieve the correct {@link HtmlAdapter} to create
     *                         the corresponding child elements.
     * @param node the node from which the data should be extracted.
     * @param parentObject the parent instance. This is used for list of POJOs fields and
     *                    POJO fields when instanciating the children POJOs in order to
     *                    perform the eventual code injection required.
     * @return the raw value to be set to the field
     *
     * @throws FieldShouldNotBeSetException when the field should not be set. It happens when there is an
     *                                      {@link AcceptIfResolver} providing a {@code false} value in which
     *                                      case the field should not be set.
     */
    @Override
    @SuppressWarnings("unchecked")
    public T getRawValue(HtmlToPojoEngine htmlToPojoEngine, Element node, T parentObject) throws FieldShouldNotBeSetException {

        HtmlAdapter htmlAdapter = htmlToPojoEngine.adapter(getField().getType());
        Element selectedNode = selectChild(node);


        if (selectedNode != null && shouldBeFetched(node, parentObject)) {
            return (T)
                    htmlAdapter
                            .loadFromNode(
                                    selectedNode,
                                    htmlAdapter.createNewInstance(parentObject)
                            );

        }

        throw new FieldShouldNotBeSetException(getField());
    }
}