AbstractSimpleFileStore (鏂囦欢瀛樺偍浠撳簱 1.0 API)

java.lang.Object
- com.kdgcsoft.power.filestore.AbstractFileStore
- - com.kdgcsoft.power.filestore.AbstractSimpleFileStore

所有已实现的接口:

FileStore

直接已知子类:

TimeStampSimpleFileStore, UUIDSimpleFileStore
```
public abstract class AbstractSimpleFileStore
extends AbstractFileStore
implements FileStore
```
基于本地磁盘目录方式实现的文件存储库抽象类。子类只需实现文件ID和目录结构生成方式。

作者:

hling

字段概要
- 从类继承的字段 com.kdgcsoft.power.filestore.AbstractFileStore
  DEFAULT_STORE_NAME

构造器概要

构造器
构造器和说明

AbstractSimpleFileStore(File rootPath)

AbstractSimpleFileStore(String strRootPath)

构造器
构造器和说明
`AbstractSimpleFileStore(File rootPath)`
`AbstractSimpleFileStore(String strRootPath)`

方法概要

方法
限定符和类型	方法和说明
`boolean`	`deleteFile(String key)` 删除指定key的文件
`boolean`	`exist(String key)` 判断文件是否存在
`FileInfo`	`getFile(String key)` 从内容仓库获取文件。
`InputStream`	`getFileAsStream(String key)` 从内容仓库获取文件流。
`long`	`getFileSize(String key)` 获取文件大小
`FileInfo`	`putFile(File file, String fileName, String relativePath)` 向内容仓库中的逻辑相对路径下存储一个文件，并返回将来可用于操作文件的Key 对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在相应的逻辑节点下。
`FileInfo`	`putFileAsStream(InputStream inputStream, String fileName, String relativePath)` 向内容仓库中的逻辑相对路径下存储一个文件流，并返回将来可用于操作文件的Key 对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在相应的逻辑节点下。
`List<String>`	`searchFullText(String keyword)` 全文检索检索出所有匹配关键字的文件Key。
`Map<String,String>`	`searchFullTextWithExcerpt(String keyword)` 全文检索并显示摘要。
`void`	`setLoginAccount(String user, String password)` SimpleFileStore不支持此方法，调用无效。
`boolean`	`supportFullTextSearch()`

从类继承的方法 com.kdgcsoft.power.filestore.AbstractFileStore
checkName, putFile, putFile, putFileAsStream, putFileAsStream

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- 构造器详细资料
  - AbstractSimpleFileStore
```
public AbstractSimpleFileStore(File rootPath)
```
  - AbstractSimpleFileStore
```
public AbstractSimpleFileStore(String strRootPath)
```
- 方法详细资料
  - 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,
               String relativePath)
                 throws FileStoreException
```
    从接口复制的说明: FileStore
    
    向内容仓库中的逻辑相对路径下存储一个文件，并返回将来可用于操作文件的Key
    对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在相应的逻辑节点下。此时通常不能往一个路径下放置太多（几万以上）文件，而应该用文件夹分开存放，否则影响性能。
    对不支持文件逻辑路径的内容仓库实现，例如SimpleFileStore会忽略第三个参数而使用内部算法生成相对路径，应用程序无需关心，通常也不存在同一节点下存储过多文件而影响性能的问题。
    
    指定者:
    
    putFile 在接口中 FileStore
    
    参数:
    file - 文件对象
    fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。
    relativePath - 存储相对路径。如果为null或""视为文件要放在根目录下。如果为"a/b/c"则视为放在"根目录/a/b/c"目录下，以此类推。目录如果不存在，会自动创建。
    不一定所有的仓库实现都支持存储相对路径，也不是必要的。对仓库实现来说，Key是操作文件的唯一必要条件。
    有的存储实现例如SimpleFileStore会基于内部算法实现存储目录结构，因而会忽略该参数。
    
    返回:
    文件在内容仓库中的key。通常为UUID，但根据内容仓库的具体实现也可以是别的。调用者不必关心其内容，只要存储即可。
    
    抛出:
    
    FileStoreException - 存储文件失败时抛出异常
  - putFileAsStream
```
public FileInfo putFileAsStream(InputStream inputStream,
                       String fileName,
                       String relativePath)
                         throws FileStoreException
```
    从接口复制的说明: FileStore
    
    向内容仓库中的逻辑相对路径下存储一个文件流，并返回将来可用于操作文件的Key
    对支持文件逻辑路径的内容仓库实现来说，例如JackRabbitFileStore，文件将被存储在相应的逻辑节点下。此时通常不能往一个路径下放置太多（几万以上）文件，而应该用文件夹分开存放，否则影响性能。
    对不支持文件逻辑路径的内容仓库实现，例如SimpleFileStore会忽略第三个参数而使用内部算法生成相对路径，应用程序无需关心，通常也不存在同一节点下存储过多文件而影响性能的问题。
    
    指定者:
    
    putFileAsStream 在接口中 FileStore
    
    参数:
    inputStream - 文件流对象
    fileName - 内容仓库中使用的文件名。如果为null或空，则使用file参数所含的文件名。
    relativePath - 存储的相对路径，目前仅JackRabbit仓库支持。如果为null或""视为文件要放在根目录下。如果为"a/b/c"则视为放在"根目录/a/b/c"目录下，以此类推。目录如果不存在，会自动创建。
    指定相对路径仅仅是目前为了优化JackRabbit仓库的内部存储结构（未来可能会删除该参数），如果应用系统需要记录相对路径，请自行记录该信息而不要依靠仓库实现。对仓库实现来说，Key是操作文件的唯一必要条件。
    基于本地文件的存储实现例如SimpleFileStore会基于内部算法实现优化的存储目录结构，因而会忽略该参数。
    
    返回:
    文件在内容仓库中的key。通常为UUID，但根据内容仓库的具体实现也可以是别的。调用者不必关心其内容，只要存储即可。
    
    抛出:
    
    FileStoreException - 存储文件失败时抛出异常
  - getFile
```
public FileInfo getFile(String key)
                 throws FileStoreException
```
    从接口复制的说明: FileStore
    
    从内容仓库获取文件。
    
    指定者:
    
    getFile 在接口中 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

类 AbstractSimpleFileStore

字段概要

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

构造器概要

方法概要

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

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

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

构造器详细资料

AbstractSimpleFileStore

AbstractSimpleFileStore

方法详细资料

supportFullTextSearch

setLoginAccount

putFile

putFileAsStream

getFile

getFileAsStream

getFileSize

exist

deleteFile

searchFullText

searchFullTextWithExcerpt