Package com.mongodb.gridfs
Class GridFSFile
-
- com.mongodb.gridfs.GridFSFile
-
- All Implemented Interfaces:
DBObject
,BSONObject
- Direct Known Subclasses:
GridFSDBFile
,GridFSInputFile
public abstract class GridFSFile extends implements DBObject
The abstract class representing a GridFS file.- MongoDB documentation
-
-
Constructor Summary
Constructors Constructor Description GridFSFile()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
s)
Checks if this object contains a field with the given name.boolean
key)
Deprecated.key)
Gets a field from this object by a given name.<>
getAliases()
Gets the aliases from the metadata.long
getChunkSize()
Gets the size of a chunk.getContentType()
Gets the content type.getFilename()
Gets the filename.protected GridFS
getGridFS()
Gets the GridFS associated with this filegetId()
Gets the id.long
getLength()
Gets the file's length.getMD5()
Deprecated.there is no replacement for this methodDBObject
getMetaData()
Gets the file metadata.getUploadDate()
Gets the upload date.boolean
isPartialObject()
WhetherDBObject.markAsPartialObject()
was ever called only matters if you are going to upsert and do not want to risk losing fields.<>
keySet()
Returns this object's fields' namesvoid
markAsPartialObject()
If this object was retrieved with only some fields (using a field filter) this method will be called to mark it as such.int
numChunks()
Returns the number of chunks that store the file data.key, v)
Sets a name/value pair in this object.void
m)
Sets all key/value pairs from a map into this objectvoid
putAll(BSONObject o)
Sets all key/value pairs from an object into this objectkey)
Removes a field with a given name from this object.void
save()
Saves the file entry to the files collectionprotected void
setGridFS(GridFS fs)
Sets the GridFS associated with this file.void
setMetaData(DBObject metadata)
Gets the file metadata.<?,?>
toMap()
Returns a map representing this BSONObject.toString()
void
validate()
Deprecated.there is no replacement for this method
-
-
-
Method Detail
-
save
public void save()
Saves the file entry to the files collection- Throws:
MongoException
- if there's a failure
-
validate
public void validate()
Deprecated.there is no replacement for this methodVerifies that the MD5 matches between the database and the local file. This should be called after transferring a file.- Throws:
MongoException
- if there's a failure
-
numChunks
public int numChunks()
Returns the number of chunks that store the file data.- Returns:
- number of chunks
-
getId
public getId()
Gets the id.- Returns:
- the id of the file.
-
getFilename
public getFilename()
Gets the filename.- Returns:
- the name of the file
-
getContentType
public getContentType()
Gets the content type.- Returns:
- the content type
-
getLength
public long getLength()
Gets the file's length.- Returns:
- the length of the file
-
getChunkSize
public long getChunkSize()
Gets the size of a chunk.- Returns:
- the chunkSize
-
getUploadDate
public getUploadDate()
Gets the upload date.- Returns:
- the date
-
getAliases
public <> getAliases()
Gets the aliases from the metadata. note: to set aliases, callput(String, Object)
with"aliases" , List<String>
.- Returns:
- list of aliases
-
getMetaData
public DBObject getMetaData()
Gets the file metadata.- Returns:
- the metadata
-
setMetaData
public void setMetaData(DBObject metadata)
Gets the file metadata.- Parameters:
metadata
- metadata to be set
-
getMD5
public getMD5()
Deprecated.there is no replacement for this methodGets the observed MD5 during transfer- Returns:
- md5
-
put
public put( key, v)
Description copied from interface:BSONObject
Sets a name/value pair in this object.- Specified by:
put
in interfaceBSONObject
- Parameters:
key
- Name to setv
- Corresponding value- Returns:
- the previous value associated with
key
, ornull
if there was no mapping forkey
. (Anull
return can also indicate that the map previously associatednull
withkey
.)
-
get
public get( key)
Description copied from interface:BSONObject
Gets a field from this object by a given name.- Specified by:
get
in interfaceBSONObject
- Parameters:
key
- The name of the field fetch- Returns:
- The field, if found
-
containsKey
public boolean containsKey( key)
Deprecated.Description copied from interface:BSONObject
Deprecated- Specified by:
containsKey
in interfaceBSONObject
- Parameters:
key
- the key to check- Returns:
- True if the key is present
-
containsField
public boolean containsField( s)
Description copied from interface:BSONObject
Checks if this object contains a field with the given name.- Specified by:
containsField
in interfaceBSONObject
- Parameters:
s
- Field name for which to check- Returns:
- True if the field is present
-
keySet
public <> keySet()
Description copied from interface:BSONObject
Returns this object's fields' names- Specified by:
keySet
in interfaceBSONObject
- Returns:
- The names of the fields in this object
-
isPartialObject
public boolean isPartialObject()
Description copied from interface:DBObject
WhetherDBObject.markAsPartialObject()
was ever called only matters if you are going to upsert and do not want to risk losing fields.- Specified by:
isPartialObject
in interfaceDBObject
- Returns:
- true if this has been marked as a partial object
-
markAsPartialObject
public void markAsPartialObject()
Description copied from interface:DBObject
If this object was retrieved with only some fields (using a field filter) this method will be called to mark it as such.- Specified by:
markAsPartialObject
in interfaceDBObject
-
toString
public toString()
- Overrides:
in class
-
setGridFS
protected void setGridFS(GridFS fs)
Sets the GridFS associated with this file.- Parameters:
fs
- gridFS instance
-
getGridFS
protected GridFS getGridFS()
Gets the GridFS associated with this file- Returns:
- gridFS instance
-
putAll
public void putAll(BSONObject o)
Description copied from interface:BSONObject
Sets all key/value pairs from an object into this object- Specified by:
putAll
in interfaceBSONObject
- Parameters:
o
- the object
-
putAll
public void putAll( m)
Description copied from interface:BSONObject
Sets all key/value pairs from a map into this object- Specified by:
putAll
in interfaceBSONObject
- Parameters:
m
- the map
-
toMap
public <?,?> toMap()
Description copied from interface:BSONObject
Returns a map representing this BSONObject.- Specified by:
toMap
in interfaceBSONObject
- Returns:
- the map
-
removeField
public removeField( key)
Description copied from interface:BSONObject
Removes a field with a given name from this object.- Specified by:
removeField
in interfaceBSONObject
- Parameters:
key
- The name of the field to remove- Returns:
- The value removed from this object
-
-