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/).

There is a newer version: 2.0

Show 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 enum Reference {
        spatial, temporal, combined, other;

        public String getName() {
            return Character.toString(this.name().charAt(0)).toUpperCase()+this.name().substring(1);
        }
    }

    public static 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();

}