au.com.redboxresearchdata.fascinator.storage.mongo

Class MongoDigitalObject

java.lang.Object

com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

au.com.redboxresearchdata.fascinator.storage.mongo.MongoDigitalObject

All Implemented Interfaces:

com.googlecode.fascinator.api.storage.DigitalObject, com.googlecode.fascinator.api.storage.JsonDigitalObject

public class MongoDigitalObject
extends com.googlecode.fascinator.common.storage.impl.GenericDigitalObject
implements com.googlecode.fascinator.api.storage.JsonDigitalObject

MongoDigitalObject

Author:

Shilo Banihit

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionName
protected org.joda.time.format.DateTimeFormatter	df
protected java.util.Map<java.lang.String,java.lang.String>	encodedChars
protected java.util.Properties	metadataProp
protected com.mongodb.client.MongoDatabase	mongoDb
protected org.bson.Document	objectMetadata
protected java.lang.String	objectMetadataCollectionName
protected java.lang.String	oid
protected au.com.redboxresearchdata.fascinator.storage.mongo.MongoDigitalObject.PayloadBackend	payloadBackend
protected org.bson.Document	recordMetadata
protected java.lang.String	sourceId

Constructor Summary

Constructors

Constructor and Description
MongoDigitalObject(com.mongodb.client.MongoDatabase mongoDb, java.lang.String collectionName, java.lang.String objectMetadataCollectionName, java.lang.String oid, au.com.redboxresearchdata.fascinator.storage.mongo.MongoDigitalObject.PayloadBackend payloadBackend)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addFileMeta(MongoPayload payload)
void	close()
com.googlecode.fascinator.api.storage.Payload	createLinkedPayload(java.lang.String pid, java.lang.String linkPath)
com.googlecode.fascinator.api.storage.Payload	createStoredPayload(java.lang.String pid, java.io.InputStream in)
boolean	existsInStorage()
org.bson.Document	getEscapedDoc(org.bson.Document source)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getFileList()
java.lang.String	getId()
java.util.Map<java.lang.String,com.googlecode.fascinator.api.storage.Payload>	getManifest() Get the manifest of the DigitalObject
protected com.mongodb.client.MongoCollection<org.bson.Document>	getMetaCollection()
java.util.Properties	getMetadata() Returns metadata of this object, caches subsequent calls.
com.mongodb.client.MongoDatabase	getMongoDb()
java.util.Map<java.lang.String,java.lang.Object>	getObjectMetadata()
com.googlecode.fascinator.api.storage.Payload	getPayload(java.lang.String pid)
java.util.Set<java.lang.String>	getPayloadIdList()
java.util.Map<java.lang.String,java.lang.Object>	getPayloadMeta(java.lang.String pid)
java.util.Map<java.lang.String,java.lang.Object>	getRecordMetadata()
protected org.bson.Document	getRecordMetadataFromDb()
java.lang.String	getSourceId()
org.bson.Document	getUnescapedDoc(org.bson.Document source)
void	load()
void	remove()
protected void	removeFileMeta(java.lang.String pid)
void	removePayload(java.lang.String pid)
void	save()
void	setId(java.lang.String oid)
void	setSourceId(java.lang.String pid)
com.googlecode.fascinator.api.storage.Payload	updatePayload(java.lang.String pid, java.io.InputStream in)
void	updatePayloadMeta(MongoPayload payload)

Methods inherited from class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

toString

Methods inherited from class java.lang.Object

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

Field Detail

mongoDb

protected com.mongodb.client.MongoDatabase mongoDb

collectionName

protected java.lang.String collectionName

objectMetadataCollectionName

protected java.lang.String objectMetadataCollectionName

oid

protected java.lang.String oid

sourceId

protected java.lang.String sourceId

objectMetadata

protected org.bson.Document objectMetadata

recordMetadata

protected org.bson.Document recordMetadata

metadataProp

protected java.util.Properties metadataProp

payloadBackend

protected au.com.redboxresearchdata.fascinator.storage.mongo.MongoDigitalObject.PayloadBackend payloadBackend

encodedChars

protected java.util.Map<java.lang.String,java.lang.String> encodedChars

df

protected org.joda.time.format.DateTimeFormatter df

Constructor Detail

MongoDigitalObject

public MongoDigitalObject(com.mongodb.client.MongoDatabase mongoDb,
                  java.lang.String collectionName,
                  java.lang.String objectMetadataCollectionName,
                  java.lang.String oid,
                  au.com.redboxresearchdata.fascinator.storage.mongo.MongoDigitalObject.PayloadBackend payloadBackend)

Method Detail

getMongoDb

public com.mongodb.client.MongoDatabase getMongoDb()

getId

public java.lang.String getId()

Specified by:

getId in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

getId in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

setId

public void setId(java.lang.String oid)

Specified by:

setId in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

setId in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

getSourceId

public java.lang.String getSourceId()

Specified by:

getSourceId in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

getSourceId in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

setSourceId

public void setSourceId(java.lang.String pid)

Specified by:

setSourceId in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

setSourceId in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

getMetadata

public java.util.Properties getMetadata()
                                 throws com.googlecode.fascinator.api.storage.StorageException

Returns metadata of this object, caches subsequent calls. THIS IS THE TF-OBJ-META in a object.

Specified by:

getMetadata in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

getMetadata in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

getManifest

public java.util.Map<java.lang.String,com.googlecode.fascinator.api.storage.Payload> getManifest()

Get the manifest of the DigitalObject

Overrides:

getManifest in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

Returns:

Manifest Map

getPayloadIdList

public java.util.Set<java.lang.String> getPayloadIdList()

Specified by:

getPayloadIdList in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

getPayloadIdList in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

createStoredPayload

public com.googlecode.fascinator.api.storage.Payload createStoredPayload(java.lang.String pid,
                                                                java.io.InputStream in)
                                                                  throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

createStoredPayload in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

createStoredPayload in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

createLinkedPayload

public com.googlecode.fascinator.api.storage.Payload createLinkedPayload(java.lang.String pid,
                                                                java.lang.String linkPath)
                                                                  throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

createLinkedPayload in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

createLinkedPayload in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

getPayload

public com.googlecode.fascinator.api.storage.Payload getPayload(java.lang.String pid)
                                                         throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

getPayload in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

getPayload in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

removePayload

public void removePayload(java.lang.String pid)
                   throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

removePayload in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

removePayload in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

updatePayload

public com.googlecode.fascinator.api.storage.Payload updatePayload(java.lang.String pid,
                                                          java.io.InputStream in)
                                                            throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

updatePayload in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

updatePayload in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

close

public void close()
           throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

close in interface com.googlecode.fascinator.api.storage.DigitalObject

Overrides:

close in class com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

getObjectMetadata

public java.util.Map<java.lang.String,java.lang.Object> getObjectMetadata()

Specified by:

getObjectMetadata in interface com.googlecode.fascinator.api.storage.JsonDigitalObject

getRecordMetadata

public java.util.Map<java.lang.String,java.lang.Object> getRecordMetadata()

Specified by:

getRecordMetadata in interface com.googlecode.fascinator.api.storage.JsonDigitalObject

getRecordMetadataFromDb

protected org.bson.Document getRecordMetadataFromDb()

existsInStorage

public boolean existsInStorage()

Specified by:

existsInStorage in interface com.googlecode.fascinator.api.storage.JsonDigitalObject

getMetaCollection

protected com.mongodb.client.MongoCollection<org.bson.Document> getMetaCollection()

save

public void save()
          throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

save in interface com.googlecode.fascinator.api.storage.JsonDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

getEscapedDoc

public org.bson.Document getEscapedDoc(org.bson.Document source)

getUnescapedDoc

public org.bson.Document getUnescapedDoc(org.bson.Document source)

load

public void load()
          throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

load in interface com.googlecode.fascinator.api.storage.JsonDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

remove

public void remove()
            throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

remove in interface com.googlecode.fascinator.api.storage.JsonDigitalObject

Throws:

com.googlecode.fascinator.api.storage.StorageException

getFileList

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getFileList()

addFileMeta

protected void addFileMeta(MongoPayload payload)

removeFileMeta

protected void removeFileMeta(java.lang.String pid)

updatePayloadMeta

public void updatePayloadMeta(MongoPayload payload)
                       throws com.googlecode.fascinator.api.storage.StorageException

Throws:

com.googlecode.fascinator.api.storage.StorageException

getPayloadMeta

public java.util.Map<java.lang.String,java.lang.Object> getPayloadMeta(java.lang.String pid)