35.5.5. シーケンスの発生制約

デフォルトでは、sequence 要素の内容は、複合型のインスタンスで 1 回のみ表示されます。その minOccurs 属性およびその maxOccurs 属性を使用して、sequence 要素で定義された要素のシーケンスが表示を許される回数を変更することができます。これらの属性を使用して、複合型のインスタンスでシーケンス型が 0 回から無制限に発生する可能性があることを指定できます。

minOccurs 属性は、定義された複合型のインスタンスでシーケンスが発生しなければならない最小回数を指定します。その値は任意の正の整数にすることができます。minOccurs 属性を 0 に設定すると、シーケンスがコンプレックスタイプのインスタンス内で表示されないことを示しています。

maxOccurs 属性は、定義されたコンプレックスタイプのインスタンスでシーケンスが発生する回数の上限を指定します。この値には、ゼロ以外の正の整数または unbounded を設定できます。maxOccurs 属性を unbounded に設定すると、シーケンスが無限に見えるようになります。

例35.20「発生制約のあるシーケンス」に、シーケンスの発生の制約が設定された sequence 型の定義 CultureInfo を示します。シーケンスは 0 から 2 回繰り返すことができます。

<complexType name="CultureInfo">
  <sequence minOccurs="0" maxOccurs="2">
    <element name="Name" type="string"/>
    <element name="Lcid" type="int"/>
  </sequence>
</complexType>

<complexType name="CultureInfo">
  <sequence minOccurs="0" maxOccurs="2">
    <element name="Name" type="string"/>
    <element name="Lcid" type="int"/>
  </sequence>
</complexType>

単一インスタンスシーケンスとは異なり、複数回発生する可能性のある XML スキーマシーケンスは、単一のメンバー変数を使用して Java クラスにマップされます。この単一メンバー変数は、シーケンスの複数の発生に対するすべてのデータを保持する List<T> オブジェクトです。たとえば、例35.20「発生制約のあるシーケンス」 で定義されたシーケンスが 2 回発生した場合、リストには 4 つの項目が含まれます。

Java クラスのメンバー変数の名前は、メンバー要素の名前を連結することにより引き出されます。要素名は And で区切られ、変数名の最初の文字が小文字に変換されます。たとえば、例35.20「発生制約のあるシーケンス」 から生成されたメンバー変数の名前は nameAndLcid になります。

リストに格納されるオブジェクトのタイプは、メンバー要素の型間の関係によって異なります。以下に例を示します。

生成された Java クラスには、メンバー変数のゲッターメソッドのみがあります。getter メソッドは、ライブリストへの参照を返します。返されたリストに加えられた変更は、実際のオブジェクトに影響します。

Java クラスは @XmlType アノテーションで禁止されています。アノテーションの name プロパティーは、XML Schema 定義の親要素の name 属性の値に設定されます。アノテーションの propOrder プロパティーには、シーケンス内の要素を表す単一のメンバー変数が含まれます。

シーケンスの要素を表すメンバー変数には、@XmlElements アノテーションが付けられます。@XmlElements アノテーションには、@XmlElement アノテーションのコンマ区切りリストが含まれます。このリストには、型の XML スキーマ定義で定義されたメンバー要素ごとに @XmlElement アノテーションが 1 つ含まれます。リストの @XmlElement アノテーションは、name プロパティーが XML Schema element エレメントの name 属性の値に設定され、type プロパティーが XML Schema element エレメントのタイプをマッピングした結果の Java クラスに設定されています。

例35.21「発生制約のあるシーケンスの Java 表現」 は、例35.20「発生制約のあるシーケンス」 で定義された XML スキーマシーケンスの Java マッピングを示します。

@XmlType(name = "CultureInfo", propOrder = {
    "nameAndLcid"
})
public class CultureInfo {

    @XmlElements({
        @XmlElement(name = "Name", type = String.class),
        @XmlElement(name = "Lcid", type = Integer.class)
    })
    protected List<Serializable> nameAndLcid;

    public List<Serializable> getNameAndLcid() {
        if (nameAndLcid == null) {
            nameAndLcid = new ArrayList<Serializable>();
        }
        return this.nameAndLcid;
    }

}

@XmlType(name = "CultureInfo", propOrder = {
    "nameAndLcid"
})
public class CultureInfo {

    @XmlElements({
        @XmlElement(name = "Name", type = String.class),
        @XmlElement(name = "Lcid", type = Integer.class)
    })
    protected List<Serializable> nameAndLcid;

    public List<Serializable> getNameAndLcid() {
        if (nameAndLcid == null) {
            nameAndLcid = new ArrayList<Serializable>();
        }
        return this.nameAndLcid;
    }

}

minOccurs 要素のみが指定され、その値が 0 の場合、コードジェネレーターは minOccurs 属性が設定されていないかのように Java クラスを生成します。