org.opengion.fukurou.xml.JspIncludeReader

public class JspIncludeReader extends Object

このクラスは、jspファイルのXSLT変換に特化した、Readerオブジェクトを作成するクラスです。 jspファイルに記述される、jsp:directive.include を見つけて、そのファイル属性に記述されているファイルを、インクルードします。 Tomcat の特性上、インクルード時のファイルは、＆等のエスケープを処理しておく必要があります。エスケープの前処理は、jsp:root タグのあるなしで判定します。現時点では、 & , < , <= , > , >= を前処理します。 JSP では、og:head タグで、<html> を出力したり、htmlend.jsp インクルードで </body></html> を出力していますが、フレームや、フォワードなど、整合性が取れないケースがありますので、XML処理用として、<html> を出力していません。変換結果を、正式な HTML ファイルとして再利用される場合は、ご注意ください。なお、このクラスは、マルチスレッド対応されていません。

変更履歴:: 4.0.0.2 (2007/12/10) 新規追加
導入されたバージョン:: JDK5.0,

コンストラクタの概要

コンストラクタ

コンストラクタ

説明

JspIncludeReader()

ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ
メソッドの概要

修飾子とタイプ

メソッド

説明

static void

cacheClear()

インクルードしたファイルのキャッシュをクリアします。

String

getIncludeFiles()

インクルードしたファイル名(相対パス)のリスト文字列を返します。

String

getString(File file, String encode)

JSP のインクルードを考慮した、JSPファイルを、String で返します。

static void

main(String[] args)

テスト用の main メソッド。

void

setRealPath(String path)

jspInclude=true 時に、/jsp/common/** 等の include ファイルが存在しない場合の共有取得場所を指定します。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細
- JspIncludeReader
  
  public JspIncludeReader()
  
  ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ
  
  変更履歴:
  
  8.5.3.2 (2023/10/13) JDK21対応。警告: デフォルトのコンストラクタの使用で、コメントが指定されていません
メソッドの詳細
- getString
  
  public String getString(File file, String encode)
  
  JSP のインクルードを考慮した、JSPファイルを、String で返します。このメソッドは、内部で再帰定義されています。つまり、jsp:directive.include 文字列が見つかった場合は、その代わりに、ファイル名を取出して、もう一度このメソッドを呼び出します。インクルードファイルとの関連をチェックする為にダミーのspanタグを入れておきます。 <span type="jsp:directive" include="ファイル名"></span> ただし、ソースチェック時に、 Ver4 以降で、インクルードファイルに、XML宣言と、jsp:root を付与するケースがあります。擬似的に取り込むときには、XML宣言は削除します。
  
  パラメータ:
  
  file - JSPファイル
  
  encode - ファイルのエンコード
  
  戻り値:
  
  インクルードを考慮した、JSPファイル
  
  変更履歴:
  
  5.2.1.0 (2010/10/01) directive.include で、XMLタグとroot タグは取り込まない。, 5.2.1.0 (2010/10/01) エスケープ処理の引数を廃止します。, 5.6.5.2 (2013/06/21) 小細工内容の変更。replaceAll にするのと、スペースまたはタブを使用します。, 5.6.7.1 (2013/08/09) コメントの処理のバグ修正。includeファイル名保存。, 5.6.7.1 (2013/08/09) includeファイルが存在しない場合は、gf共有から取得する。, 5.6.7.2 (2013/08/16) includeファイルを取り込む場合、代わりのspanタグを出力しておきます。, 5.6.7.4 (2013/08/30) includeファイルの先頭のpageEncoding指定のチェック用 span タグの出力, 5.7.6.2 (2014/05/16) realPath で、/jsp/common/以下に、実ファイルが存在しない場合の代替取得先を指定します。, 6.3.9.1 (2015/11/27) htmlend.jsp をインクルード処理しない箇所で、判定方法を、htmlend を含むかどうかに変更。, 6.4.3.2 (2016/02/19) /jsp/*** で始まるファイルのみ、キャッシュします。, 8.1.1.2 (2022/02/25) 1行に複数コメントの不具合対応 (例: --> XXX ), 8.5.4.2 (2024/01/12) PMD 7.0.0 CloseResource 対応
  
  このﾒｿｯﾄﾞは、nullを返しません
- setRealPath
  
  public void setRealPath(String path)
  
  jspInclude=true 時に、/jsp/common/** 等の include ファイルが存在しない場合の共有取得場所を指定します。引数の処理対象ファイル(transformの引数ファイル)が、『.jsp』で、かつ、jspInclude=true の場合、そのファイルを INCLUDE するのですが、/jsp/common/** 等の include ファイルは、エンジン共通として、jspCommon6.x.x.x.jar で提供しています。従来は、処理対象jspの相対パスで、../../../gf/jsp/commom/** を取り込んでいましたが、 Tomcat起動フォルダ以外のシステムのJSPチェックなどを行う場合は、gf フォルダが存在しないケースがあります。そこで、確実にgf が存在する、処理をキックしている環境の gf を使用するように変更します。その環境とは、つまり、エンジン内部変数の REAL_PATH ですが、jsp などが実行していないと取得できません。
  
  パラメータ:
  
  path - /jsp/common/** 等の include ファイルの共有取得場所
- getIncludeFiles
  
  public String getIncludeFiles()
  
  インクルードしたファイル名(相対パス)のリスト文字列を返します。通常は、XSLT変換処理でエラーが発生した場合は、includeファイルの整合性がおかしい場合が多いので、デバッグ情報として利用します。ただし、エラー発生時の位置特定まではできません。この内部変数は、インスタンス変数ですので、includeファイルのキャッシュとは寿命が異なります。
  
  戻り値:
  
  includeファイル名のリスト文字列
  
  変更履歴:
  
  5.6.7.1 (2013/08/09) 新規追加
  
  このﾒｿｯﾄﾞは、nullを返しません
- cacheClear
  
  public static void cacheClear()
  
  インクルードしたファイルのキャッシュをクリアします。キャッシュは、インスタンスではなく、スタティック変数で管理しています。よって、一連の処理の初めと最後にクリアしておいてください。
  
  変更履歴:
  
  5.6.7.1 (2013/08/09) 新規追加
- main
  
  public static void main(String[] args)
  
  テスト用の main メソッド。 Usage: org.opengion.fukurou.xml.JspIncludeReader inFile [outFile]
  
  パラメータ:
  
  args - コマンド引数配列
  
  変更履歴:
  
  8.5.4.2 (2024/01/12) PMD 7.0.0 CloseResource 対応

クラス JspIncludeReader

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

JspIncludeReader

メソッドの詳細

getString

setRealPath

getIncludeFiles

cacheClear

main