org.semanticweb.elk.owl.interfaces.ElkAnnotation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elk-owl-model Show documentation

General Interfaces for working with OWL objects

There is a newer version: 0.29.0

/*
 * #%L
 * ELK OWL Object Interfaces
 * 
 * $Id$
 * $HeadURL$
 * %%
 * Copyright (C) 2011 - 2012 Department of Computer Science, University of Oxford
 * %%
 * 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.
 * #L%
 */
/**
 * 
 */
package org.semanticweb.elk.owl.interfaces;

import org.semanticweb.elk.owl.visitors.ElkAnnotationVisitor;

/**
 * The basic interface for annotation objects in OWL 2 as defined in
 * Section 10 of the
 * specification
 * 
 * @author Pavel Klinov
 * 
 *         [email protected]
 * 
 */

/*
 * TODO: Annotations are not included in our model. We should extend the model
 * so that every ontology, axiom, and annotation can link to a list of
 * annotations.
 */

public interface ElkAnnotation extends ElkObject {

	public ElkAnnotationProperty getProperty();

	public ElkAnnotationValue getValue();

	/**
	 * Accept an {@link ElkAnnotationVisitor}.
	 * 
	 * @param visitor
	 *            the visitor that can work with this object type
	 * @param 
	 *            the type of the output of the visitor
	 * @return the output of the visitor
	 */
	public  O accept(ElkAnnotationVisitor visitor);

	/**
	 * A factory for creating instances
	 * 
	 * @author Yevgeny Kazakov
	 *
	 */
	interface Factory {

		/**
		 * Create an {@link ElkAnnotation}
		 * 
		 * @param property
		 *            the {@link ElkAnnotationProperty} for which the object
		 *            should be created
		 * @param value
		 *            the {@link ElkAnnotationValue} for which the object should
		 *            be created
		 * @return an {@link ElkAnnotation} corresponding to the input
		 */
		public ElkAnnotation getAnnotation(ElkAnnotationProperty property,
				ElkAnnotationValue value);

	}
	
}