AbstractModelInstanceElement.java

/**
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright (C) 2007 Ronny Brandt (Ronny_Brandt@web.de).                    *
 * All rights reserved.                                                      *
 *                                                                           *
 * This work was done as a project at the Chair for Software Technology,     *
 * Dresden University Of Technology, Germany (http://st.inf.tu-dresden.de).  *
 * It is understood that any modification not identified as such is not      *
 * covered by the preceding statement.                                       *
 *                                                                           *
 * This work is free software; you can redistribute it and/or modify it      *
 * under the terms of the GNU Library General Public License as published    *
 * by the Free Software Foundation; either version 2 of the License, or      *
 * (at your option) any later version.                                       *
 *                                                                           *
 * This work is distributed in the hope that it will be useful, but WITHOUT  *
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or     *
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public     *
 * License for more details.                                                 *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public License *
 * along with this library; if not, you can view it online at                *
 * http://www.fsf.org/licensing/licenses/gpl.html.                           *
 *                                                                           *
 * To submit a bug report, send a comment, or get the latest news on this    *
 * project, please visit the website: http://dresden-ocl.sourceforge.net.    *
 * For more information on OCL and related projects visit the OCL Portal:    *
 * http://st.inf.tu-dresden.de/ocl                                           *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 */
package org.dresdenocl.modelinstancetype.types.base;

import org.dresdenocl.modelinstancetype.types.IModelInstanceCollection;
import org.dresdenocl.modelinstancetype.types.IModelInstanceElement;
import org.dresdenocl.pivotmodel.Type;

/**
 * <p>
 * An abstract implementation of {@link IModelInstanceElement}.
 * </p>
 * 
 * @author Ronny Brandt: Built the first version.
 * @author Claas Wilke: Did re-factoring and added Java-doc.
 */
public abstract class AbstractModelInstanceElement implements
		IModelInstanceElement {

	/**
	 * The {@link Type} of the <code>IModel</code> of which this
	 * {@link IModelInstanceElement} is an instance.
	 */
	protected Type myType;

	/**
	 * The name of this {@link IModelInstanceElement}. Could be
	 * <code>null</code>.
	 */
	protected String myName;

	/**
	 * The id of this {@link IModelInstanceElement}. Could be <code>null</code>.
	 */
	protected String myId;
	

	/**
	 * <p>
	 * Checks if the given {@link Object} is equal to this
	 * {@link AbstractModelInstanceElement}. This method must be implemented in
	 * respect to equivalence of two {@link IModelInstanceElement}s contained in
	 * the same {@link IModelInstanceCollection}.
	 * </p>
	 * 
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public abstract boolean equals(Object object);

	/**
	 * <p>
	 * This method must be overriden according to the required implementation of
	 * {@link AbstractModelInstanceElement#equals(Object)}.
	 * </p>
	 * 
	 * (non-Javadoc)
	 * 
	 * @see java.lang.Object#hashCode()
	 * @see org.dresdenocl.modelinstancetype.types.base.AbstractModelInstanceElement#equals(Object)
	 */
	@Override
	public abstract int hashCode();

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.dresdenocl.modelbus.IModelInstanceElement#getName()
	 */
	public String getName() {

		StringBuffer resultBuffer;

		resultBuffer = new StringBuffer();

		/* Probably return the element's name. */
		if (this.myName != null) {
			resultBuffer.append(this.myName);
		}

		/* Else probably return the element's id. */
		else if (this.myId != null) {
			resultBuffer.append(this.myId);
		}

		/* Else construct a name of all implemented types. */
		else {
			resultBuffer.append("[");
			resultBuffer.append(this.myType.getName());
			resultBuffer.append("]");
		}
		// end else.

		return resultBuffer.toString();
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.dresdenocl.modelinstancetype.types.IModelInstanceElement
	 * #getType()
	 */
	public Type getType() {

		return this.myType;
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.dresdenocl.modelinstancetype.types.IModelInstanceElement
	 * #isTypeOf(org.dresdenocl.pivotmodel.Type)
	 */
	public boolean isTypeOf(Type type) {

		return type.equals(this.myType);
	}
}