1 /*
2 * The basecode project
3 *
4 * Copyright (c) 2007-2019 University of British Columbia
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 */
19 package ubic.basecode.ontology.model;
20
21 import javax.annotation.Nullable;
22
23 /**
24 * @author pavlidis
25 */
26 public interface OntologyResource extends Comparable<OntologyResource> {
27
28 /**
29 * A URI if known, otherwise null.
30 */
31 @Nullable
32 String getUri();
33
34 /**
35 * A local name for this resource.
36 */
37 String getLocalName();
38
39 /**
40 * A label, if known, otherwise null.
41 */
42 @Nullable
43 String getLabel();
44
45 /**
46 * A comment for the resource, if available, otherwise null.
47 */
48 @Nullable
49 String getComment();
50
51 /**
52 * Whether the resource is marked as obsolete.
53 */
54 boolean isObsolete();
55
56 /**
57 * If this is result from a free-text search, a corresponding score, otherwise null.
58 */
59 @Nullable
60 Double getScore();
61 }