ファイル名一覧取得処理

オペレーション名

ファイル名一覧取得

機能概要

ディレクトリ内のファイル名一覧を取得します。

データモデル

本コンポーネントのデータモデルはXML型です。
入出力のスキーマについては「スキーマ」を参照してください。

プロパティ

基本設定

項目名 必須/省略可 変数の使用 説明 補足
名前 必須 使用不可 スクリプトキャンバス上での名前を入力します。  

必須設定

項目名 必須/省略可 変数の使用 説明 補足
ディレクトリパス 必須 使用可 一覧を取得するディレクトリのパスを入力します。

[参照]ボタンを押下するとディレクトリチューザが起動し、ディレクトリの選択ができます。
ファイル名一覧をソート 省略可 使用不可 ファイル名一覧をソートするかどうかを選択します。
  • [チェックあり]:
    [ソート順序]で指定した順序でソートします。
  • [チェックなし]:(デフォルト)
    ソートしません。
  
ソート順序 省略可 使用不可 ソート順序を選択します。
  • [昇順並べ替え]:(デフォルト)
    ファイル名の昇順でソートします。
  • [降順並べ替え]:
    ファイル名の降順でソートします。
  • [ファイル名一覧をソート]にチェックを入れた場合、有効になります。
  • ファイル名の順序はUnicode順となります。
    例:半角数字＜半角英字＜全角ひらがな＜全角カタカナ＜漢字＜全角数字＜全角英字＜半角カタカナ(昇順の場合)

コメント

項目名 必須/省略可 変数の使用 説明 補足
コメント 省略可 使用不可 このアダプタの簡単な説明を記述することができます。
説明を記述すると、仕様書に反映させることができます。		  

スキーマ

<filelist>
 <file name="" type=""/>
</filelist>
要素名 属性名 説明
filelist   ルート要素です。
file name 取得したファイルまたはディレクトリの名前を出力します。
type 取得したファイルまたはディレクトリのファイルタイプを出力します。
  • [file]:ファイル
  • [directory]:ディレクトリ

Mapperでのスキーマ読み込み

入出力スキーマは自動で読み込まれます。

大容量データ処理

大容量データ処理に対応していません。

使用できるコンポーネント変数

変数名 説明
success 処理が成功した場合にはtrue、失敗した場合にはfalseが返ります。
directoryCount 取得したディレクトリ数が返ります。処理が失敗した場合にはnullが返ります。
fileCount 取得したファイル数が返ります。処理が失敗した場合にはnullが返ります。
error_type エラーが発生したときに、エラーの種類を返します。
java.io.FileNotFoundExceptionというような形式で返されます。
エラーが発生しなかった時にはnullを返します。
バージョンにより、内容が変わる可能性があります。
error_message エラーが発生したときのエラーメッセージを返します。
バージョンにより、内容が変わる可能性があります。
error_trace エラーが発生したときのトレース情報を返します。
バージョンにより、内容が変わる可能性があります。

主な例外

例外名 原因 対策
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。		 [<プロパティ名>]が指定されていません。 [<プロパティ名>]を指定してください。
FileIsNotDirectoryException [ディレクトリパス]に指定されたパスがディレクトリではありません。 [ディレクトリパス]にはディレクトリを指定してください。
java.io.FileNotFoundException 指定したディレクトリが見つかりません。 [ディレクトリパス]を確認してください。