edu.byu.hbll.neon.core

Class MongoDB

java.lang.Object

edu.byu.hbll.neon.core.MongoDB

All Implemented Interfaces:

Closeable, AutoCloseable

public class MongoDB
extends Object
implements Closeable

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENT_COLLECTION

Constructor Summary

Constructors

Constructor and Description
MongoDB()
MongoDB(com.mongodb.MongoClient mongo, String database)
MongoDB(String host, int port, String database)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying MongoClient.
void	deleteDependency(String sourceName, String id)
void	deleteDocument(String id)
void	deleteHarvest(String sourceName, String id)
void	deleteProcess(String id)
static long	getBaseCursor(Instant time) Returns a floored cursor based on the given time.
static long	getCursor() Generates a timestamp based long that can be used as cursor in a database.
Set<Dependency>	getDependencies(String id)
List<String>	getDependencies(String source, int limit)
FullDocument	getDocument(String id)
List<FullDocument>	getDocuments(List<String> ids)
List<LoadDocument>	getFromQueue(com.mongodb.client.MongoCollection<org.bson.Document> collection, int limit)
List<LoadDocument>	getHarvestDocuments(int limit)
String	getIdFromSourceId(org.bson.Document document)
List<String>	getProcessTasks(int limit)
com.fasterxml.jackson.databind.node.ObjectNode	getToken(String source)
List<FullDocument>	harvest(long from, int limit, boolean includeDeleted, List<String> fields, List<String> collections)
void	putDependency(Dependency dependency)
void	putHarvestDocument(boolean primary, LoadDocument loadDocument)
void	putProcessDocument(String id)
void	putResultDocument(FullDocument resultDocument)
void	putSourceDocument(LoadDocument loadDocument)
void	setHarvestCursor(String source, com.fasterxml.jackson.databind.JsonNode cursor)
org.bson.Document	toSourceId(String sourceName, String id)
void	updateDependencies(String id, Set<Dependency> dependencies)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOCUMENT_COLLECTION

public static final String DOCUMENT_COLLECTION

See Also:

Constant Field Values

Constructor Detail

MongoDB

public MongoDB()

MongoDB

public MongoDB(String host,
               int port,
               String database)

Parameters:

host -

port -

database -

MongoDB

public MongoDB(com.mongodb.MongoClient mongo,
               String database)

Parameters:

mongo -

database -

Method Detail

getDocuments

public List<FullDocument> getDocuments(List<String> ids)

Parameters:

ids -

Returns:

getDocument

public FullDocument getDocument(String id)

Parameters:

id -

Returns:

harvest

public List<FullDocument> harvest(long from,
                                  int limit,
                                  boolean includeDeleted,
                                  List<String> fields,
                                  List<String> collections)

Parameters:

from -

limit -

includeDeleted -

fields -

collections -

Returns:

putResultDocument

public void putResultDocument(FullDocument resultDocument)

Parameters:

resultDocument -

deleteDocument

public void deleteDocument(String id)

Parameters:

id -

updateDependencies

public void updateDependencies(String id,
                               Set<Dependency> dependencies)

Parameters:

id -

dependencies -

putSourceDocument

public void putSourceDocument(LoadDocument loadDocument)

Parameters:

loadDocument -

putHarvestDocument

public void putHarvestDocument(boolean primary,
                               LoadDocument loadDocument)

Parameters:

primary -

loadDocument -

toSourceId

public org.bson.Document toSourceId(String sourceName,
                                    String id)

Parameters:

sourceName -

id -

Returns:

getIdFromSourceId

public String getIdFromSourceId(org.bson.Document document)

Parameters:

document -

Returns:

putProcessDocument

public void putProcessDocument(String id)

Parameters:

id -

getToken

public com.fasterxml.jackson.databind.node.ObjectNode getToken(String source)

Parameters:

source -

Returns:

getDependencies

public List<String> getDependencies(String source,
                                    int limit)

Parameters:

source -

limit -

Returns:

getDependencies

public Set<Dependency> getDependencies(String id)

Parameters:

id -

Returns:

setHarvestCursor

public void setHarvestCursor(String source,
                             com.fasterxml.jackson.databind.JsonNode cursor)

Parameters:

source -

cursor -

putDependency

public void putDependency(Dependency dependency)

Parameters:

dependency -

deleteDependency

public void deleteDependency(String sourceName,
                             String id)

Parameters:

sourceName -

id -

deleteHarvest

public void deleteHarvest(String sourceName,
                          String id)

Parameters:

sourceName -

id -

deleteProcess

public void deleteProcess(String id)

Parameters:

id -

getProcessTasks

public List<String> getProcessTasks(int limit)

Returns:

getHarvestDocuments

public List<LoadDocument> getHarvestDocuments(int limit)

Returns:

getFromQueue

public List<LoadDocument> getFromQueue(com.mongodb.client.MongoCollection<org.bson.Document> collection,
                                       int limit)

Parameters:

collection -

limit -

Returns:

getCursor

public static long getCursor()

Generates a timestamp based long that can be used as cursor in a database. The top 34 bits represent the number of seconds since the epoch. The middle 12 bits are an auto incrementing value that starts over each second. The bottom 16 bits are a random number. The goal is to generate a unique id (or at least a very high probability of being unique) that increments with time for paging through entries in a database.

With 34 bits for the time component, this strategy should work until approximately the year 2242.

Returns:

getBaseCursor

public static long getBaseCursor(Instant time)

Returns a floored cursor based on the given time. The incrementing and random value are zeroed out.

Returns:

close

public void close()
           throws IOException

Closes the underlying MongoClient.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException