git://source.jalview.org
/
proteocache.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Add mode comments to the classes
[proteocache.git]
/
datadb
/
compbio
/
cassandra
/
readers
/
CassandraReader.java
diff --git
a/datadb/compbio/cassandra/readers/CassandraReader.java
b/datadb/compbio/cassandra/readers/CassandraReader.java
index
f970659
..
a4561be
100644
(file)
--- a/
datadb/compbio/cassandra/readers/CassandraReader.java
+++ b/
datadb/compbio/cassandra/readers/CassandraReader.java
@@
-9,11
+9,22
@@
import com.datastax.driver.core.exceptions.QueryValidationException;
import compbio.cassandra.CassandraNativeConnector;
import compbio.cassandra.CassandraNativeConnector;
+/**
+ * basic reader of the ProteoCache database. It depends on open
+ * CassandraNativeConnector, which should provide an open session to the
+ * ProteoCache DB (in the default constructor)
+ *
+ * @author as373024
+ *
+ */
public class CassandraReader {
protected static long earlestDate = 0;
protected Session session;
protected static Logger log = Logger.getLogger(CassandraNativeConnector.class);
public class CassandraReader {
protected static long earlestDate = 0;
protected Session session;
protected static Logger log = Logger.getLogger(CassandraNativeConnector.class);
+ /**
+ * default constructor.
+ */
public CassandraReader() {
Session inis = CassandraNativeConnector.getSession();
setSession(inis);
public CassandraReader() {
Session inis = CassandraNativeConnector.getSession();
setSession(inis);
@@
-24,6
+35,13
@@
public class CassandraReader {
session = s;
}
session = s;
}
+ /**
+ * Basic query to the DB. The method throws exception if the input command
+ * is not valid or if there is a problem with execution of the command
+ *
+ * @param command - reading CQL command
+ * @return resulting outout of the command
+ */
protected ResultSet CassandraQuery(String command) {
try {
ResultSet results = session.execute(command);
protected ResultSet CassandraQuery(String command) {
try {
ResultSet results = session.execute(command);
@@
-44,14
+62,16
@@
public class CassandraReader {
}
}
- /*
- * find the earliest date in the database
+ /**
+ * finds the earliest date in the database
+ *
+ * @return the earliest date (long)
*/
public static long earliestDate() {
earlestDate = CassandraNativeConnector.getEarliestDateInDB();
return earlestDate;
}
*/
public static long earliestDate() {
earlestDate = CassandraNativeConnector.getEarliestDateInDB();
return earlestDate;
}
-
+
/**
* prepares an example of either job id or IP for the DB
*
/**
* prepares an example of either job id or IP for the DB
*