View Javadoc

1   /*
2    * Copyright 2015 Data Archiving and Networked Services (an institute of
3    * Koninklijke Nederlandse Akademie van Wetenschappen), King's College London,
4    * Georg-August-Universitaet Goettingen Stiftung Oeffentlichen Rechts
5    *
6    * Licensed under the EUPL, Version 1.1 or – as soon they will be approved by
7    * the European Commission - subsequent versions of the EUPL (the "Licence");
8    * You may not use this work except in compliance with the Licence.
9    * You may obtain a copy of the Licence at:
10   *
11   * https://joinup.ec.europa.eu/software/page/eupl
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the Licence is distributed on an "AS IS" basis,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the Licence for the specific language governing
17   * permissions and limitations under the Licence.
18   */
19  
20  package eu.ehri.project.models.base;
21  
22  import com.tinkerpop.blueprints.Direction;
23  import com.tinkerpop.frames.Adjacency;
24  import eu.ehri.project.definitions.Ontology;
25  import eu.ehri.project.models.Annotation;
26  
27  /**
28   * An entity that can be annotated.
29   */
30  public interface Annotatable extends Entity {
31      @Adjacency(label = Ontology.ANNOTATION_ANNOTATES, direction = Direction.IN)
32      Iterable<Annotation> getAnnotations();
33  
34      @Adjacency(label = Ontology.ANNOTATION_ANNOTATES, direction = Direction.IN)
35      void addAnnotation(Annotation annotation);
36  
37      @Adjacency(label = Ontology.ANNOTATION_ANNOTATES_PART, direction = Direction.IN)
38      void addAnnotationPart(Annotation annotation);
39  }