主要メソッド

public void getTransientProperty() {
    if (this.transientProperty == null) {
        this.transientProperty = dao.findTransientProperty(this.id);
    }
    return this.transientProperty;
}
            

コンストラクタ

ドメインモデルでは JavaBeans の特性の一つであるデフォルトコンストラクタは必須で、必要に応じて引数付きのコン ストラクタを用意します。引数付きコンストラクタとしては、新規ドメインオブジェクト生成用コンストラクタと既存ドメインオブ ジェクト復元用コンストラクタの二種を用意しておくと便利です。例はサンプルコードを参照ください。

インターフェース Domain

ドメインモデルは、自身がドメインモデルであることを示すためにインターフェース Domain を実装します。Domain はメソッドを定義しないマーカーインターフェースです。インターフェース Domain を実装したドメインモデルは、後述のドメインファクトリからインスタンス化可能でなければな りません。United Front 2 では、ドメインオブジェクトの生成を Spring Framework の DI コンテナを使って 管理しています。

静的構造図

次の図は、サンプルのドメインモデル SampleDomain が対応するデータアクセスインターフェース SampleDomainDao を保持している構造を示しています。

サンプルコード

ドメインモデルのサンプル SampleDomain を示します。SampleDomain は ID とコード、文字列、浮動点小数をプロパティとして持つ単純なドメインモデルです。メソッド equals 、 hashCode 、toString は Apache Commons Lang を使って実装を簡略化しています。データアクセスを伴う　store 、delete メソッドのほか、データアクセスを伴わない multipleTextLengthAndD という固有メソッドを 持っています。SampleDomain の完全なコードは SampleDomain のソースコード を参照ください。

public class SampleDomain implements Identifiable<SampleDomain>, Storable,
    Deletable, Domain, Serializable {

    /** シリアル番号 */
    private static final long serialVersionUID = -2784958436581567548L;

    /** ログ */
    protected final transient Log logger = LogFactory.getLog(getClass());

    /** ID 。主キー。 */
    private Integer id;

    /** コード。一意な値。 */
    private String code;

    /** 浮動点小数 */
    private Double d;

    /** テキスト */
    private String text;

    // 非永続プロパティは transient で宣言
    /** サンプルドメインデータアクセスオブジェクト */
    private transient SampleDomainDao sampleDomainDao;

    /** デフォルトコンストラクタ */
    public SampleDomain() {
        super();
    }

    /** 新規オブジェクト作成用のコンストラクタ。ID は null 。 */
    public SampleDomain(String code, Double d, String text) {
        super();
        this.code = code;
        this.d = d;
        this.text = text;
    }

    /** 既存オブジェクト復元用のコンストラクタ */
    public SampleDomain(Integer id, String code, Double d, String text) {
        this(code, d, text);
        this.id = id;
    }

    // equals, hashCode, toString の実装には非永続プロパティを含めていません
    @Override
    public boolean equals(final Object other) {
        if (!(other instanceof SampleDomain)) {
            return false;
        }
        SampleDomain castOther = (SampleDomain) other;
        return new EqualsBuilder()
            .append(id, castOther.id)
            .append(code, castOther.code)
            .append(d, castOther.d)
            .append(text, castOther.text).isEquals();
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder()
            .append(id)
            .append(code)
            .append(d)
            .append(text).toHashCode();
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this)
            .append("id", id)
            .append("code", code)
            .append("d", d)
            .append("text", text).toString();
    }

    // インターフェース Identifiable の実装
    @Override
    public boolean identify(SampleDomain other) {
        if (id == null) {
            return false;
        }
        return id.equals(other.getId());
    }

    // インターフェース Storable の実装
    // ここではコードの整合性チェックを store メソッドの役割としており、メソッドの例外に
    // DuplicateSampleDomainCodeException を定義しています。
    // コードが他と重複していないことを store メソッドの事前条件とする設計も考えられます。
    // その場合、実行時例外を発生させるような設計にします。
    @Override
    public void store() throws DuplicateSampleDomainCodeException {
        if (id == null) {
            if (sampleDomainDao.findByCode(code) != null) {
                // コードが一意でない
                String message = "The code '" + code + "' already exists.";
                logger.warn(message);
                throw new DuplicateSampleDomainCodeException(message);
            }
            sampleDomainDao.register(this);
        } else {
            SampleDomain found = sampleDomainDao.findByCode(code);
            if (found != null && !identify(found)) {
                // コードが一意でない
                String message = "The code '" + code + "' already exists.";
                logger.warn(message);
                throw new DuplicateSampleDomainCodeException(message);
            }
            sampleDomainDao.update(this);
        }
    }

    // インターフェース Deletable の実装
    @Override
    public void delete() {
        sampleDomainDao.delete(id);
    }

    // 独自メソッド
    /** テキスト文字数と浮動小数点の掛け算の結果 */
    public double multipleTextLengthAndD() {
        int textLength;
        if (text == null) {
            textLength = 0;
        } else {
            textLength = text.length();
        }
        return textLength * d;
    }

    // getters and setters ...

    // データアクセスオブジェクトは setter メソッドのみを持つ
    public void setSampleDomainDao(SampleDomainDao sampleDomainDao) {
        this.sampleDomainDao = sampleDomainDao;
    }
}

private Date date;

public Date getDate() {
    if (date == null) {
        return null;
    } else {
        return (Date) date.clone();
    }
}

public void setDate(Date date) {
    if (date == null) {
        this.date = null;
    } else {
        this.date = (Date) date.clone();
    }
}

private final Set<String> keywords = new HashSet<String>();

public boolean addKeyword(String e) {
    return keywords.add(e);
}

public boolean addKeywords(Collection<? extends String> c) {
    return keywords.addAll(c);
}

public void clearKeywords() {
    keywords.clear();
}

public boolean removeKeyword(Object o) {
    return keywords.remove(o);
}

public boolean removeKeywords(Collection<?> c) {
    return keywords.removeAll(c);
}

public boolean retainKeywords(Collection<?> c) {
    return keywords.retainAll(c);
}

public Set<String> getKeywords() {
    return Collections.unmodifiableSet(keywords);
}

public void setKeywords(Set<String> keywords) {
    this.keywords.clear();
    this.keywords.addAll(keywords);
}

Note: 担当外のデータアクセスオブジェクトは保持しない

ドメインクラスは通常自分が担当し保持しているデータアクセスオブジェクトを持っています。ドメイン間で依存関係を持っ ている場合などに、他のドメインが担当するデータアクセスオブジェクトを使用したくなりますが、その際はデータアクセス オブジェクトではなくテーブルモジュールを参照するようにします。ドメインクラスはデータの整合性を保つ役割も持ってい るため、安全にデータを操作できます。

Spring Bean 定義

ドメインモデルは Spring Bean 定義ファイル appilcationContext-domain.xml に定義します。ドメインモデルは読み込みのたびにインスタンスを新しく生成するよう、スコープを prototype に で指定しています。

<bean id="sampleDomain" class="org.unitedfront2.domain.SampleDomain"
    scope="prototype">
  <property name="sampleDomainDao" ref="sampleDomainDao"/>
</bean>

主要メソッド

上記の基本メソッドに加え、次のようなメソッドを持つことがあります。

静的構造図

SimpleTableModule はテーブルモジュールの実装を支援する抽象クラスです。SimpleTableModule は整数型の主 キーをただひとつ持ち、継承構造を持たないドメインモデルに対して有効です。この抽象クラスを継承することで、 exist 、find 、get などの基本メソッドの実装を再利用 できます。

サンプルコード

テーブルモジュールのサンプル SampleDomainTable を示します。SampleDomainTable はドメインモデル SampleDomain に対応するテーブルモジュールで、基本的なメソッドに加え、 コードから SampleDomain オブジェクトを復元するメソッドと永続化されている SampleDomain オブジェクトの件数を取得する count メソッドを提供しています。SampleDomainTable の完全なコードは SampleDomainTable のソースコード を参照ください。

public class SampleDomainTable extends SimpleTableModule<SampleDomain> {

    private SampleDomainDao sampleDomainDao;

    // SimpleTableModule の抽象メソッドを実装
    @Override
    protected SimpleFindable<SampleDomain> getSimpleDao() {
        return sampleDomainDao;
    }

    public SampleDomain findByCode(String code) {
        return sampleDomainDao.findByCode(code);
    }

    public SampleDomain getByCode(String code) throws IllegalArgumentException {
        SampleDomain sampleDomain = findByCode(code);
        if (sampleDomain == null) {
            String message = "The sample domain code '" + code + "' not found.";
            logger.warn(message);
            throw new IllegalArgumentException(message);
        }
        return sampleDomain;
    }

    public boolean existByCode(String code) {
        return findByCode(code) != null;
    }

    /** 登録されているサンプルドメインの総数を取得します。 */
    public int count() {
        return sampleDomainDao.count();
    }

    public void setSampleDomainDao(SampleDomainDao sampleDomainDao) {
        this.sampleDomainDao = sampleDomainDao;
    }
}

Spring Bean 定義

テーブルモジュールはアプリケーション実行中ただ一つ存在するシングルトンオブジェクトで、Spring DI コンテナに よって管理されます。

<bean id="sampleDomainTable" class="org.unitedfront2.domain.SampleDomainTable">
  <property name="sampleDomainDao" ref="sampleDomainDao"/>
</bean>

主要メソッド

検証例外

プロパティが不正な値をとっている場合、validate メソッドは検証例外 ValidationException を発生させます。ValidationException は多言語対応したエラーメッセージを保持します。

throw new ValidationException("sample.SampleDomain.validation.error", null);

サンプルソース

検証クラスのサンプル SampleDomainValidator を示します。SampleDomainValidator の validateCode メソッドは、SampleDomain オブジェクトのプロパティ code の値を検証します。検証ロジックの実装にはユーティリティクラス Validate を使っています。最後にテーブルモジュール SampleDomains を使ってコードが一意のデータで あることを検証しています。SampleDomainValidator の完全なコードは SampleDomainValidator のソースコード を参照ください。

public class SampleDomainValidator implements Serializable {

    /** デフォルトのコードの最小文字数のデフォルト (2) */
    public static final int DEFAULT_CODE_MIN_LENGTH = 2;

    /** デフォルトのコードの最大文字数のデフォルト (32) */
    public static final int DEFAULT_CODE_MAX_LENGTH = 32;

    /** デフォルトのコードの正規表現 ([\p{Alnum}]*) */
    public static final String DEFAULT_CODE_REGEX = "[\\p{Alnum}]*";

    /** デフォルトのテキストの最大文字数 (128) */
    public static final int DEFAULT_TEXT_MAX_LENGTH = 128;

    /** シリアル番号 */
    private static final long serialVersionUID = 8383063072303370633L;

    /** コードの最小文字数 */
    private int codeMinLength = DEFAULT_CODE_MIN_LENGTH;

    /** コードの最大文字数 */
    private int codeMaxLength = DEFAULT_CODE_MAX_LENGTH;

    /** コードの正規表現 */
    private String codeRegex = DEFAULT_CODE_REGEX;

    /** テキストの最大文字数 */
    private int textMaxLength = DEFAULT_TEXT_MAX_LENGTH;

    /** サンプルドメインテーブル */
    private transient SampleDomainTable sampleDomainTable;

    @Override
    public boolean equals(final Object other) {
        if (!(other instanceof SampleDomainValidator)) {
            return false;
        }
        SampleDomainValidator castOther = (SampleDomainValidator) other;
        return new EqualsBuilder()
            .append(codeMinLength, castOther.codeMinLength)
            .append(codeMaxLength, castOther.codeMaxLength)
            .append(codeRegex, castOther.codeRegex)
            .append(textMaxLength, castOther.textMaxLength).isEquals();
    }

    @Override
    public int hashCode() {
        return new HashCodeBuilder()
            .append(codeMinLength)
            .append(codeMaxLength)
            .append(codeRegex)
            .append(textMaxLength).toHashCode();
    }

    @Override
    public String toString() {
        return new ToStringBuilder(this)
            .append("codeMinLength", codeMinLength)
            .append("codeMaxLength", codeMaxLength)
            .append("codeRegex", codeRegex)
            .append("textMaxLength", textMaxLength).toString();
    }

    public void validateCode(SampleDomain sampleDomain)
        throws ValidationException {
        String code = sampleDomain.getCode();
        Validate.notBlank(code);
        Validate.lengthInRange(code, codeMinLength, codeMaxLength);
        Validate.match(code, codeRegex);
        SampleDomain found = sampleDomainTable.findByCode(code);
        if (found != null && !sampleDomain.identify(found)) {
            throw new ValidationException("sample.validation.codeUsedByOther",
                    new Object[] {code},
                    "The code '" + code + "' is used by other.");
        }
    }

    public void validateText(SampleDomain sampleDomain)
    	throws ValidationException {
        Validate.notBlank(sampleDomain.getText());
        Validate.maxLength(sampleDomain.getText(), textMaxLength);
    }

    // getters and setters ...

    public void setSampleDomainTable(SampleDomainTable sampleDomainTable) {
        this.sampleDomainTable = sampleDomainTable;
    }
}

Spring Bean 定義

検証クラスのプロパティはデフォルト値が設定されているため、変更しない限り特別なプロパティの設定は不要です。

<bean id="sampleDomainValidator" class="org.unitedfront2.domain.SampleDomainValidator">
  <property name="sampleDomainTable" ref="sampleDomainTable"/>
</bean>