net.ymate.platform.persistence.mongodb

Interface IGridFsSession

All Superinterfaces:

AutoCloseable, IDestroyable, ISession<IMongoConnectionHolder>

All Known Implementing Classes:

MongoGridFsSession

@Ignored
public interface IGridFsSession
extends ISession<IMongoConnectionHolder>

Author:

刘镇 (suninformation@163.com) on 15/11/26 上午10:06

Method Summary

Modifier and Type	Method and Description
void	download(String id, File distFile) 下载文件数据并写入指定的文件
void	download(String id, OutputStream distOutputStream) 下载文件数据到指定的输出流
boolean	exists(String id) 判断指定id的文件是否存在
IResultSet<GridFSFile>	find() 查询全部记录
IResultSet<GridFSFile>	find(OrderBy orderBy) 查询全部记录
IResultSet<GridFSFile>	find(OrderBy orderBy, Page page) 查询全部记录
IResultSet<GridFSFile>	find(Query query) 根据条件查询符合条件的文件记录
IResultSet<GridFSFile>	find(QueryBuilder query) 根据条件查询符合条件的文件记录
IResultSet<GridFSFile>	find(QueryBuilder query, OrderBy orderBy) 根据条件查询符合条件的文件记录
IResultSet<GridFSFile>	find(QueryBuilder query, OrderBy orderBy, Page page) 根据条件查询符合条件的文件记录
IResultSet<GridFSFile>	find(QueryBuilder query, Page page) 根据条件查询符合条件的文件记录
IResultSet<GridFSFile>	find(Query query, OrderBy orderBy) 根据条件查询符合条件的文件记录
IResultSet<GridFSFile>	find(Query query, OrderBy orderBy, Page page) 根据条件查询符合条件的文件记录
IResultSet<GridFSFile>	find(Query query, Page page) 根据条件查询符合条件的文件记录
GridFSFile	find(String id) 根据id查询文件记录
IResultSet<GridFSFile>	find(String filename, OrderBy orderBy) 查询指定名称的文件记录
IResultSet<GridFSFile>	find(String filename, OrderBy orderBy, Page page) 查询指定名称的文件记录
GridFSFile	findFirst(Query query) 根据条件查询符合条件的第一条记录
GridFSFile	findFirst(QueryBuilder query) 根据条件查询符合条件的第一条记录
String	getBucketName() 获取桶名称
GridFSBucket	getGridFsBucket() 获取GridFSBucket对象
GridFSFile	match(String fileHash) 判断指定fileHash值的文件是否存在
void	remove(Collection<String> ids) 批量删除指定id的文件记录
void	remove(String id) 删除指定id的文件记录
void	rename(String id, String newFileName) 文件重命名
String	upload(File file) 上传文件
String	upload(File file, GridFSUploadOptions fsUploadOption) 上传文件
String	upload(String id, File file) 上传文件
String	upload(String id, File file, GridFSUploadOptions fsUploadOption) 上传文件
String	upload(String fileName, InputStream inputStream) 上传文件
String	upload(String fileName, InputStream inputStream, GridFSUploadOptions fsUploadOption) 上传文件
String	upload(String id, String fileName, InputStream inputStream) 上传文件
String	upload(String id, String fileName, InputStream inputStream, GridFSUploadOptions fsUploadOption) 上传文件

Methods inherited from interface net.ymate.platform.core.persistence.ISession

getConnectionHolder, getId, getSessionEventListener, setSessionEventListener

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getGridFsBucket

GridFSBucket getGridFsBucket()

获取GridFSBucket对象

Returns:

返回GridFSBucket对象

getBucketName

String getBucketName()

获取桶名称

Returns:

返回桶名称

upload

String upload(File file,
              GridFSUploadOptions fsUploadOption)
       throws Exception

上传文件

Parameters:

file - 待上传的文件对象

fsUploadOption - 文件上传配置对象

Returns:

返回上传的文件唯一标识

Throws:

Exception - 可能产生的任何异常

upload

String upload(String id,
              File file,
              GridFSUploadOptions fsUploadOption)
       throws Exception

上传文件

Parameters:

id - 自定义文件唯一标识

file - 待上传的文件对象

fsUploadOption - 文件上传配置对象

Returns:

返回上传的文件唯一标识

Throws:

Exception - 可能产生的任何异常

upload

String upload(File file)
       throws Exception

上传文件

Parameters:

file - 待上传的文件对象

Returns:

返回上传的文件唯一标识

Throws:

Exception - 可能产生的任何异常

upload

String upload(String id,
              File file)
       throws Exception

上传文件

Parameters:

id - 自定义文件唯一标识

file - 待上传的文件对象

Returns:

返回上传的文件唯一标识

Throws:

Exception - 可能产生的任何异常

upload

String upload(String fileName,
              InputStream inputStream,
              GridFSUploadOptions fsUploadOption)
       throws Exception

上传文件

Parameters:

fileName - 文件名称

inputStream - 文件输入流对象

fsUploadOption - 文件上传配置对象

Returns:

返回上传的文件唯一标识

Throws:

Exception - 可能产生的任何异常

upload

String upload(String id,
              String fileName,
              InputStream inputStream,
              GridFSUploadOptions fsUploadOption)
       throws Exception

上传文件

Parameters:

id - 自定义文件唯一标识

fileName - 文件名称

inputStream - 文件输入流对象

fsUploadOption - 文件上传配置对象

Returns:

返回上传的文件唯一标识

Throws:

Exception - 可能产生的任何异常

upload

String upload(String fileName,
              InputStream inputStream)
       throws Exception

上传文件

Parameters:

fileName - 文件名称

inputStream - 文件输入流对象

Returns:

返回上传的文件唯一标识

Throws:

Exception - 可能产生的任何异常

upload

String upload(String id,
              String fileName,
              InputStream inputStream)
       throws Exception

上传文件

Parameters:

id - 自定义文件唯一标识

fileName - 文件名称

inputStream - 文件输入流对象

Returns:

返回上传的文件唯一标识

Throws:

Exception - 可能产生的任何异常

download

void download(String id,
              OutputStream distOutputStream)
       throws Exception

下载文件数据到指定的输出流

Parameters:

id - 文件唯一标识

distOutputStream - 目标输出流

Throws:

Exception - 可能产生的任何异常

download

void download(String id,
              File distFile)
       throws Exception

下载文件数据并写入指定的文件

Parameters:

id - 文件唯一标识

distFile - 目标文件

Throws:

Exception - 可能产生的任何异常

exists

boolean exists(String id)

判断指定id的文件是否存在

Parameters:

id - 文件唯一标识

Returns:

返回true表示存在

match

GridFSFile match(String fileHash)

判断指定fileHash值的文件是否存在

Parameters:

fileHash - 文件MD5值

Returns:

若存在则返回对应的文件记录对象，否则返回null

findFirst

GridFSFile findFirst(Query query)

根据条件查询符合条件的第一条记录

Parameters:

query - 查询条件对象

Returns:

返回文件记录对象

findFirst

GridFSFile findFirst(QueryBuilder query)

根据条件查询符合条件的第一条记录

Parameters:

query - 查询条件对象

Returns:

返回文件记录对象

find

GridFSFile find(String id)

根据id查询文件记录

Parameters:

id - 文件唯一标识

Returns:

返回文件记录对象

find

IResultSet<GridFSFile> find()

查询全部记录

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(OrderBy orderBy)

查询全部记录

Parameters:

orderBy - 排序对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(OrderBy orderBy,
                            Page page)

查询全部记录

Parameters:

orderBy - 排序对象

page - 分页对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(String filename,
                            OrderBy orderBy)

查询指定名称的文件记录

Parameters:

filename - 文件名称

orderBy - 排序对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(String filename,
                            OrderBy orderBy,
                            Page page)

查询指定名称的文件记录

Parameters:

filename - 文件名称

orderBy - 排序对象

page - 分页对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(Query query)

根据条件查询符合条件的文件记录

Parameters:

query - 条件对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(QueryBuilder query)

根据条件查询符合条件的文件记录

Parameters:

query - 条件对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(Query query,
                            OrderBy orderBy)

根据条件查询符合条件的文件记录

Parameters:

query - 条件对象

orderBy - 排序对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(QueryBuilder query,
                            OrderBy orderBy)

根据条件查询符合条件的文件记录

Parameters:

query - 条件对象

orderBy - 排序对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(Query query,
                            OrderBy orderBy,
                            Page page)

根据条件查询符合条件的文件记录

Parameters:

query - 条件对象

orderBy - 排序对象

page - 分页对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(QueryBuilder query,
                            OrderBy orderBy,
                            Page page)

根据条件查询符合条件的文件记录

Parameters:

query - 条件对象

orderBy - 排序对象

page - 分页对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(Query query,
                            Page page)

根据条件查询符合条件的文件记录

Parameters:

query - 条件对象

page - 分页对象

Returns:

返回查询结果集对象

find

IResultSet<GridFSFile> find(QueryBuilder query,
                            Page page)

根据条件查询符合条件的文件记录

Parameters:

query - 条件对象

page - 分页对象

Returns:

返回查询结果集对象

rename

void rename(String id,
            String newFileName)

文件重命名

Parameters:

id - 文件唯一标识

newFileName - 新文件名称

remove

void remove(String id)

删除指定id的文件记录

Parameters:

id - 文件唯一标识

remove

void remove(Collection<String> ids)

批量删除指定id的文件记录

Parameters:

ids - 文件唯一标识集合