フィードバックを送信
Defining Entities
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

モデルヒントの追加

Service Builderを使用してモデルエンティティを定義したら、ユーザーがそのデータを入力する方法を改善したい場合があります。 モデルヒントは、エンティティデータの制限とその他のフォーマットを指定します。 たとえば、モデルヒントでは、将来のみ選択可能な日付を含むカレンダーフィールドを定義できます。

モデルヒントは、portlet-model-hints.xmlというファイルで定義します。 portlet-model-hints.xmlファイルは、サービスモジュールのsrc/main/resources/META-INFフォルダに入ります。

モデルヒントは次の2つのことを定義します。

  1. エンティティがユーザーに提示される方法

  2. データベース列のサイズ

Liferayはフォーム項目をレンダリングするときに、構成に基づいてフォームの入力フィールドをカスタマイズします。

注

依存性インジェクターとして Spring を選択した場合、Service Builder はサービス モジュールの src/main/resources/META-INF フォルダーにいくつかの XML 構成ファイルを生成します。 Service Builderは、これらのファイルのほとんどを使用して、SpringおよびHibernateの構成を管理します。 SpringまたはHibernateの構成ファイルは変更しないでください。それらへの変更は、Service Builderの実行時に上書きされます。 ただし、 portlet-model-hints.xml ファイルは安全に編集できます。

例として、 Blogs アプリ サービス モジュールの モデル ヒント ファイルを考えてみましょう。

<?xml version="1.0"?>

<model-hints>
	<model name="com.liferay.blogs.model.BlogsEntry">
		<field name="mvccVersion" type="long" />
		<field name="ctCollectionId" type="long" />
		<field name="uuid" type="String" />
		<field name="externalReferenceCode" type="String" />
		<field name="entryId" type="long" />
		<field name="groupId" type="long" />
		<field name="companyId" type="long" />
		<field name="userId" type="long" />
		<field name="userName" type="String" />
		<field name="createDate" type="Date" />
		<field name="modifiedDate" type="Date" />
		<field name="title" type="String">
			<hint name="max-length">255</hint>
			<sanitize content-type="text/plain" modes="ALL" />
			<validator name="required" />
		</field>
		<field name="subtitle" type="String">
			<hint-collection name="TEXTAREA" />
		</field>
		<field name="urlTitle" type="String">
			<hint name="max-length">255</hint>
		</field>
		<field name="description" type="String">
			<hint-collection name="TEXTAREA" />
			<hint name="display-width">350</hint>
		</field>
		<field name="content" type="String">
			<hint-collection name="CLOB" />
			<sanitize content-type="text/html" modes="ALL" />
		</field>
		<field name="displayDate" type="Date" />
		<field name="allowPingbacks" type="boolean" />
		<field name="allowTrackbacks" type="boolean" />
		<field name="trackbacks" type="String">
			<hint-collection name="CLOB" />
		</field>
		<field name="coverImageCaption" type="String">
			<hint-collection name="TEXTAREA" />
			<sanitize content-type="text/html" modes="ALL" />
		</field>
		<field name="coverImageFileEntryId" type="long" />
		<field name="coverImageURL" type="String">
			<hint-collection name="URL" />
		</field>
		<field name="smallImage" type="boolean" />
		<field name="smallImageFileEntryId" type="long" />
		<field name="smallImageId" type="long" />
		<field name="smallImageURL" type="String">
			<hint-collection name="URL" />
			<hint name="display-width">210</hint>
		</field>
		<field name="lastPublishDate" type="Date" />
		<field name="status" type="int" />
		<field name="statusByUserId" type="long" />
		<field name="statusByUserName" type="String" />
		<field name="statusDate" type="Date" />
	</model>
</model-hints>

ルートレベルの要素はmodel-hintsです。 モデルエンティティは、model-hints要素のmodelサブ要素によって表されます。 各model要素には、完全修飾クラス名を指定するname属性が必要です。 モデルには、エンティティの列を表す field要素があります。 最後に、field要素には名前とタイプが必要です。 各field要素の名前とタイプは、サービスモジュールのservice.xmlファイルのエンティティの列に指定された名前とタイプにマップされます。 Service Builderは、service.xmlに基づいて、これらすべての要素を生成します。

フィールドにヒントを追加するには、hint子要素を追加します。 たとえば、display-width hintを追加して、フィールドの表示に使用するピクセル幅を指定できます。 デフォルトのピクセル幅は350です。 50ピクセルのStringフィールドを表示するには、display-widthという名前のhint要素をネストして値50を指定します。

フィールドのヒントの効果を確認するには、 Service Builder を再度実行 し、 モジュールを再デプロイします。 display-widthを変更しても、ユーザーがnameフィールドに入力できる文字数は制限されないことに注意してください。入力フォームのフィールドの幅のみが制御されます。

モデルフィールドのデータベース列の最大サイズ（つまり、フィールドに保存できる最大文字数）を構成するには、max-lengthヒントを使用します。 デフォルトのmax-length値は、75文字です。 名前 フィールドを最大 100 文字まで保持したい場合は、そのフィールドに 最大長 ヒントを追加します。

<field name="name" type="String">
    <hint name="display-width">50</hint>
    <hint name="max-length">100</hint>
</field>

portlet-model-hints.xmlファイルを更新した後にService Builderを実行してプロジェクトを再デプロイすることを忘れないでください。

モデルヒントのタイプ

次の表に、使用可能なポートレットモデルのヒントを示します。

モデルヒントの値と説明

名前値のタイプ説明デフォルト
auto-escapeブール値HtmlUtil.escapeを介してテキスト値をエスケープするかどうかを設定しますtrue
autoSizeブール値スクロール可能なテキストエリアにフィールドを表示しますfalse
day-nullableブール値日付フィールドで日をnullにすることができますfalse
default-value文字列aui taglibを使用してレンダリングされたフォーム項目のデフォルト値を設定します（空のString）
display-height整数aui taglibを使用してレンダリングされたフォーム項目の表示高さを設定します15
display-width整数aui taglibを使用してレンダリングされたフォーム項目の表示幅を設定します350
editorブール値入力用のエディターを提供するかどうかを設定しますfalse
max-length整数SQLファイル生成の最大列サイズを設定します75
month-nullableブール値日付フィールドで月をnullにすることができますfalse
secretブール値ユーザーが入力した文字を非表示にするかどうかを設定しますfalse
show-timeブール値日付とともに時刻を表示するかどうかを設定しますtrue
upper-caseブール値すべての文字を大文字に変換しますfalse
year-nullableブール値日付フィールドの年をnullにすることができますfalse
year-range-delta整数aui taglibでレンダリングされた日付フィールドに今日の日付から何年後まで表示するかを年数で指定します5
year-range-futureブール値将来の日付を含めるかどうかを設定しますtrue
year-range-pastブール値過去の日付を含めるかどうかを設定しますtrue
注

aui taglibは完全にサポートされており、廃止予定のAlloyUI（JavaScriptライブラリ）とは関係ありません。

注

1つのフォームでClayタグとauiタグを組み合わせて使用できます。 ただし、モデルヒントはauiタグにのみ影響します。

Liferay DXP/Portal には独自のモデルヒントファイル portal-model-hints.xmlがあることに注意してください。 これは、portal-impl.jarのMETA-INFフォルダにあります。 このファイルには多くのヒントの例が含まれているため、portlet-model-hints.xmlファイルを作成するときに参照できます。

デフォルトのヒント

default-hints要素を使用して、モデルのすべてのフィールドに適用するヒントのリストを定義できます。 たとえば、モデル要素内に次の要素を追加すると、各フィールドに300ピクセルのdisplay-widthが適用されます。

<default-hints>
    <hint name="display-width">300</hint>
</default-hints>

ヒントコレクション

model-hintsのルートレベル要素内にhint-collection要素を定義して、一緒に適用するヒントのリストを定義できます。 ヒントコレクションには名前が必要です。 たとえば、Liferayのportal-model-hints.xmlは、次のヒントコレクションを定義しています。

<hint-collection name="CLOB">
    <hint name="max-length">2000000</hint>
</hint-collection>
<hint-collection name="EDITOR">
    <hint name="editor">true</hint>
    <hint name="max-length">2000000</hint>
</hint-collection>
<hint-collection name="EMAIL-ADDRESS">
    <hint name="max-length">254</hint>
</hint-collection>
<hint-collection name="HOSTNAME">
    <hint name="max-length">200</hint>
</hint-collection>
<hint-collection name="SEARCHABLE-DATE">
    <hint name="month-nullable">true</hint>
    <hint name="day-nullable">true</hint>
    <hint name="year-nullable">true</hint>
    <hint name="show-time">false</hint>
</hint-collection>
<hint-collection name="TEXTAREA">
    <hint name="display-height">105</hint>
    <hint name="display-width">500</hint>
    <hint name="max-length">4000</hint>
</hint-collection>
<hint-collection name="URL">
    <hint name="max-length">4000</hint>
</hint-collection>

ヒントコレクションの名前を参照することにより、モデルフィールドにヒントコレクションを適用できます。 たとえば、 model-hints 要素で上記のような SEARCHABLE-DATE コレクションを定義した場合、コレクションを名前で参照する hint-collection 要素を使用して、それをモデルの日付フィールドに適用できます。

<field name="date" type="Date">
    <hint-collection name="SEARCHABLE-DATE" />
</field>

プロジェクトでいくつかのモデルヒントを使用するとします。 まずは、コメントフィールドに入力するためのエディターをユーザーに提供することから始めます。 同じヒントを複数のエンティティに適用するには、それをヒントコレクションとして定義します。 次に、各エンティティのヒントコレクションを参照します。

ヒントコレクションを定義するには、portlet-model-hints.xmlファイルのmodel-hintsルート要素内にhint-collection要素を追加します。 以下に例を示します。

<hint-collection name="COMMENT-TEXTAREA">
    <hint name="display-height">105</hint>
    <hint name="display-width">500</hint>
    <hint name="max-length">4000</hint>
</hint-collection>

特定のフィールドのヒントコレクションを参照するには、フィールドのfield要素内にhint-collection要素を追加します。

<field name="comment" type="String">
    <hint-collection name="COMMENT-TEXTAREA" />
</field>

ヒントコレクションを定義し、ヒントコレクションの参照を追加したら、サービスを再構築し、プロジェクトを再デプロイして、ヒントコレクションで定義されたヒントが有効になっていることを確認します。

これで、モデルの入力フィールドの表示方法だけでなく、データベーステーブルの列サイズを設定することもできるようになりました。 ヒントを整理したり、個々のヒントをフィールドに直接挿入したり、モデルのすべてのフィールドにデフォルトのヒントのセットを適用したり、これらのスコープのいずれかに適用するヒントのコレクションを定義したりできます。

Capability:
Development and Tooling
Resource Type:
Official Documentation
Feature:
Data Frameworks
Deployment Approach:
Liferay PaaS
Liferay Self-Hosted