tools.xor.ExternalProperty Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xor Show documentation
Empowering Model Driven Architecture in J2EE applications
There is a newer version: 2.4.1
/**
 * XOR, empowering Model Driven Architecture in J2EE applications
 *
 * Copyright (c) 2012, Dilip Dalton
 *
 * 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 tools.xor;

import java.util.ArrayList;
import java.util.List;

import javax.persistence.metamodel.Attribute.PersistentAttributeType;
import javax.xml.bind.annotation.XmlTransient;

import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;

import tools.xor.service.DataAccessService;
import tools.xor.service.Shape;

public class ExternalProperty extends AbstractProperty {
	private static final Logger logger = LogManager.getLogger(new Exception().getStackTrace()[0].getClassName());	

	private ExtendedProperty domainProperty;
	private Boolean containment; // Note: this should be an instance to allow 3VL.
	
	public ExternalProperty(ExtendedProperty domainProperty, Type type, ExternalType parentType, Type elementType) {
		super(type, parentType);
		this.domainProperty = domainProperty;
		setElementType(elementType);			
		
		init();
	}

	public ExternalProperty(String name, ExtendedProperty domainProperty, Type type, EntityType parentType, Type elementType) {
		super(name, type, parentType);
		this.domainProperty = domainProperty;
		setElementType(elementType);
	}

	@Override
	protected void initBusinessLogicAnnotations() {
		// Business logic not supported on external types
	}
	
	private void setElementType(Type eType) {
		this.elementType = eType;
		if(this.elementType != null) {
			this.relType = RelationshipType.TO_MANY;
		}			
	}
	
	@Override
	public Property getDomainProperty() {
		return domainProperty;
	}
	
	public Class getJavaType() {
		return (field != null) ? field.getDeclaringClass() : getterMethod.getDeclaringClass();
	}
	
	@Override
	public String getName() {
		return domainProperty.getName();
	}

	@Override
	public boolean isMany() {
		return domainProperty.isMany();
	}

	@Override
	public boolean isContainment() {
		// First check if the field has been initialized,
		// if not, fallback to the domain value
		if(containment != null) {
			return containment;
		}
		return domainProperty.isContainment();
	}

	/**
	 * It is possible to mark an external property as a containment property for
	 * data generation reasons.
	 * This allows us to enhance the model without touching
	 * the domain model. By setting it as containment, these fields will be given
	 * priority for data generation, and hence make them available for linking with
	 * non-containment relationships.
	 *
	 * @param containment value to set
	 */
	public void setContainment(boolean containment) {
		this.containment = containment;
	}

	@Override
	public Object getDefault() {
		return null;
	}

	@Override
	public boolean isReadOnly() {
		return getDomainProperty().isReadOnly();
	}

	@Override
	public boolean isNullable() {
		return domainProperty.isNullable();
	}

	@Override
	public List getInstanceProperties() {
		return new ArrayList