com.mongodb.gridfs

Class GridFSDBFile

java.lang.Object

com.mongodb.gridfs.GridFSFile

com.mongodb.gridfs.GridFSDBFile

All Implemented Interfaces:

DBObject, BSONObject

public class GridFSDBFile
extends GridFSFile

This class enables retrieving a GridFS file metadata and content. Operations include:

• Writing data to a file on disk or an OutputStream
• Creating an InputStream to stream the data into

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	GridFSDBFile.GridFSInputStream

Field Summary

Fields inherited from class com.mongodb.gridfs.GridFSFile

chunkSize, contentType, extra, filename, fs, id, length, md5, uploadDate

Constructor Summary

Constructors

Constructor and Description
GridFSDBFile()

Method Summary

Modifier and Type	Method and Description
private byte[]	getChunk(int chunkNumber)
java.io.InputStream	getInputStream() Returns an InputStream from which data can be read.
(package private) void	remove() Removes file from GridFS i.e.
long	writeTo(java.io.File file) Writes the file's data to a file on disk.
long	writeTo(java.io.OutputStream out) Writes the file's data to an OutputStream.
long	writeTo(java.lang.String filename) Writes the file's data to a file on disk.

Methods inherited from class com.mongodb.gridfs.GridFSFile

containsField, containsKey, get, getAliases, getChunkSize, getContentType, getFilename, getGridFS, getId, getLength, getMD5, getMetaData, getUploadDate, isPartialObject, keySet, markAsPartialObject, numChunks, put, putAll, putAll, removeField, save, setGridFS, setMetaData, toMap, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

GridFSDBFile

public GridFSDBFile()

Method Detail

getInputStream

public java.io.InputStream getInputStream()

Returns an InputStream from which data can be read.

Returns:

the input stream

writeTo

public long writeTo(java.lang.String filename)
             throws java.io.IOException

Writes the file's data to a file on disk.

Parameters:

filename - the file name on disk

Returns:

number of bytes written

Throws:

java.io.IOException - if there are problems writing to the file

writeTo

public long writeTo(java.io.File file)
             throws java.io.IOException

Writes the file's data to a file on disk.

Parameters:

file - the File object

Returns:

number of bytes written

Throws:

java.io.IOException - if there are problems writing to the file

writeTo

public long writeTo(java.io.OutputStream out)
             throws java.io.IOException

Writes the file's data to an OutputStream.

Parameters:

out - the OutputStream

Returns:

number of bytes written

Throws:

java.io.IOException - if there are problems writing to out

getChunk

private byte[] getChunk(int chunkNumber)

remove

void remove()

Removes file from GridFS i.e. removes documents from files and chunks collections.