com.kdgcsoft.power.filestore

类 SimpleFileStore

java.lang.Object

com.kdgcsoft.power.filestore.AbstractFileStore

com.kdgcsoft.power.filestore.SimpleFileStore

所有已实现的接口:

FileStore

直接已知子类:

TimeStampSimpleFileStore, UUIDSimpleFileStore

public class SimpleFileStore
extends AbstractFileStore
implements FileStore

基于本地磁盘目录方式实现的文件存储库基类，构造时需指定路径策略对象。

作者:

hling

字段概要

从类继承的字段 com.kdgcsoft.power.filestore.AbstractFileStore

DEFAULT_STORE_NAME

构造器概要

构造器

构造器和说明
SimpleFileStore(File rootPath, IKeyStrategy keyStrategy)
SimpleFileStore(String strRootPath, IKeyStrategy keyStrategy)

方法概要

限定符和类型	方法和说明
boolean	deleteFile(String key) 删除指定key的文件
boolean	exist(String key) 判断文件是否存在
InputStream	getFileAsStream(String key) 从内容仓库获取文件流。
FileInfo	getFileInfo(String key) 从内容仓库获取文件信息，不包含文件流InputStream，即返回的FileInfo对象中inputStream属性为null。
long	getFileSize(String key) 获取文件大小
FileInfo	putFile(File file, String fileName) 向内容仓库存储一个文件，并返回将来可用于操作文件的FileInfo，包含将来用于操作文件的Key。
FileInfo	putFileAsStream(InputStream inputStream, String fileName) 向内容仓库存储一个文件流，并返回包含文件Key的文件信息对象FileInfo（但其内部的InputStream为null）。
List<String>	searchFullText(String keyword) 全文检索 检索出所有匹配关键字的文件Key。
Map<String,String>	searchFullTextWithExcerpt(String keyword) 全文检索并显示摘要。
void	setLoginAccount(String user, String password) SimpleFileStore不支持此方法，调用无效。
void	shutdown() 在不使用文件仓库或应用程序退出时，请调用shutdown()方法，以便某些仓库实现类进行清理退出工作。
boolean	supportFullTextSearch()

从类继承的方法 com.kdgcsoft.power.filestore.AbstractFileStore

checkName, putFile, putFileAsStream

从类继承的方法 java.lang.Object

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

从接口继承的方法 com.kdgcsoft.power.filestore.FileStore

putFile, putFileAsStream

构造器详细资料

SimpleFileStore

public SimpleFileStore(File rootPath,
                       IKeyStrategy keyStrategy)

SimpleFileStore

public SimpleFileStore(String strRootPath,
                       IKeyStrategy keyStrategy)

方法详细资料

supportFullTextSearch

public boolean supportFullTextSearch()

指定者:

supportFullTextSearch 在接口中 FileStore

setLoginAccount

public void setLoginAccount(String user,
                            String password)

SimpleFileStore不支持此方法，调用无效。

指定者:

setLoginAccount 在接口中 FileStore

参数:

user - 用户名

password - 密码

putFile

public FileInfo putFile(File file,
                        String fileName)
                 throws FileStoreException

从接口复制的说明: FileStore

向内容仓库存储一个文件，并返回将来可用于操作文件的FileInfo，包含将来用于操作文件的Key。

注意：本方法返回的FileInfo对象中inputStream为null。

指定者:

putFile 在接口中 FileStore

参数:

file - 文件对象

fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。

返回:

文件在内容仓库中的FileInfo 文件信息对象。注意：本方法返回的FileInfo对象中inputStream为null。

抛出:

FileStoreException - 存储文件失败时抛出异常

putFileAsStream

public FileInfo putFileAsStream(InputStream inputStream,
                                String fileName)
                         throws FileStoreException

从接口复制的说明: FileStore

向内容仓库存储一个文件流，并返回包含文件Key的文件信息对象FileInfo（但其内部的InputStream为null）。

指定者:

putFileAsStream 在接口中 FileStore

参数:

inputStream - 文件流对象

fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。

返回:

文件在内容仓库中的FileInfo 文件信息对象。注意：本方法返回的FileInfo对象中inputStream为null。

抛出:

FileStoreException - 存储文件失败时抛出异常

getFileInfo

public FileInfo getFileInfo(String key)
                     throws FileStoreException

从接口复制的说明: FileStore

从内容仓库获取文件信息，不包含文件流InputStream，即返回的FileInfo对象中inputStream属性为null。

指定者:

getFileInfo 在接口中 FileStore

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

文件对象，包含文件key、文件尺寸信息。如果没找到，返回null。

抛出:

FileStoreException - 存储库异常

getFileAsStream

public InputStream getFileAsStream(String key)
                            throws FileStoreException

从接口复制的说明: FileStore

从内容仓库获取文件流。

指定者:

getFileAsStream 在接口中 FileStore

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

文件流对象。如果没找到或未设置，返回null。

抛出:

FileStoreException - 存储库异常

getFileSize

public long getFileSize(String key)
                 throws FileStoreException

从接口复制的说明: FileStore

获取文件大小

指定者:

getFileSize 在接口中 FileStore

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

文件字节数。如果文件不存在，返回-1。

抛出:

FileStoreException - 存储库异常

exist

public boolean exist(String key)
              throws FileStoreException

从接口复制的说明: FileStore

判断文件是否存在

指定者:

exist 在接口中 FileStore

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

true/false

抛出:

FileStoreException - 存储库异常

deleteFile

public boolean deleteFile(String key)
                   throws FileStoreException

从接口复制的说明: FileStore

删除指定key的文件

指定者:

deleteFile 在接口中 FileStore

参数:

key - 在往内容仓库存放文件时获得的文件key。

返回:

true表示删除成功，false表示文件不存在

抛出:

FileStoreException - 存储库异常

searchFullText

public List<String> searchFullText(String keyword)
                            throws FileStoreException

从接口复制的说明: FileStore

全文检索 检索出所有匹配关键字的文件Key。 注意：FileStore并不一定支持全文检索。如果不支持，应抛出FileStoreException异常。

指定者:

searchFullText 在接口中 FileStore

参数:

keyword - 需要检索的关键字

返回:

List 与关键字匹配的文件文件Key列表

抛出:

FileStoreException - 不支持全文检索或其他异常

searchFullTextWithExcerpt

public Map<String,String> searchFullTextWithExcerpt(String keyword)
                                             throws FileStoreException

从接口复制的说明: FileStore

全文检索并显示摘要。检索出所有匹配关键字的文件Key和摘要，并存到Map中，其中key为文件key，value为摘要。

指定者:

searchFullTextWithExcerpt 在接口中 FileStore

参数:

keyword - 需要检索的关键字

返回:

Map

抛出:

FileStoreException - 不支持全文检索或其他异常

shutdown

public void shutdown()

从接口复制的说明: FileStore

在不使用文件仓库或应用程序退出时，请调用shutdown()方法，以便某些仓库实现类进行清理退出工作。

指定者:

shutdown 在接口中 FileStore