intra-mart Accel Kaiden! プログラミングガイド 第21版 2024-04-01

3.2.13. Helper&Util

本項では、intra-mart Accel Kaiden!のHelperクラスとUtilクラスについて解説します。
intra-mart Accel Kaiden!では、様々なHelperクラスとUtilクラスを用意しています。

3.2.13.1. ヘルパーとは?

intra-mart Accel Kaiden!のヘルパーとは、各種処理支援を行うAPIを提供しています。
また、ユーティリティのうち主にintra-mart Accel PlatformのAPIを利用もしくはラッピングしたクラスです。

3.2.13.2. intra-mart Accel Kaiden!で提供しているヘルパー

intra-mart Accel Kaiden!で提供しているヘルパークラスは以下の通りです。
各APIの詳細は『intra-mart Accel Kaiden! JavaDoc』を参照してください。

3.2.13.2.1. 基盤モジュール

クラス名 説明
CacheHelper
キャッシュ機能を扱うクラスです。
CalendarInfoManagerHelper
intra-mart Accel PlatformのCalendarInfoManagerクラスをラッピングしています。
CompanyGroupManagerHelper
intra-mart Accel PlatformのCompanyGroupManagerクラスをラッピングしています。
CompanyManagerHelper
intra-mart Accel PlatformのCompanyManagerクラスをラッピングしています。
CompanySettingsHelper
会社設定に関する機能を扱うクラスです。
ContextHelper
intra-mart Accel Platformのコンテキストに関する操作を扱うクラスです。
ConvertPdfHelper
PDF変換に関する操作を行うクラスです。
CurrencyHelper
通貨に関する機能を扱うクラスです。
DateHelper
日付に関する機能を扱うクラスです。
DocumentDataSettingsHelper
ドキュメントデータ設定に関する機能を扱うクラスです。
ExportHelper
Export処理を扱う機能を扱うクラスです。
ExtExportHelper
拡張版Export処理を扱う機能を扱うクラスです。
ExtImportHelper
拡張版Import処理を扱う機能を扱うクラスです。
FormatHelper
書式変換に関する機能を扱うクラスです。
IdentifierHelper
intra-mart Accel PlatformのIdentifierクラスをラッピングしています。
ImageViewHelper
画像参照に関連する操作を行うクラスです。
ImportHelper
Import処理を扱う機能を扱うクラスです。
JobnetManagerHelper
intra-mart Accel PlatformのJobSchedulerManagerクラスをラッピングしています。
LockHelper
intra-mart Accel PlatformのNewLockクラスをラッピングしています。
NumberHelper
数値に関する機能を扱うクラスです。
PropertyHelper
XMLプロパティへのアクセス機能を扱うクラスです。
RoleInfoManagerHelper
intra-mart Accel PlatformのRoleInfoManagerクラスをラッピングしています。
SessionScopeStorageFileHelper
セッションスコープストレージのファイル操作を扱うクラスです。
StorageFileHelper
ファイル操作を扱う機能を扱うクラスです。
SystemLocaleHelper
システムロケールを扱う機能を扱うクラスです。
TaskManagerHelper
intra-mart Accel PlatformのTaskManagerクラスをラッピングしています。
TransferHelper
intra-mart Accel PlatformのTransferクラスをラッピングしています。
UserManagerHelper
intra-mart Accel PlatformのUserManagerクラスをラッピングしています。
ValidateMapHelper
各ValidatorクラスのvalueMapにアクセスする機能を扱うクラスです。
XmlOutputHelper
XML出力を行います。
XMLResourceBundle
XMLを扱うリソースバンドルクラスです。
XMLResourceBundleControl
ResourceBundle.Controlクラスにて、XMLを扱う実装クラスです。
XMLResourceHelper
XMLプロパティファイルを扱うクラスです。
XmlSettingsHelper
XML設定ファイルを扱うクラスです。

3.2.13.2.2. IM-Workflow連携モジュール

クラス名 説明
ExtensionNumberingSettingsHelper
拡張採番設定ファイル読込機能を扱うクラスです。
NumberingRuleReplacePatternHelper
採番ルール定義における文字列置換機能を扱うクラスです。
UserMatterPropertyHelper
ユーザデータ案件プロパティ情報操作を扱うクラスです。

3.2.13.2.3. ワークフローモジュール

クラス名 説明
FbExportHelper
FBデータファイルのExportの機能を扱うクラスです。

3.2.13.2.4. 勤務管理モジュール

クラス名 説明
LaborDateHelper
intra-mart Accel Kaiden! 勤務管理モジュールの日付関連を機能を扱うクラスです。

3.2.13.3. ヘルパーの呼び出し

呼び出す場所については特に制限はなく、どこからでも使用できます。
intra-mart Accel Kaiden!の通貨関連ヘルパークラスを呼び出すサンプルを以下に掲載します。
  • @Autowiredアノテーションによるコンポーネント取得
    @Autowired
    public CurrencyHelper currencyHelper;
    
    public void xxxMethod() {
        String currencyCd = currencyHelper.getCompanyCurrencyCd("会社コード");
    }
  • コンポーネント名を指定してコンポーネント取得
    public CurrencyHelper currencyHelper;
    
    public void xxxMethod() {
        currencyHelper = ApplicationContextHolder.getApplicationContext().getBean(CurrencyHelper.class);
        String currencyCd = currencyHelper.getCompanyCurrencyCd("会社コード");
    }

コラム

intra-mart Accel Kaiden!のヘルパークラスでは、@Autowiredアノテーションを使用しない場合、コンポーネント名を指定して取得しています。

3.2.13.4. ヘルパーの作成

業務要件に応じて作成してください。
作成する際はintra-mart Accel Kaiden!が提供しているヘルパークラスを拡張するのではなく、新規のヘルパークラスを作成してください。

注意

intra-mart Accel Kaiden!ではクラス名を指定してヘルパークラスのコンポーネント取得をしています。
ヘルパークラスが拡張されることを想定していません。

3.2.13.5. ユーティリティとは?

intra-mart Accel Kaiden!のユーティリティとは、
主に簡易な便利機能を提供し、staticな共通の処理のメソッドを集めたクラスです。

3.2.13.6. intra-mart Accel Kaiden!で提供しているユーティリティ

intra-mart Accel Kaiden!で提供しているユーティリティクラスは以下の通りです。
各APIの詳細は『intra-mart Accel Kaiden! JavaDoc』を参照してください。

3.2.13.6.1. 基盤モジュール

クラス名 説明
ArrayUtil
配列のユーティリティクラスです。
BarcodeUtil
バーコード生成のユーティリティクラスです。
BeanUtil
Beanユーティリティクラスです。
Beanへの汎用アクセスを提供します。
CollectionUtil
コレクションに関するユーティリティクラスです。
CollectionUtilDtoSortComparator
DTOをソートするComparatorクラスです。
CollectionUtilDtoSortComparator4Locale
システムロケール順にソートするComparatorクラスです。
対象DTOにロケールIDが存在しない場合はソートしません。
ConvertForJsonSource
JSON出力用の形式に変換するユーティリティクラスです。
GadgetBuilderUtil
GadgetBuilderのユーティリティクラスです。
HtmlEncodeUtil
HTML形式での表示を目的とする文字列変換ユーティリティクラスです。
HttpUtil
HTTP通信のユーティリティクラスです。
JsonUtil
JSON操作用のユーティリティクラスです。
KaidenPropertyReader
intra-mart Accel Kaiden!のプロパティファイルを読み込むユーティリティクラスです。
ListDivider
リスト分割ユーティリティクラスです。
DTOリストを指定の主キー毎に分割します。
ListDividerForMap
リスト分割ユーティリティクラスです。
Mapリストを指定の主キー毎に分割します。
MasterBuilderUtil
MasterBuilderのユーティリティクラスです。
ParametersUtil
パラメータ保持用のユーティリティクラスです。
PDFUtil
PDF操作用のユーティリティクラスです。
PropertyJspUtil
クライアントからのプロパティファイル読み込みユーティリティクラスです。
ReportBuilderUtil
ReportBuilderのユーティリティクラスです。
ResponseWriter
HttpResponseへの出力機能を扱うユーティリティクラスです。
RestApiUtil
RestAPIのユーティリティクラスです。
SettingsUtil
設定情報に関するユーティリティクラスです。
SimpleFileUtil
SimpleFileのユーティリティクラスです。
StringUtil
String型オブジェクトのユーティリティクラスです。

3.2.13.6.2. IM-Workflow連携モジュール

クラス名 説明
AppUtil
申請書マスタのユーティリティクラスです。

3.2.13.6.3. ワークフローモジュール

クラス名 説明
BudgetUtil
予算のユーティリティクラスです。

3.2.13.6.4. 勤務管理モジュール

クラス名 説明
LaborTaskUtil
intra-mart Accel Kaiden! 勤務管理モジュールのタスクに関するユーティリティクラスです。
PaidLeaveGrantUtil
有給休暇付与に関するユーティリティクラスです。