com.fr.base.frpx.pack

类 AbstractFRPackage

java.lang.Object

com.fr.base.frpx.pack.AbstractFRPackage

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable

直接已知子类:

ZipPackage

public abstract class AbstractFRPackage
extends java.lang.Object
implements java.io.Closeable

可以储存多种数据对象的容器包模型

作者:

vito

字段概要

字段

限定符和类型	字段和说明
protected boolean	modified
protected java.lang.String	originalPackagePath 包路径，可能为空
protected java.io.OutputStream	output 包将要写出的输出流
protected PackageAccess	packageAccess
protected java.util.Map<java.lang.String,AbstractPackagePart>	partMap 块容器
protected PartSummaryManager	partSummaryManager 摘要管理类

方法概要

方法

限定符和类型	方法和说明
void	addSummary(PartSummary partSummary) 添加一个摘要
AbstractFRPackage	clone()
void	close()
static AbstractFRPackage	create(java.io.File file) 使用指定文件创建一个包
static AbstractFRPackage	create(java.io.OutputStream output) 使用指定输出流创建一个包
AbstractPackagePart	createPart(PartSummary summary) 创建一个块，并添加到摘要中
AbstractPackagePart	createPart(PartSummary summary, boolean needRegister) 创建一个块，如果needRegister为true， 则注册到package中
protected abstract AbstractPackagePart	createPartImpl(PartSummary partSummary) 创建一个package part，用于子类实现
java.util.Map<java.lang.String,AbstractPackagePart>	getParts() 解析part
java.util.List<AbstractPackagePart>	getPartsByName(java.util.regex.Pattern namePattern) 根据名称正则取回模块
AbstractPackagePart	getPartsByName(java.lang.String partName) 根据名称取回模块
protected abstract java.util.Map<java.lang.String,AbstractPackagePart>	getPartsImpl() 获取包中所有的parts。
static AbstractFRPackage	open(java.io.File file, PackageAccess access) 打开一个包
static AbstractFRPackage	open(java.io.InputStream in) 打开一个包。
static AbstractFRPackage	open(java.lang.String path) 使用读写访问级别打开一个文件
static AbstractFRPackage	open(java.lang.String path, PackageAccess access) 打开一个包
static AbstractFRPackage	openOrCreate(java.io.File file) 文件存在就打开，不存在则创建
void	register(AbstractPackagePart part) 注册包块到包中
void	registerClone(AbstractPackagePart part) 注册clone包块到包中。
void	registerPart(AbstractPackagePart packagePart) 手动注册模块到package中。
void	releaseParts() 释放partmap
void	removePart(AbstractPackagePart packagePart) 移除模块
void	removeSummary(PartSummary partSummary) 移除一个摘要
void	revert() 关闭但是不保存更改。
protected abstract void	revertImpl() 关闭时不保存，丢弃所有改动 todo：[cptx]发现保存错误的时候会变成0KB,希望做个回滚,但是只能基于文件不能基于流
void	save(java.io.File targetFile) 保存文档到指定文件
void	save(java.io.OutputStream outputStream) 保存文档到指定输出流
protected abstract void	saveImpl(java.io.OutputStream outputStream) 保存文档到指定流中

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

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

字段详细资料

packageAccess

protected PackageAccess packageAccess

partMap

protected java.util.Map<java.lang.String,AbstractPackagePart> partMap

块容器

originalPackagePath

protected java.lang.String originalPackagePath

包路径，可能为空

output

protected java.io.OutputStream output

包将要写出的输出流

partSummaryManager

protected PartSummaryManager partSummaryManager

摘要管理类

modified

protected boolean modified

方法详细资料

open

public static AbstractFRPackage open(java.lang.String path)
                              throws InvalidFormatException

使用读写访问级别打开一个文件

参数:

path - 包的路径

返回:

包对象，可能为空

抛出:

InvalidFormatException - If the specified file doesn't exist, and a parsing error occur.

open

public static AbstractFRPackage open(java.lang.String path,
                     PackageAccess access)
                              throws InvalidFormatException,
                                     InvalidOperationException

打开一个包

参数:

path - 包路径

access - 包访问级别

返回:

包对象，可能为null

抛出:

InvalidFormatException - 指定文件不存在，或格式无法解析

InvalidOperationException - 该zip文件存在问题

open

public static AbstractFRPackage open(java.io.File file,
                     PackageAccess access)
                              throws InvalidFormatException

打开一个包

参数:

file - 包文件

access - 包访问级别

返回:

包对象，可能为null

抛出:

InvalidFormatException - 指定文件不存在，或格式无法解析

open

public static AbstractFRPackage open(java.io.InputStream in)
                              throws InvalidFormatException,
                                     java.io.IOException

打开一个包。通过流打开的包，会使用比open(String)多一些的内存， 因为需要在内存中暂时持有整个zip包。注意读完内存及时释放。

参数:

in - 输入流

返回:

包对象，可能为null

抛出:

InvalidFormatException - 指定文件不存在，或格式无法解析

java.io.IOException

create

public static AbstractFRPackage create(java.io.OutputStream output)

使用指定输出流创建一个包

参数:

output - 输出流

返回:

包对象

create

public static AbstractFRPackage create(java.io.File file)

使用指定文件创建一个包

参数:

file - 文件

返回:

包对象

openOrCreate

public static AbstractFRPackage openOrCreate(java.io.File file)
                                      throws InvalidFormatException

文件存在就打开，不存在则创建

参数:

file - 待操作的文件

返回:

新建或者打开的包

抛出:

InvalidFormatException - 无法打开或者创建

createPart

public AbstractPackagePart createPart(PartSummary summary)

创建一个块，并添加到摘要中

参数:

summary - 摘要

返回:

包块

createPart

public AbstractPackagePart createPart(PartSummary summary,
                             boolean needRegister)

创建一个块，如果needRegister为true， 则注册到package中

参数:

summary - 摘要

needRegister - 是否需要注册

返回:

包块

register

public void register(AbstractPackagePart part)

注册包块到包中

参数:

part - 包块

registerClone

public void registerClone(AbstractPackagePart part)

注册clone包块到包中。

参数:

part - 包块

removeSummary

public void removeSummary(PartSummary partSummary)

移除一个摘要

参数:

partSummary - 摘要

addSummary

public void addSummary(PartSummary partSummary)

添加一个摘要

参数:

partSummary - 摘要

registerPart

public void registerPart(AbstractPackagePart packagePart)

手动注册模块到package中。

参数:

packagePart - 待注册的模块

removePart

public void removePart(AbstractPackagePart packagePart)

移除模块

参数:

packagePart - 待移除的模块

getPartsByName

public java.util.List<AbstractPackagePart> getPartsByName(java.util.regex.Pattern namePattern)

根据名称正则取回模块

参数:

namePattern - 名称正则

返回:

满足正则名称的模块

getPartsByName

public AbstractPackagePart getPartsByName(java.lang.String partName)

根据名称取回模块

参数:

partName - 名称

返回:

名称对应的模块

getParts

public java.util.Map<java.lang.String,AbstractPackagePart> getParts()
                                                             throws InvalidFormatException

解析part

返回:

包含所有的parts的map

抛出:

InvalidFormatException - 无效格式异常

InvalidWorkBookException - 模板不完整时抛出异常

releaseParts

public void releaseParts()

释放partmap

close

public void close()
           throws java.io.IOException

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

抛出:

java.io.IOException

revert

public void revert()

关闭但是不保存更改。

save

public void save(java.io.File targetFile)
          throws java.io.IOException

保存文档到指定文件

参数:

targetFile - 指定文件

抛出:

java.io.IOException - 保存失败

另请参阅:

save(OutputStream)

save

public void save(java.io.OutputStream outputStream)
          throws java.io.IOException

保存文档到指定输出流

参数:

outputStream - 要保存文档的输出流

抛出:

java.io.IOException

另请参阅:

saveImpl(OutputStream)

clone

public AbstractFRPackage clone()

覆盖:

clone 在类中 java.lang.Object

createPartImpl

protected abstract AbstractPackagePart createPartImpl(PartSummary partSummary)

创建一个package part，用于子类实现

参数:

partSummary - 摘要

返回:

新建的package part

revertImpl

protected abstract void revertImpl()

关闭时不保存，丢弃所有改动 todo：[cptx]发现保存错误的时候会变成0KB,希望做个回滚,但是只能基于文件不能基于流

saveImpl

protected abstract void saveImpl(java.io.OutputStream outputStream)
                          throws java.io.IOException

保存文档到指定流中

参数:

outputStream - 保存文档的输出流

抛出:

java.io.IOException

getPartsImpl

protected abstract java.util.Map<java.lang.String,AbstractPackagePart> getPartsImpl()
                                                                             throws InvalidFormatException

获取包中所有的parts。当为zip文件的时候，part为ZipEntry， 当为内存文件的时候，part中缓存所有内容

返回:

包含所有parts的map

抛出:

InvalidFormatException - 无效格式异常