com.github.tkurz.sparqlmm.doc.FunctionDoc Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sparql-mm Show documentation

SPARQL-MM is a multimedia-extension for SPARQL 1.1 (www.w3.org/TR/sparql11-query/‎) implemented for Sesame (http://www.openrdf.org/).

The newest version!

package com.github.tkurz.sparqlmm.doc;

import com.github.tkurz.sparqlmm.vocabularies.SSD;
import org.openrdf.model.URI;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * ...
 * 
 * Author: Thomas Kurz ([email protected])
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface FunctionDoc {

    public static final String SPATIAL = "Spatial";
    public static final String TEMPORAL = "Temporal";
    public static final String GENERAL = "General";

    public static final String R = "R";
    public static final String A = "A";
    public static final String F = "F";

    public static final String RELATION = "Relation";
    public static final String AGGREGATION = "Aggregation";
    public static final String ACCESSOR = "Accessor";

    enum Reference {
        spatial(SPATIAL), temporal(TEMPORAL), combined(GENERAL);

        private String value;

        Reference(String value) {
            this.value = value;
        }

        public String getName() {
            return value;
        }
    }

    enum Type {
        extensionFunction(R, RELATION, SSD.extensionFunction),
        extensionAggregate(A, AGGREGATION, SSD.extensionAggregate),
        accessorFunction(F, ACCESSOR, SSD.extensionFunction);

        private URI uri;
        private String name;
        private String id;

        Type(String id, String name, URI uri) {
            this.name = name;
            this.uri = uri;
            this.id = id;
        }

        public URI getUri() {
            return uri;
        }

        public String getName() {
            return name;
        }

        public String getId() { return id; }
    }

    /**
     * This provides the title when generating docs
     * @return
     */
    public String title();

    /**
     * This provides description when generating docs.
     * @return
     */
    public String description() default "";

    /**
     * This provides type when generating docs.
     * @return
     */
    public Type type() default Type.extensionFunction;

    /**
     * provides
     * @return
     */
    public Reference reference();

    public Class[] properties();

}