All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.github.davidepastore.liferay.converter.ConvertibleJournalArticle Maven / Gradle / Ivy

    There is a newer version: 7.2.0
    Show newest version
    package com.github.davidepastore.liferay.converter;

import java.lang.reflect.Field;
import java.lang.reflect.ParameterizedType;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Locale;

import org.jsoup.Jsoup;
import org.jsoup.nodes.Element;
import org.jsoup.parser.Parser;
import org.jsoup.select.Elements;

import com.github.davidepastore.liferay.annotation.JournalArticleField;
import com.github.davidepastore.liferay.util.SimpleLocaleUtil;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.journal.model.JournalArticle;

/**
 * The Convertible Journal Article class that contains the methods to convert a {@link JournalArticle}
 * to an {@link Object}. You should use {@link JournalArticleField} annotations to
 * be sure that your data is correctly mapped.
 * @author Davide Pastore
 *
 */
public abstract class ConvertibleJournalArticle {
	
	private static Log log = LogFactoryUtil.getLog(ConvertibleJournalArticle.class);
	
	/**
	 * Create the object from the given {@link JournalArticle} instance.
	 * @param journalArticle The {@link JournalArticle} instance.
	 * @throws Exception
	 */
	public void fromJournalArticle(JournalArticle journalArticle) throws Exception{
		fromJournalArticle(journalArticle, SimpleLocaleUtil.buildLocale(journalArticle.getDefaultLanguageId()));
	}
	
	/**
	 * Create the object from the given {@link JournalArticle} and {@link Locale}.
	 * @param journalArticle The {@link JournalArticle} instance.
	 * @param locale The {@link Locale} to use to read from the {@link JournalArticle}.
	 * @throws Exception
	 */
	public void fromJournalArticle(JournalArticle journalArticle, Locale locale) throws Exception{
		log.debug("Not localized content: " + journalArticle.getContent());
		log.debug("Localized content: " + journalArticle.getContentByLocale(locale.getLanguage()));
		String content = journalArticle.getContentByLocale(locale.getLanguage());
		org.jsoup.nodes.Document document = Jsoup.parse(content, "", Parser.xmlParser());
		Elements elements = document.select("root > dynamic-element");
		setValueFromElements(elements, this, journalArticle.getTitle(locale));
		log.debug("Object: " + this);
	}
	
	/**
	 * Set value from the {@link Elements} instance.
	 * @param elements The {@link Elements} on which search the value.
	 * @param object The object on which set the fields.
	 * @param title The title.
	 * @throws IllegalAccessException 
	 * @throws IllegalArgumentException 
	 * @throws InstantiationException 
	 */
	protected void setValueFromElements(Elements elements, Object object, String title) throws IllegalArgumentException, IllegalAccessException, InstantiationException{
		List names = getDynamicElementNames(elements);
		Object value = null;
		for (String name : names) {
			Elements elementsWithName = elements.select("[name=" + name + "]");
			List listValue = new ArrayList();
			int counter = 0;
			int size = elementsWithName.size();
			boolean isList = size > 1;
			for (Element element : elementsWithName) {
				value = getObjectValue(element, object, title);
				boolean setValue = true;
				if(isList){
					counter++;
					listValue.add(value);
					if(counter == size){
						setValue = true;
						value = listValue;
					} else {
						setValue = false;
					}
				}
				
				if(setValue){
					List linkedFields = getLinkedFields(name, object.getClass());
					for (Field linkedField : linkedFields) {
						linkedField.setAccessible(true);
						linkedField.set(object, value);
					}
				}
				
				List titleFields = getTitleFields();
				for (Field titleField : titleFields) {
					titleField.setAccessible(true);
					titleField.set(object, title);
				}
				
				List baseFields = getBaseFields(object.getClass());
				for (Field baseField : baseFields) {
					baseField.setAccessible(true);
					Object baseValue = getObjectValue(elements.first().parent().select("> dynamic-content").first(), object, title);
					baseField.set(object, baseValue);
				}
			}
		}
	}
	
	/**
	 * Get the object value of the given {@link Element}.
	 * @param element The {@link Element} that contains the XML structure (dynamic-element or dynamic-content).
	 * @param object The object on which set the value.
	 * @param title The title to use.
	 * @return Returns the object with the found value (it also handles nested properties).
	 * @throws InstantiationException
	 * @throws IllegalAccessException
	 */
	protected Object getObjectValue(Element element, Object object, String title) throws InstantiationException, IllegalAccessException, NumberFormatException, IndexOutOfBoundsException {
		Object value = null;
		String type = element.attr("type");
		String stringValue = element.text();
		//If this is already a dynamic-content, it means it is a base nested element
		if(element.tagName().equals("dynamic-content")){
			type = element.parent().attr("type");
		}
		
		Elements nestedElements = element.children().select("dynamic-element");
		if(!nestedElements.isEmpty()){
			//Handle nested type
			String parentName = element.attr("name");
			//log.info("Parent name: " + parentName);
			List fields = getLinkedFields(parentName, object.getClass());
			Object nestedObject;
			for (Field field : fields) {
				field.setAccessible(true);
				Class clazzType = field.getType();
				log.debug("clazzType: " + clazzType);
				if(clazzType.getName().equals("java.util.List")){
					log.debug("This seems a list!");
					ParameterizedType listType = (ParameterizedType) field.getGenericType();
					clazzType = (Class) listType.getActualTypeArguments()[0];
				}
				nestedObject = clazzType.newInstance();
				setValueFromElements(nestedElements, nestedObject, title);
				value = nestedObject;
			}
		} else if(type.equals("text")){
			value = stringValue;
		} else if(type.equals("boolean")){
			value = Boolean.parseBoolean(stringValue);
		} else if(type.equals("ddm-date")){
			value = new Date(Long.parseLong(stringValue));
		} else if(type.equals("ddm-decimal")){
			value = new Double(stringValue);
		} else if(type.equals("image")){
			value = stringValue;
		} else if(type.equals("document_library")){
			value = stringValue;
		} else if(type.equals("ddm-integer")){
			value = Integer.parseInt(stringValue);
		} else if(type.equals("link_to_layout")){
			value = stringValue;
		} else if(type.equals("ddm-number")){
			value = new BigDecimal(stringValue);
		} else if(type.equals("radio")){
			value = stringValue.substring(2, stringValue.length() - 2);
		} else if(type.equals("list")){
			Elements options = element.select("dynamic-content option");
			if(options.isEmpty()){
				//Single option
				value = stringValue;
			} else {
				//Multiple option
				List list = new ArrayList();
				for (Element option : options) {
					list.add(option.text());
				}
				value = list;
			}
		} else if(type.equals("text_box")){
			value = stringValue;
		} else if(type.equals("text_area")){
			value = stringValue;
		}
		
		return value;
	}
	
	/**
	 * Get the {@link List} of linked {@link Field} with this class.
	 * @param name The name of the field.
	 * @param clazz The {@link Class} to use.
	 * @return Returns the {@link List} of linked {@link Field}.
	 */
	protected List getLinkedFields(String name, Class clazz){
		List fields = new ArrayList();
		for (Field field : clazz.getDeclaredFields()) {
			if (field.isAnnotationPresent(JournalArticleField.class)) {
				JournalArticleField annotation = field.getAnnotation(JournalArticleField.class);
				String fieldName = annotation.name();
				if(name.equals(fieldName)){
					fields.add(field);
				}
			}
		}
		return fields;
	}
	
	/**
	 * Get the {@link List} of {@link Field} that contains the title.
	 * @return Returns the {@link List} of {@link Field} that contains the title.
	 */
	protected List getTitleFields(){
		List fields = new ArrayList();
		for (Field field : this.getClass().getDeclaredFields()) {
			if (field.isAnnotationPresent(JournalArticleField.class)) {
				JournalArticleField annotation = field.getAnnotation(JournalArticleField.class);
				if(annotation.title()){
					fields.add(field);
				}
			}
		}
		return fields;
	}
	
	/**
	 * Get the {@link List} of {@link Field} that should be associated with the base value.
	 * @param clazz The {@link Class} to use.
	 * @return Returns the {@link List} of {@link Field} that should be associated with the base value.
	 */
	protected List getBaseFields(Class clazz){
		List fields = new ArrayList();
		for (Field field : clazz.getDeclaredFields()) {
			if (field.isAnnotationPresent(JournalArticleField.class)) {
				JournalArticleField annotation = field.getAnnotation(JournalArticleField.class);
				if(annotation.base()){
					fields.add(field);
				}
			}
		}
		return fields;
	}
	
	
	/**
	 * Get a {@link List} of all the dynamic element.
	 * @param elements The {@link Elements}.
	 * @return Returns a {@link List} of all the dynamic elements.
	 */
	protected List getDynamicElementNames(Elements elements){
		List names = new ArrayList();
		for (Element element : elements) {
			String name = element.attr("name");
			if(!names.contains(name)){
				names.add(name);				
			}
		}
		return names;
	}
	
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy