1 /*
2 * The basecode project
3 *
4 * Copyright (c) 2007-2019 Columbia University
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 java.util.Collection;
22
23 /**
24 * @author Paul
25 *
26 */
27 public interface OntologyTerm extends OntologyResource {
28
29 public Collection<String> getAlternativeIds();
30
31 public Collection<AnnotationProperty> getAnnotations();
32
33 /**
34 * @param direct return only the immediate children; if false, return all of them down to the leaves.
35 * @return
36 */
37 public Collection<OntologyTerm> getChildren( boolean direct );
38
39 public String getComment();
40
41 public Collection<OntologyIndividual> getIndividuals();
42
43 public Collection<OntologyIndividual> getIndividuals( boolean direct );
44
45 public String getLocalName();
46
47 public Object getModel();
48
49 /**
50 * Note that any restriction superclasses are not returned, unless they are has_proper_part
51 *
52 * @param direct
53 * @return
54 */
55 public Collection<OntologyTerm> getParents( boolean direct );
56
57 public Collection<OntologyRestriction> getRestrictions();
58
59 public String getTerm();
60
61 @Override
62 public String getUri();
63
64 public boolean isRoot();
65
66 /** check to see if the term is obsolete, if it is it should not be used */
67 public boolean isTermObsolete();
68
69 }