nablarch.core.util

Class FilePathSetting

java.lang.Object

nablarch.core.util.FilePathSetting

@Published(tag="architect")
public class FilePathSetting
extends java.lang.Object

ベースパスの論理名と物理パスとの対応を管理するクラス。

Author:

Iwauo Tajima

Method Summary

Modifier and Type	Method and Description
FilePathSetting	addBasePathSetting(java.lang.String basePathName, java.lang.String path) ベースパスの設定を追加する。 ベースパスにはディレクトリのみ指定できる。ディレクトリでない場合、例外をスローする。 ベースパスはURLで指定すること。URLを使用して、ファイルシステムとクラスパス上のリソースを指定することができる。 URLのフォーマットは下記の通りである。
FilePathSetting	addFileExtensions(java.lang.String name, java.lang.String extension) ベースパスの論理名に対応する拡張子を追加する。
java.io.File	getBaseDirectory(java.lang.String basePathName) ベースディレクトリを取得する。
java.util.Map	getBasePathSettings() ベースパスの論理名と物理パスとの対応を収めたMapを取得する。
java.net.URL	getBasePathUrl(java.lang.String basePathName) ベースパスのURLを取得する。
java.io.File	getFile(java.lang.String basePathName, java.lang.String fileName) 指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 ファイルが存在しない場合は新たにファイルを作成してその抽象パスを返却する。
java.util.Map	getFileExtensions() ベースパスの論理名と拡張子との対応を収めたMapを取得する。
java.io.File	getFileIfExists(java.lang.String basePathName, java.lang.String fileName) 指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 その抽象パスを返却する。ファイルが存在しない場合はnullを返却する。
protected java.lang.String	getFileNameJoinExtension(java.lang.String basePathName, java.lang.String fileName) ベースパスの論理名に対応する拡張子が存在する場合、ファイル名と拡張子を結合した文字列を返却する。 対応する拡張子が存在しない場合は、引数のファイル名をそのまま返却する。
java.io.File	getFileWithoutCreate(java.lang.String basePathName, java.lang.String fileName) 指定されたベースパスの直下に存在するファイルの抽象パスを取得する。
static FilePathSetting	getInstance() このクラスのインスタンスをリポジトリより取得する。 リポジトリにインスタンスが存在しない場合は、デフォルトの設定で生成したこのクラスのインスタンスを返却する。
protected java.io.File	resolvePath(java.lang.String basePathName, java.lang.String fileName, boolean createNew) 指定されたベースパスの直下に存在するファイルの抽象パスを作成して返却する。
FilePathSetting	setBasePathSettings(java.util.Map basePathSettings) ベースパスの論理名と物理パスとの対応を収めたMapを設定する。
void	setFileExtensions(java.util.Map fileExtensions) ベースパスの論理名と拡張子との対応を収めたMapを設定する。

Method Detail

getInstance

public static FilePathSetting getInstance()

このクラスのインスタンスをリポジトリより取得する。 リポジトリにインスタンスが存在しない場合は、デフォルトの設定で生成したこのクラスのインスタンスを返却する。

Returns:

このクラスのインスタンス

getFile

public java.io.File getFile(java.lang.String basePathName,
                            java.lang.String fileName)

指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 ファイルが存在しない場合は新たにファイルを作成してその抽象パスを返却する。

Parameters:

basePathName - ベースパスの論理名

fileName - 取得するファイル名

Returns:

抽象パス

Throws:

java.lang.IllegalArgumentException - 指定されたベースパス論理名に対応する物理パスが 設定されていない場合

getFileIfExists

public java.io.File getFileIfExists(java.lang.String basePathName,
                                    java.lang.String fileName)

指定されたベースパスの直下に存在するファイルの抽象パスを取得する。 その抽象パスを返却する。ファイルが存在しない場合はnullを返却する。

Parameters:

basePathName - ベースパスの論理名

fileName - 取得するファイル名

Returns:

抽象パス

Throws:

java.lang.IllegalArgumentException - 指定されたベースパス論理名に対応する物理パスが 設定されていない場合

getFileWithoutCreate

public java.io.File getFileWithoutCreate(java.lang.String basePathName,
                                         java.lang.String fileName)

指定されたベースパスの直下に存在するファイルの抽象パスを取得する。

Parameters:

basePathName - ベースパスの論理名

fileName - 取得するファイル名

Returns:

抽象パス

Throws:

java.lang.IllegalArgumentException - 指定されたベースパス論理名に対応する物理パスが 設定されていない場合

resolvePath

protected java.io.File resolvePath(java.lang.String basePathName,
                                   java.lang.String fileName,
                                   boolean createNew)

指定されたベースパスの直下に存在するファイルの抽象パスを作成して返却する。

Parameters:

basePathName - ベースパスの論理名

fileName - 取得するファイル名

createNew - 指定したファイルが存在しない場合に新規ファイルを 作成するかどうか。（作成する場合はtrue）

Returns:

抽象パス

Throws:

java.lang.IllegalArgumentException - 指定されたベースパス論理名に対応する物理パスが 設定されていない場合

getBasePathUrl

public java.net.URL getBasePathUrl(java.lang.String basePathName)

ベースパスのURLを取得する。

Parameters:

basePathName - ベースパスの論理名

Returns:

URL

getBaseDirectory

public java.io.File getBaseDirectory(java.lang.String basePathName)

ベースディレクトリを取得する。

Parameters:

basePathName - ベースパスの論理名

Returns:

ベースディレクトリ

getFileNameJoinExtension

protected java.lang.String getFileNameJoinExtension(java.lang.String basePathName,
                                                    java.lang.String fileName)

ベースパスの論理名に対応する拡張子が存在する場合、ファイル名と拡張子を結合した文字列を返却する。 対応する拡張子が存在しない場合は、引数のファイル名をそのまま返却する。

Parameters:

basePathName - ベースパスの論理名

fileName - ファイル名

Returns:

ファイル名と拡張子を結合した文字列

setBasePathSettings

public FilePathSetting setBasePathSettings(java.util.Map basePathSettings)

ベースパスの論理名と物理パスとの対応を収めたMapを設定する。

Parameters:

basePathSettings - ベースパスの論理名と物理パス（URLで指定）との対応を収めたMap

Returns:

このクラス自体のインスタンス

addBasePathSetting

public FilePathSetting addBasePathSetting(java.lang.String basePathName,
                                          java.lang.String path)

ベースパスの設定を追加する。

ベースパスにはディレクトリのみ指定できる。ディレクトリでない場合、例外をスローする。

ベースパスはURLで指定すること。URLを使用して、ファイルシステムとクラスパス上のリソースを指定することができる。
URLのフォーマットは下記の通りである。

     <スキーム名>:<リソースのパス>

     スキーム名:
         ファイルパスの場合 "file"
         クラスパスの場合 "classpath"
 

URLの指定例を下記に示す。

     ファイルパスの場合
         "file:./main/format"

     クラスパスの場合
         "classpath:web/format"
 

ベースパスにクラスパスを指定する場合、そのパスにはディレクトリが存在している必要がある。ディレクトリが存在しない場合は、例外をスローする。

ベースパスにファイルパスを指定する場合、そのパスにディレクトリが存在していなければ、本メソッド内でディレクトリを作成する。

Parameters:

basePathName - ベースパスの論理名

path - ベースパス（URLで指定）

Returns:

このクラス自体のインスタンス

addFileExtensions

public FilePathSetting addFileExtensions(java.lang.String name,
                                         java.lang.String extension)

ベースパスの論理名に対応する拡張子を追加する。

Parameters:

name - ベースパスの論理名

extension - ベースパスの論理名に対応する拡張子

Returns:

このクラス自体のインスタンス

getBasePathSettings

public java.util.Map getBasePathSettings()

ベースパスの論理名と物理パスとの対応を収めたMapを取得する。

Returns:

ベースパスの論理名と物理パスとの対応を収めたMap

getFileExtensions

public java.util.Map getFileExtensions()

ベースパスの論理名と拡張子との対応を収めたMapを取得する。

Returns:

ベースパスの論理名とデフォルト拡張子との対応を収めたMap

setFileExtensions

public void setFileExtensions(java.util.Map fileExtensions)

ベースパスの論理名と拡張子との対応を収めたMapを設定する。

Parameters:

fileExtensions - ベースパスの論理名とデフォルト拡張子との対応を収めたMap