org.ofdrw.reader

类 ResourceLocator

java.lang.Object

org.ofdrw.reader.ResourceLocator

public class ResourceLocator
extends Object

资源定位器

通过给与的资源地址获取对应的资源文件或对象

从以下版本开始:

2020-04-08 20:05:14

作者:

权观宇

字段概要

字段

限定符和类型	字段和说明
static Pattern	PtDoc 路径匹配正则列表
static Pattern	PtDocRes
static Pattern	PtPage
static Pattern	PtPageRes
static Pattern	PtPages
static Pattern	PtSign
static Pattern	PtSigns

构造器概要

构造器

构造器和说明
ResourceLocator(OFDDir ofdDir)
ResourceLocator(VirtualContainer vc) 通过虚拟容器创建资源加载器 创建资源加载器的同时切换路径至虚拟容器的目录

方法概要

限定符和类型	方法和说明
ResourceLocator	cd(LinkedList<String> workDir, String path) 改变目录 Change Directory 路径最后如果是目录也不加 "/"
ResourceLocator	cd(String path) 改变目录 Change Directory
ResourceLocator	cd(VirtualContainer vc) 切换到制定的虚拟容器目录下
boolean	dirExit(LinkedList<String> workDir) 判断路径是否存在
boolean	exist(LinkedList<String> workDir) 判断路径是否存在
boolean	exist(String path) 路径是否存在
<R> R	get(ST_Loc loc, Function<org.dom4j.Element,R> mapper) 根据路径获取获取对应的资源对象
<R> R	get(String loc, Function<org.dom4j.Element,R> mapper) 根据路径获取获取对应的资源对象
ST_Loc	getAbsTo(ST_Loc to) 获取以当前路径为基础的容器内绝对路径
VirtualContainer	getContainer(LinkedList<String> workDir) 通过路径获取容器
VirtualContainer	getContainer(String containerPath) 根据路径获取虚拟容器对象 获取的同时会缓存整个容器链路
Path	getFile(ST_Loc stLoc) 获取路径下的文件
Path	getFile(String loc) 获取路径下的文件
String	pwd() 打印工作目录 Print Work Directory 路径最后如果是目录也不加 "/"
String	pwd(List<String> workDir) 打印工作目录 Print Work Directory
ResourceLocator	restore() 还原原有工作区 如果没有保存过工作区，那么不会造成任何影响
ResourceLocator	restWd() 重置工作路径 重置后将回到根路径
ResourceLocator	save() 保存当前工作路径
String	toAbsolutePath(ST_Loc path) 转换路径对象为绝对路径字符串
String	toAbsolutePath(String path) 路径转换为绝对路径
String	toString()

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

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

字段详细资料

PtDoc

public static Pattern PtDoc

路径匹配正则列表

PtSigns

public static Pattern PtSigns

PtSign

public static Pattern PtSign

PtPages

public static Pattern PtPages

PtPage

public static Pattern PtPage

PtPageRes

public static Pattern PtPageRes

PtDocRes

public static Pattern PtDocRes

构造器详细资料

ResourceLocator

public ResourceLocator(OFDDir ofdDir)

ResourceLocator

public ResourceLocator(VirtualContainer vc)

通过虚拟容器创建资源加载器 创建资源加载器的同时切换路径至虚拟容器的目录

参数:

vc - 虚拟容器

方法详细资料

save

public ResourceLocator save()

保存当前工作路径

返回:

this

restore

public ResourceLocator restore()

还原原有工作区

如果没有保存过工作区，那么不会造成任何影响

返回:

this

toAbsolutePath

public String toAbsolutePath(ST_Loc path)

转换路径对象为绝对路径字符串

参数:

path - 路径对象

返回:

绝对路径字符串

toAbsolutePath

public String toAbsolutePath(String path)

路径转换为绝对路径

参数:

path - 容器路径

返回:

绝对路径字符串

restWd

public ResourceLocator restWd()

重置工作路径

重置后将回到根路径

返回:

this

cd

public ResourceLocator cd(VirtualContainer vc)

切换到制定的虚拟容器目录下

参数:

vc - 虚拟容器

返回:

this

cd

public ResourceLocator cd(String path)

改变目录 Change Directory

参数:

path - 路径位置

返回:

this

抛出:

ErrorPathException - 路径不存在

cd

public ResourceLocator cd(LinkedList<String> workDir,
                          String path)

改变目录 Change Directory

路径最后如果是目录也不加 "/"

参数:

path - 路径位置

workDir - 已有工作目录

返回:

this

抛出:

ErrorPathException - 路径不存在

exist

public boolean exist(String path)

路径是否存在

参数:

path - 末端路径

返回:

true -存在，false - 不存在

exist

public boolean exist(LinkedList<String> workDir)

判断路径是否存在

参数:

workDir - 路径集合

返回:

true -存在，false - 不存在

dirExit

public boolean dirExit(LinkedList<String> workDir)

判断路径是否存在

参数:

workDir - 工作路径

返回:

true -存在，false - 不存在

pwd

public String pwd()

打印工作目录 Print Work Directory

路径最后如果是目录也不加 "/"

返回:

工作目录路径

pwd

public String pwd(List<String> workDir)

打印工作目录 Print Work Directory

参数:

workDir - 工作目录

返回:

工作目录路径

getAbsTo

public ST_Loc getAbsTo(ST_Loc to)

获取以当前路径为基础的容器内绝对路径

参数:

to - 目标路径

返回:

容器内绝对路径

get

public <R> R get(ST_Loc loc,
                 Function<org.dom4j.Element,R> mapper)
          throws FileNotFoundException,
                 org.dom4j.DocumentException

根据路径获取获取对应的资源对象

类型参数:

R - 映射对象

参数:

loc - 路径地址

mapper - 对象映射构造器

返回:

对象

抛出:

FileNotFoundException - 文件不存在

org.dom4j.DocumentException - 文件解析异常

get

public <R> R get(String loc,
                 Function<org.dom4j.Element,R> mapper)
          throws FileNotFoundException,
                 org.dom4j.DocumentException

根据路径获取获取对应的资源对象

类型参数:

R - 映射对象

参数:

loc - 路径地址

mapper - 对象映射构造器

返回:

对象

抛出:

FileNotFoundException - 文件不存在

org.dom4j.DocumentException - 文件解析异常

getFile

public Path getFile(ST_Loc stLoc)
             throws FileNotFoundException

获取路径下的文件

参数:

stLoc - 路径

返回:

系统文件路径

抛出:

FileNotFoundException - 文件或路径不存在

getFile

public Path getFile(String loc)
             throws FileNotFoundException

获取路径下的文件

参数:

loc - 路径

返回:

系统文件路径

抛出:

FileNotFoundException - 文件或路径不存在

getContainer

public VirtualContainer getContainer(LinkedList<String> workDir)
                              throws FileNotFoundException

通过路径获取容器

参数:

workDir - 路径序列

返回:

虚拟容器

抛出:

FileNotFoundException - 路径不存在

getContainer

public VirtualContainer getContainer(String containerPath)
                              throws FileNotFoundException

根据路径获取虚拟容器对象

获取的同时会缓存整个容器链路

参数:

containerPath - 容器目录

返回:

虚拟容器

抛出:

FileNotFoundException - 路径不存在

toString

public String toString()

覆盖:

toString 在类中 Object