001/**
002 * Copyright (C) 2007 - 2016, Jens Lehmann
003 *
004 * This file is part of DL-Learner.
005 *
006 * DL-Learner is free software; you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation; either version 3 of the License, or
009 * (at your option) any later version.
010 *
011 * DL-Learner is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU General Public License for more details.
015 *
016 * You should have received a copy of the GNU General Public License
017 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
018 */
019package org.dllearner.core;
020
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023
024/**
025 * 
026 * Annotation for DL-Learner components. Each component has to implement the interface as
027 * well as use this notation.
028 * 
029 * @author Jens Lehmann
030 *
031 */
032@Retention(RetentionPolicy.RUNTIME)
033public @interface ComponentAnn {
034
035    /**
036     * The name of this component.
037     * @return The name of this component.
038     */
039    String name();
040        
041    /**
042     * The short name of this component, which should exclusively consist of
043     * lower case ASCII symbols and "_" without whitespace.
044     * @return The short name of this component.
045     */
046    String shortName();
047    
048    /**
049     * The version of this component. 1.0 indicates a stable component. Developers
050     * should increase the version number in case of major implementation changes. 
051     * @return A version number of this component.
052     */
053    double version();
054    
055    /**
056     * An optional OWLClassExpression of the component. This can be shown in tool tips,
057     * help etc.
058     * @return The OWLClassExpression of the component.
059     */
060    String description() default "";
061}