All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.googlecode.jmapper.util.ConfigHelper Maven / Gradle / Ivy

Go to download

JMapper Framework is a java bean mapper based on javassist. JMapper exposes interesting features as relational mapping, dynamic conversions and more

The newest version!
/**
 * Copyright (C) 2012 - 2016 Alessandro Vurro.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.googlecode.jmapper.util;

import static com.googlecode.jmapper.operations.NestedMappingHandler.isNestedMapping;
import static com.googlecode.jmapper.operations.NestedMappingHandler.nestedFields;
import static com.googlecode.jmapper.util.ClassesManager.getAllsuperClasses;
import static com.googlecode.jmapper.util.GeneralUtility.isEmpty;
import static com.googlecode.jmapper.util.GeneralUtility.isNull;
import java.util.List;
import com.googlecode.jmapper.api.JMapperAPI;
import com.googlecode.jmapper.config.JmapperLog;
import com.googlecode.jmapper.xml.XML;
import com.googlecode.jmapper.xml.beans.XmlAttribute;
import com.googlecode.jmapper.xml.beans.XmlClass;
import com.googlecode.jmapper.xml.beans.XmlJmapper;

//TODO test da effettuare
// - gerarchie, verificare che anche una classe non configurata direttamente sia presa in esame
/**
 * ConfigHelper permits to know the relationship between fields at runtime.
 * 
 * 
 * @author Alessandro Vurro
 *
 * @param  Destination class
 * @param  Source Class
 */
public class ConfigHelper  {
	
	/** destination class */
	private final Class destinationClass;
	
	/** source class */
	private final Class sourceClass;
	
	/** mapped class */
	private Class mappedClass;
	
	/** xmlClass cached */
	private XmlClass xmlMappedClass;
	
	/**
	 * It converts the configuration from XML to XStream format.
	 * @param xml xml to convert
	 * @return Configuration in XStream format
	 */
	private static final XmlJmapper xmlToXStream(String xml){
		
		try {
			return new XML(true, xml).toXStream();
		} catch (Exception e) {
			//TODO lanciare exception
			JmapperLog.error(e);
			throw new RuntimeException();
		}
	}
	
	/**
	 * It converts the configuration from Annotation to XML format.
	 * @param destinationClass destination class
	 * @param sourceClass source class
	 * @return the configuration in XML format
	 */
	private static final String annotationToXml(Class destinationClass, Class sourceClass){
		return null;
	}

	/**
	 * In case of nested mapping will be returned the last field name declared. 
	 * @param fieldName field name
	 * @return field name
	 */
	private static final String checkNestedMapping(String fieldName){
		
		if(isNestedMapping(fieldName)){
			String[] nestedFields = nestedFields(fieldName);
			return nestedFields[nestedFields.length-1];
		}
		
		return fieldName;
	}
	/**
	 * It permits to analyze the annotated configuration between destination and source classes.
	 * @param destinationClass destination class
	 * @param sourceClass source class
	 */
	public ConfigHelper(Class destinationClass, Class sourceClass) {
		this(destinationClass, sourceClass, annotationToXml(destinationClass, sourceClass));
	}
	
	/**
	 * It permits to analyze the XML configuration between destination and source classes.
	 * @param destinationClass destination class
	 * @param sourceClass source class
	 * @param xml xml (path or content as string) 
	 */
	public ConfigHelper(Class destinationClass, Class sourceClass, String xml) {
		this(destinationClass, sourceClass, xmlToXStream(xml));
	}
	
	/**
	 * It permits to analyze the API configuration between destination and source classes.
	 * @param destinationClass destination class
	 * @param sourceClass source class
	 * @param api configuration in API format
	 */
	public ConfigHelper(Class destinationClass, Class sourceClass, JMapperAPI api) {
		this(destinationClass, sourceClass, api.toXStream());
	}
	
	private ConfigHelper(Class destinationClass, Class sourceClass, XmlJmapper root) {
		this.destinationClass = destinationClass;
		this.sourceClass = sourceClass;
		
		List> destinationHierarchy = getAllsuperClasses(destinationClass);
		List> sourceHierarchy = getAllsuperClasses(sourceClass);
		
		for (XmlClass xmlClass : root.classes) {
			
			for (Class destinationHierarchyClass : destinationHierarchy) 
				if(xmlClass.name.equals(destinationHierarchyClass.getName())){
					mappedClass = destinationClass;
					break;
				}
			
			if(isNull(mappedClass))
				for (Class sourceHierarchyClass : sourceHierarchy) 
					if(xmlClass.name.equals(sourceHierarchyClass.getName())){
						mappedClass = sourceClass;
						break;
					}
				
			if(!isNull(mappedClass)) 
				xmlMappedClass = xmlClass;
		}
		
		if(isNull(mappedClass)){
			//TODO lanciare exception
			//nessuna delle due classi ? configurata
		}
	}
	
	//TODO test da effettuare
	// se chiedo il source ed ? il destination ad esser mappato
	// se chiedo il source ed ? il source ad esser mappato
	public String getSourceFieldName(final String destinationFieldName){
		
		    // if the mapped class is the destination class
			if(mappedClass.equals(destinationClass)){
				
				for (XmlAttribute xmlAttribute : xmlMappedClass.attributes) {
					
					// find between target fields the source field name
					if(!xmlAttribute.name.equals(destinationFieldName)) continue;

					if(isEmpty(xmlAttribute.classes)){
						//TODO lanciare exception
						// ? obbligatorio definire le classi per verificare l'appartenza
						// oppure
						// se ? destination a essere mappata, per sapere chi ? il sourceField
						// devo poter fare una associazione con la source class
					}
					
					Integer targetClassIndex = null;
					for(int i = 0; i < xmlAttribute.classes.size(); i++)
						if(xmlAttribute.classes.get(i).name.equals(sourceClass.getName()))
							targetClassIndex = i;
						
					// if between target classes there isn't source class, thrown an exception
					if(isNull(targetClassIndex)){
						//TODO lanciare exception
						//classe source non configurata, impossibile recuperare il campo
					}
						
					// if there are attributes defined, returns the attribute in targetClassIndex position
					if(!isEmpty(xmlAttribute.attributes))
						return checkNestedMapping(xmlAttribute.attributes.get(targetClassIndex).name);
								
					// return the value content
					return checkNestedMapping(xmlAttribute.value.name);
					
				}
				
			// if the mapped class is the source class
			}else{
				
				String destinationField = checkNestedMapping(destinationFieldName);
				for (XmlAttribute xmlAttribute : xmlMappedClass.attributes) {
					
					if(isEmpty(xmlAttribute.classes)){
						//TODO lanciare exception
						// ? obbligatorio definire le classi per verificare l'appartenza
						// oppure
						// se ? destination a essere mappata, per sapere chi ? il sourceField
						// devo poter fare una associazione con la source class
					}
					
					if(!isEmpty(xmlAttribute.attributes))
						for(int i = 0; i < xmlAttribute.attributes.size(); i++)
							if(  xmlAttribute.attributes.get(i).name.equals(destinationField)
							  && xmlAttribute.classes.get(i).name.equals(destinationClass.getName()))
								return xmlAttribute.name;
					
					if( xmlAttribute.value.name.equals(destinationField))
						for(int i = 0; i < xmlAttribute.classes.size(); i++)
					       if(xmlAttribute.classes.get(i).name.equals(destinationClass.getName()))
					    	   return xmlAttribute.name;
				}
				
			}
		
			//TODO lanciare exception
			// campo non trovato
		
		return "this return is never used";
	}
	
	//TODO test da effettuare
	// se chiedo il destination ed ? il destination ad esser mappato
	// se chiedo il destination ed ? il source ad esser mappato
	public String getDestinationFieldName(final String sourceFieldName){
		
		// if the mapped class is the destination class
		if(mappedClass.equals(destinationClass)){
			
			String sourceField = checkNestedMapping(sourceFieldName);
			for (XmlAttribute xmlAttribute : xmlMappedClass.attributes) {
				
				if(isEmpty(xmlAttribute.classes)){
					//TODO lanciare exception 
					// ? obbligatorio definire le classi per verificare l'appartenza
					// oppure
					// se ? destination a essere mappata, per sapere chi ? il sourceField
					// devo poter fare una associazione con la source class
				}
				
				if(!isEmpty(xmlAttribute.attributes))
					for(int i = 0; i < xmlAttribute.attributes.size(); i++)
						if(  xmlAttribute.attributes.get(i).name.equals(sourceField)
						  && xmlAttribute.classes.get(i).name.equals(destinationClass.getName()))
							return xmlAttribute.name;
				
				if( xmlAttribute.value.name.equals(sourceField))
					for(int i = 0; i < xmlAttribute.classes.size(); i++)
				       if(xmlAttribute.classes.get(i).name.equals(destinationClass.getName()))
				    	   return xmlAttribute.name;
			}
		
		// if the mapped class is the source class
		}else{
			
			for (XmlAttribute xmlAttribute : xmlMappedClass.attributes) {
				
				// find between target fields the source field name
				if(!xmlAttribute.name.equals(sourceFieldName)) continue;

				if(isEmpty(xmlAttribute.classes)){
					//TODO lanciare exception
					// ? obbligatorio definire le classi per verificare l'appartenza
					// oppure
					// se ? destination a essere mappata, per sapere chi ? il sourceField
					// devo poter fare una associazione con la source class
				}
				
				Integer targetClassIndex = null;
				for(int i = 0; i < xmlAttribute.classes.size(); i++)
					if(xmlAttribute.classes.get(i).name.equals(sourceClass.getName()))
						targetClassIndex = i;
					
				// if between target classes there isn't source class, thrown an exception
				if(isNull(targetClassIndex)){
					//TODO lanciare exception
					//classe source non configurata, impossibile recuperare il campo
				}
					
				String valueName = !isEmpty(xmlAttribute.attributes)
						// if there are attributes defined, returns the attribute in targetClassIndex position
						? xmlAttribute.attributes.get(targetClassIndex).name
						: xmlAttribute.value.name;
							
				// return the value content
				return checkNestedMapping(valueName);
				
			}
		}
			
		//TODO lanciare exception
		// campo non trovato
	
		return "this return is never used";
	}

}