com.vaadin.addon.jpacontainer.metadata.EntityClassMetadata Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jpacontainer-addon-agpl-3.0 Show documentation
Vaadin JPAContainer
The newest version!
/*
JPAContainer
Copyright (C) 2009-2011 Oy Vaadin Ltd

This program is available under GNU Affero General Public License (version
3 or later at your option).

See the file licensing.txt distributed with this software for more
information about licensing.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see .
 */
package com.vaadin.addon.jpacontainer.metadata;

import javax.persistence.Entity;

/**
 * An extended version of {@link ClassMetadata} that provides additional
 * information about classes annotated with the {@link Entity} annotation.
 * 
 * @author Petter Holmström (Vaadin Ltd)
 * @since 1.0
 */
public class EntityClassMetadata extends ClassMetadata {

	private static final long serialVersionUID = -4870942071257502328L;
	private final String entityName;
	private String versionProperty;
	private String identifierProperty;

	/**
	 * Creates a new instance of EntityClassMetadata.
	 * 
	 * @param mappedClass
	 *            the entity class (must not be null).
	 * @param entityName
	 *            the entity name (must not be null).
	 */
	EntityClassMetadata(Class mappedClass, String entityName) {
		super(mappedClass);
		assert entityName != null : "entityName must not be null";
		this.entityName = entityName;
	}

	/**
	 * Sets the name of the property that contains the version, if any.
	 * 
	 * @param propertyName
	 *            the property name, may be null.
	 */
	void setVersionPropertyName(String propertyName) {
		if (propertyName != null) {
			PropertyMetadata pm = getProperty(propertyName);
			if (pm == null || !(pm instanceof PersistentPropertyMetadata)) {
				throw new IllegalArgumentException("Invalid property");
			}
		}
		this.versionProperty = propertyName;
	}

	/**
	 * Sets the name of the property that contains the identifier, if any.
	 * 
	 * @param propertyName
	 *            the property name, may be null.
	 * @throws IllegalArgumentException
	 *             if propertyName is invalid (i.e. the property
	 *             does not exist or is transient).
	 */
	void setIdentifierPropertyName(String propertyName)
			throws IllegalArgumentException {
		if (propertyName != null) {
			PropertyMetadata pm = getProperty(propertyName);
			if (pm == null || !(pm instanceof PersistentPropertyMetadata)) {
				throw new IllegalArgumentException("Invalid property");
			}
		}
		this.identifierProperty = propertyName;
	}

	/**
	 * The name of the entity. If no explicit entity name has been given, this
	 * is the simple class name.
	 */
	public String getEntityName() {
		return entityName;
	}

	/**
	 * If the entity has a version property or not.
	 * 
	 * @see #getVersionProperty()
	 */
	public boolean hasVersionProperty() {
		return versionProperty != null;
	}

	/**
	 * Gets the version property, if it exists.
	 * 
	 * @see #hasVersionProperty()
	 * @return the version property metadata, or null if not available.
	 */
	public PersistentPropertyMetadata getVersionProperty() {
		return versionProperty == null ? null
				: (PersistentPropertyMetadata) getProperty(versionProperty);
	}

	/**
	 * If the entity has an identifier property or not.
	 * 
	 * @see #getIdentifierProperty()
	 * @see #hasEmbeddedIdentifier()
	 */
	public boolean hasIdentifierProperty() {
		return identifierProperty != null;
	}

	/**
	 * Gets the identifier property, if it exists. If
	 * {@link #hasEmbeddedIdentifier() } returns true, this property is the
	 * embedded identifier.
	 * 
	 * @see #hasIdentifierProperty()
	 * @see #hasEmbeddedIdentifier()
	 * @return the identifier property metadata, or null if not available.
	 */
	public PersistentPropertyMetadata getIdentifierProperty() {
		return identifierProperty == null ? null
				: (PersistentPropertyMetadata) getProperty(identifierProperty);
	}

	/**
	 * If the entity has an embedded identifier. This property cannot be true
	 * unless {@link #hasIdentifierProperty() } also returns true.
	 */
	public boolean hasEmbeddedIdentifier() {
		return hasIdentifierProperty()
				&& getIdentifierProperty().getPropertyKind() == PersistentPropertyMetadata.PropertyKind.EMBEDDED;
	}

	@Override
	public boolean equals(Object obj) {
		if (super.equals(obj)) { // Includes a check of the parameter class
			EntityClassMetadata other = (EntityClassMetadata) obj;
			return entityName.equals(other.entityName)
					&& (versionProperty == null ? other.versionProperty == null
							: versionProperty.equals(other.versionProperty))
					&& (identifierProperty == null ? other.identifierProperty == null
							: identifierProperty
									.equals(other.identifierProperty));
		}
		return false;
	}

	@Override
	public int hashCode() {
		int hash = super.hashCode();
		hash = hash * 31 + entityName.hashCode();
		if (versionProperty != null) {
			hash = hash * 31 + versionProperty.hashCode();
		}
		if (identifierProperty != null) {
			hash = hash * 31 + identifierProperty.hashCode();
		}
		return hash;
	}
}