-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathNote.java
More file actions
94 lines (84 loc) · 2.84 KB
/
Note.java
File metadata and controls
94 lines (84 loc) · 2.84 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/*
* BioJava development code
*
* This code may be freely distributed and modified under the
* terms of the GNU Lesser General Public Licence. This should
* be distributed with the code. If you do not have a copy,
* see:
*
* http://www.gnu.org/copyleft/lesser.html
*
* Copyright for this code is held jointly by the individual
* authors. These should be listed in @author doc comments.
*
* For more information on the BioJava project and its aims,
* or to join the biojava-l mailing list, visit the home page
* at:
*
* http://www.biojava.org/
*
*/
package org.biojavax;
import org.biojava.utils.ChangeType;
import org.biojava.utils.ChangeVetoException;
import org.biojava.utils.Changeable;
import org.biojavax.ontology.ComparableTerm;
/**
* Note is a generic class intended to hold a term describing the note,
* a value to associate with that term, and a rank. It is a generic representation
* of the various qualifier_value tables in BioSQL. It is used inside RichAnnotation
* objects to represent annotations.
* @author Richard Holland
* @see RichAnnotation
* @since 1.5
*/
public interface Note extends Comparable,Changeable {
public static final ChangeType TERM = new ChangeType(
"This note's term has changed",
"org.biojavax.Note",
"TERM"
);
public static final ChangeType RANK = new ChangeType(
"This note's rank has changed",
"org.biojavax.Note",
"RANK"
);
public static final ChangeType VALUE = new ChangeType(
"This note's value has changed",
"org.biojavax.Note",
"VALUE"
);
/**
* Gets the term that defines this note.
* @return a ComparableTerm object that is the key to this note.
*/
public ComparableTerm getTerm();
/**
* Sets the term for this note. It cannot be null.
* @param term the term to use.
* @throws ChangeVetoException if it doesn't like the term.
*/
public void setTerm(ComparableTerm term) throws ChangeVetoException;
/**
* Gets the value that defines this note.
* @return a String object that is the value to this note.
*/
public String getValue();
/**
* Sets the value for this note, or null for no value.
* @param value the value to use.
* @throws ChangeVetoException if it doesn't like the value.
*/
public void setValue(String value) throws ChangeVetoException;
/**
* Gets the rank that defines this note.
* @return an int that is the rank to this note.
*/
public int getRank();
/**
* Sets the rank for this note.
* @param value the rank to use.
* @throws ChangeVetoException if it doesn't like the rank.
*/
public void setRank(int value) throws ChangeVetoException;
}