/*
 * (c) Copyright 2010-2011 AgileBirds
 *
 * This file is part of OpenFlexo.
 *
 * OpenFlexo is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * OpenFlexo 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenFlexo. If not, see <http://www.gnu.org/licenses/>.
 *
 */
package org.openflexo.foundation.ontology;

import java.util.logging.Logger;

import org.openflexo.foundation.FlexoModelObject;
import org.openflexo.foundation.rm.XMLStorageResourceData;
import org.openflexo.inspector.InspectableObject;

public abstract class AbstractOntologyObject extends FlexoModelObject implements InspectableObject {

	private static final Logger logger = Logger.getLogger(AbstractOntologyObject.class.getPackage().getName());

	public AbstractOntologyObject() {
		super();
	}

	/**
	 * @return Returns the flexoID.
	 */
	@Override
	public long getFlexoID() {
		if (isBeingCloned()) {
			return -1;
		}
		if (getFlexoOntology() instanceof ImportedOntology) {
			// Special case for ontology objects declared in imported ontology
			// They are not linked to any project and have no FlexoID
			return -3;
		}
		return super.getFlexoID();
	}

	@Override
	public final XMLStorageResourceData getXMLResourceData() {
		// These objects are never serialized therefore they should never return an XMLResourceData.
		// If that was to ever change, consider also modifying
		// org.openflexo.dg.docx.ProjectDocDocxGenerator.getEPITag(EditionPatternInstance)
		return null;
	}

	public FlexoOntology getOntology() {
		return getFlexoOntology();
	}

	public abstract FlexoOntology getFlexoOntology();

	public OntologyLibrary getOntologyLibrary() {
		if (getFlexoOntology() != null) {
			return getFlexoOntology().getOntologyLibrary();
		}
		return null;
	}

	@Override
	public String toString() {
		return getClass().getSimpleName() + "_" + getURI();
	}

	@Override
	public abstract String getDisplayableDescription();

	public abstract boolean isOntology();

	public abstract boolean isOntologyClass();

	public abstract boolean isOntologyIndividual();

	public abstract boolean isOntologyObjectProperty();

	public abstract boolean isOntologyDataProperty();

}