groovy/modules/grails/src/commons/org/codehaus/groovy/grails/commons/DefaultGrailsDomainClassProperty.java

/* Copyright 2004-2005 the original author or authors.
 * 
 * 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 org.codehaus.groovy.grails.commons;

import java.beans.PropertyDescriptor;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Set;

import org.apache.commons.lang.ClassUtils;
import org.apache.commons.lang.builder.ToStringBuilder;

/**
 * @author Graeme Rocher
 * @since 05-Jul-2005
 */
public class DefaultGrailsDomainClassProperty implements GrailsDomainClassProperty {

	
	private GrailsDomainClass domainClass;
	private PropertyDescriptor descriptor;
	private boolean persistant;
	private boolean optional;
	private boolean identity;
	private boolean oneToMany;
	private String name;
	private Class type;
	private boolean manyToMany;
	private boolean manyToOne;
	private boolean oneToOne;

	private boolean bidirectional;

	private Class referencedPropertyType;
	private GrailsDomainClass referencedDomainClass;
	private GrailsDomainClassProperty otherSide;
	

	
		
	public DefaultGrailsDomainClassProperty(DefaultGrailsDomainClass domainClass, PropertyDescriptor descriptor)  {
		this.domainClass = domainClass;
		this.descriptor = descriptor;
		// required by default
		this.optional = false;
		// persistant by default
		this.persistant = true;
		this.name = this.descriptor.getName();
		this.type = this.descriptor.getPropertyType();
		this.identity = this.descriptor.getName().equals( IDENTITY );
		// get the not required descritor from the owner bean
		List optionalProps = null;
		List transientProps = null;

		optionalProps = (List)domainClass.getPropertyValue( OPTIONAL, List.class );
		transientProps= (List)domainClass.getPropertyValue( TRANSIENT, List.class );		
				
		// Undocumented feature alert! Steve insisted on this :-)
		List evanescent = (List)domainClass.getPropertyValue( EVANESCENT, List.class );
		if(evanescent != null) {
			if(transientProps == null) 
				transientProps = new ArrayList();
			
			transientProps.addAll(evanescent);
		}
		// establish of property is required
		if(optionalProps != null) {
			for(Iterator i = optionalProps.iterator();i.hasNext();) {
				
				// make sure its a string otherwise ignore. Note: Maybe put a warning here?
				Object currentObj = i.next();
				if(currentObj instanceof String) {
					String propertyName = (String)currentObj;
					// if the property name in the not required list
					// matches this property name set not required
					if(propertyName.equals( this.name )) {
						this.optional = true;
						break;
					}
				}
			}
		}
		// establish if property is persistant
		if(transientProps != null) {
			for(Iterator i = transientProps.iterator();i.hasNext();) {
				
				// make sure its a string otherwise ignore. Note: Again maybe a warning?
				Object currentObj = i.next();
				if(currentObj instanceof String) {
					String propertyName = (String)currentObj;
					// if the property name is on the not persistant list
					// then set persistant to false
					if(propertyName.equals( this.name )) {
						this.persistant = false;
						break;
					}
				}
			}
		}

	}
	

	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.domain.GrailsDomainClassProperty#getName()
	 */
	public String getName() {
		return this.name;
	}

	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.domain.GrailsDomainClassProperty#getType()
	 */
	public Class getType() {
		return this.type;
	}

	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.domain.GrailsDomainClassProperty#isPersistant()
	 */
	public boolean isPersistant() {
		return this.persistant;
	}

	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.domain.GrailsDomainClassProperty#isRequired()
	 */
	public boolean isOptional() {
		return this.optional;
	}

	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.domain.GrailsDomainClassProperty#isIdentity()
	 */
	public boolean isIdentity() {
		return this.identity;
	}
	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.domain.GrailsDomainClassProperty#isOneToMany()
	 */
	public boolean isOneToMany() {
		return this.oneToMany;
	}
	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.domain.GrailsDomainClassProperty#isManyToOne()
	 */
	public boolean isManyToOne() {
		return this.manyToOne;
	}
	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.domain.GrailsDomainClassProperty#getFieldName()
	 */
	public String getFieldName() {
		return getName().toUpperCase();
	}
	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.domain.GrailsDomainClassProperty#isOneToOne()
	 */
	public boolean isOneToOne() {
		return this.oneToOne;
	}
	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.commons.GrailsDomainClassProperty#getDomainClass()
	 */
	public GrailsDomainClass getDomainClass() {
		return this.domainClass;
	}
	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.commons.GrailsDomainClassProperty#isManyToMany()
	 */
	public boolean isManyToMany() {
		return this.manyToMany;
	}

	/**
	 * @param manyToMany The manyToMany to set.
	 */
	protected void setManyToMany(boolean manyToMany) {
		this.manyToMany = manyToMany;
	}

	/**
	 * @param oneToMany The oneToMany to set.
	 */
	protected void setOneToMany(boolean oneToMany) {
		this.oneToMany = oneToMany;
	}


	/**
	 * @param manyToOne The manyToOne to set.
	 */
	protected void setManyToOne(boolean manyToOne) {
		this.manyToOne = manyToOne;
	}


	/**
	 * @param oneToOne The oneToOne to set.
	 */
	protected void setOneToOne(boolean oneToOne) {
		this.oneToOne = oneToOne;
	}


	/**
	 * @param persistant The persistant to set.
	 */
	protected void setPersistant(boolean persistant) {
		this.persistant = persistant;
	}

	
	/**
	 * Sets whether the relationship is bidirectional or not
	 * @param bidirectional
	 */
	protected void setBidirectional(boolean bidirectional) {
		this.bidirectional = bidirectional;
	}


	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.commons.GrailsDomainClassProperty#getTypePropertyName()
	 */
	public String getTypePropertyName() {	
		String shortTypeName = ClassUtils.getShortClassName( this.type );
		return shortTypeName.substring(0,1).toLowerCase() + shortTypeName.substring(1);
	}

	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.commons.GrailsDomainClassProperty#getReferencedPropertyType()
	 */
	public Class getReferencedPropertyType() {
		if(this.type.equals( Set.class ) && this.referencedPropertyType != null) {
			return this.referencedPropertyType;
		}
		else {
			return getType();
		}
	}

	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.commons.GrailsDomainClassProperty#isBidirectional()
	 */
	public boolean isBidirectional() {
		return this.bidirectional;
	}

	/**
	 * Sets the referenced property type of this property
	 * @param referencedPropertyType
	 */
	protected void setReferencedPropertyType(Class referencedPropertyType) {
		this.referencedPropertyType = referencedPropertyType;
	}

	
	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.commons.GrailsDomainClassProperty#isAssociation()
	 */

	public GrailsDomainClass getReferencedDomainClass() {
		return this.referencedDomainClass;
	}


	protected void setReferencedDomainClass(GrailsDomainClass referencedDomainClass) {
		if(referencedDomainClass != null) {
			this.referencedDomainClass = referencedDomainClass;
			this.referencedPropertyType = referencedDomainClass.getClazz();
		}
	}


	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.commons.GrailsDomainClassProperty#isAssociation()
	 */
	public boolean isAssociation() {
		if(	isOneToMany() ||
			isOneToOne() ||
			isManyToOne() ||
			isManyToMany() )
			return true;
		else
			return false;
	}


	/* (non-Javadoc)
	 * @see java.lang.Object#toString()
	 */
	public String toString() {
		String assType = null;
		if(isManyToMany()) {
			assType = "many-to-many";
		}
		else if(isOneToMany()) {
			assType = "one-to-many";
		}
		else if(isOneToOne()) {
			assType = "one-to-one";
		}
		else if(isManyToOne()) {
			assType = "many-to-one";
		}
		return new ToStringBuilder(this)
						.append("name", this.name)
						.append("type", this.type)
						.append("persistent", isPersistant())
						.append("optional", isOptional())
						.append("association", isAssociation())
						.append("bidirectional", isBidirectional())
						.append("association-type", assType)
						.toString();
	}

	/* (non-Javadoc)
	 * @see org.codehaus.groovy.grails.commons.GrailsDomainClassProperty#getOtherSide()
	 */
	public GrailsDomainClassProperty getOtherSide() {
		return this.otherSide;
	}


	protected void setOtherSide(GrailsDomainClassProperty property) {
		this.otherSide = property;
	}


}