File: NCBIComparison.java

package info (click to toggle)
bbmap 39.20%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 26,024 kB
  • sloc: java: 312,743; sh: 18,099; python: 5,247; ansic: 2,074; perl: 96; makefile: 39; xml: 38
file content (67 lines) | stat: -rwxr-xr-x 1,689 bytes parent folder | download | duplicates (4)
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
package jasper;

public class NCBIComparison implements Comparable<NCBIComparison> {

	/**
	 * Object for storing sequence similarity values between two nodes
	 * @param queryID_ int Node ID of the primary query sequence.
	 * @param refID_ int Node ID of the reference sequence.
	 * @param identity_ double similarity value between both nodes.
	 */
	public NCBIComparison(int queryID_, int refID_, double identity_) {
		
		//Set the queryID as the input value
		this.queryID = queryID_;
		
		//Set the refID as the input value
		this.refNodeID = refID_;
		
		//Set the identity as the input value
		this.identity = identity_;
	}
	
	
	/**
	 * toString method to return the queryID, the refID and the similarity with some formatting.
	 */
	public String toString() {
		return "Query node ID = " + queryID + ", Reference node ID = " + refNodeID + 
				", Similarity identity = " + identity;
	}
	
	/**
	 * Allows sorting of Comparison objects in an ArrayList<Comparison>
	 */
	public int compareTo(NCBIComparison comparison){
		
		//If the identity of this comparison is equal to another comparison, return 0.
		if(identity == comparison.identity)  {
			return 0;  
		
		//but if the identity of this Comparison is greater than another, return 1.
		}else if(identity < comparison.identity)  {
			return 1;  
		
		//The only remaining option is that the identity of this Comparison is less than another Comparison.
		//Return -1
		}else  {
			return -1;  
		}  
	}
	
	/**
	 * Current node/organism of focus.
	 */
	int queryID;
	
	/**
	 * Node being compared to the queryID node.
	 */
	int refNodeID;
	
	/**
	 * Similarity between the queryID node and the refID node.
	 */
	double identity;
	
}