コレクションを表すエンティティの作成

サポートされていないフィールド型

非表示 ORM は、そのタイプの他のマッピングがない場合、java.io.Serializable を実装するJava型をバイナリ データに直列化します。データが この形式で保存されないようにするには、 Hibernetes ORM 拡張機能 が次のタイプを拒否し、アプリケーションの起動時に例外をスローします。このチェックは、プライマリキー、通常のフィールド、埋め込み可能な属性、コレクション要素に適用されます。

次の表では、サポートされていないフィールド型とサポートされている代替手段について説明します。

スキーマ修飾子

@Table アノテーションでは、コレクション名の前に任意の schema 要素を受け入れます。両方の要素を設定すると、 Hibernetes ORM 拡張機能はエンティティを <schema name>.<collection name> という名前のコレクションにマッピングします。

スキーマ修飾子は、コレクションの名前のみを変更します。スキーマは別のMongoDBデータベース ではありません。すべてのスキーマ修飾コレクションは、SessionFactoryインスタンスが接続するデータベースに存在します。これらのコレクションは 1 つのデータベースを共有する ため、トランザクションは複数のスキーマにまたがることができます。

スキーマ修飾子を適用するには、次の構文を使用します。

@Entity
@Table(schema = "<schema name>", name = "<collection name>")
public class <EntityName> {
    // Define your fields, constructors, and methods here
}

例

このサンプルMovie.java エンティティクラスは、次の情報を含む Movie エンティティを定義します。

• @Entity クラスをHibernetes ORM エンティティとしてマークする注釈

• @Table Atlasサンプルデータセットからエンティティを moviesコレクションにマッピングする注釈

• @Id と idフィールドをプライマリキーとして指定し、ObjectId の自動生成を構成する @ObjectIdGenerator 注釈

  Tip

  プライマリキー値

  この例では、ObjectId フィールドをエンティティのプライマリキーとして指定していますが、String int@Idアノテーションを使用して、 フィールドまたは フィールドをプライマリキーとして設定することもできます。詳細については、「 サポートされていないフィールド タイプ 」を参照してください。

• 映画データを表すプライベート フィールド

• エンティティインスタンス化のためのデフォルトおよびパラメータ付きコンストラクタ

• エンティティのフィールドへのアクセスを提供する getter メソッドと setter メソッド

package org.example;
import com.mongodb.hibernate.annotations.ObjectIdGenerator;
import org.bson.types.ObjectId;
import java.util.List;
import jakarta.persistence.Entity;
import jakarta.persistence.Id;
import jakarta.persistence.Table;
@Entity
@Table(name = "movies")
public class Movie {
	@Id
	@ObjectIdGenerator
	private ObjectId id;
	private String title;
	private String plot;
	private int year;
	private List<String> cast;
	private List<String> directors;
	public Movie(String title, String plot, int year, List<String> cast, List<String> directors) {
 		this.title = title;
		this.plot = plot;
		this.year = year;
		this.cast = cast;
        this.directors = directors;
 	}
	public Movie() {
	}
	public ObjectId getId() {
		return id;
	}
	public String getTitle() {
		return title;
	}
	public void setTitle(String title) {
		this.title = title;
	}
	public String getPlot() {
		return plot;
	}
	public void setPlot(String plot) {
		this.plot = plot;
	}
	
	public int getYear() {
		return year;
	}
	public void setYear(int year) {
		this.year = year;
	}
	public List<String> getCast() {
		return cast;
	}
	
	public void setCast(List<String> cast) {
		this.cast = cast;
	}
    public List<String> getDirectors() {
        return directors;
    }
    public void setDirectors(List<String> directors) {
        this.directors = directors;
    }
}

複合キー ストレージ

Hibernetes ORM 拡張機能は複合キーを _id サブドキュメントとして保存します。上記の Book エンティティでは、次の形式のドキュメントが生成されます。

{
  "_id": { "bookNo": 2, "publisherId": 10 },
  "title": "My Book"
}

Hibernetes ORM 拡張機能では、_id サブドキュメントのコンポーネントは、宣言した順序ではなく、コンポーネント名のアルファベット順に並べられます。この順序は、埋め込み可能をクラスとして宣言する場合でも、レコードとして宣言する場合でも同じです。

複合キーの制限

次のいずれかの方法で複合キーを宣言すると、アプリケーションの起動時に Hibernetes ORM 拡張機能は FeatureNotSupportedException をスローします。

• @jakarta.persistence.IdClass アノテーションまたは複数の @Id 属性で宣言される非集計識別子。代わりに @EmbeddedId を使用してキーを宣言します。

• 識別子として埋め込み可能な @Struct 集計。代わりに、プレーンの @Embeddable を使用してください。

• 基本値ではないコンポーネント（ネストされた @Embeddable やコレクションなど）。複合キーのすべてのコンポーネントは基本値である必要があります。

• @jakarta.persistence.MapsId アノテーションを使用する派生 ID を含む、識別子内の関連付け。

また、> や < などの順序付け演算子を使用して、複合識別子全体を比較することはできません。代わりに個々のコンポーネントを比較してください。

1 対 1 の関係

1 対 1 の関係とは、1 つのデータベースのレコードが別のデータベースの 1 つのレコードのみに関連付けられている場合を指します。MongoDBでは、埋め込みドキュメントフィールドを持つコレクションを作成して、1 対 1 の関係をモデル化できます。Hibernetes ORM 拡張機能では、@Struct 集計埋め込み可能ファイルを使用して埋め込みドキュメントフィールドを作成できます。

この例では、このガイドの エンティティの定義 の例と同様に、エンティティ内に@Struct 集計埋め込み可能型を持つフィールドを定義します。サンプルMovie.java エンティティクラスには、次の情報が含まれています。

• @Entity エンティティを定義し、それを moviesコレクションにマッピングする @Table アノテーション

• @Id idフィールドをプライマリキーとして指定する @ObjectIdGenerator 注釈

• 映画のタイトルを表す Stringフィールド

• @Struct 映画情報とチームの情報を表す集計埋め込みフィールド

次の例は1 対 1 の関係を表します。各 Movie エンティティは 1 つの Awards 埋め込み可能と 1 つの Studio 埋め込み可能に関連付けられているためです。

@Entity
@Table(name = "movies")
public class Movie {
    @Id
    @ObjectIdGenerator
    private ObjectId id;
    private String title;
    private Awards awards;
    private Studio studio;
    public Movie(String title, Awards awards, Studio studio) {
        this.title = title;
        this.awards = awards;
        this.studio = studio;
    }
    public Movie() {
    }
    // Getter and setter methods
}

次のサンプルコードでは、Awards @Struct 集計埋め込み可能を作成します。

@Embeddable
@Struct(name = "Awards")
public class Awards {
    private int wins;
    private int nominations;
    private String text;
    public Awards(int wins, int nominations, String text) {
       this.wins = wins;
       this.nominations = nominations;
       this.text = text;
    }
    public Awards() {
    }
    // Getter and setter methods
}

次のサンプルコードでは、Studio @Struct 集計埋め込み可能を作成します。

@Embeddable
@Struct(name = "Studio")
public class Studio {
    private String name;
    private String location;
    private int foundedYear;
    public Studio(String name, String location, int foundedYear) {
        this.name = name;
        this.location = location;
        this.foundedYear = foundedYear;
    }
    public Studio() {
    }
    // Getter and setter methods
}

1 対多の関係

1 対多の関係とは、1 つのデータベースのレコードが別のデータベースの多くのレコードに関連付けられている場合を指します。MongoDBでは、埋め込みドキュメントのリストを保存するコレクションフィールドを定義して、1 対多の関係をモデル化できます。Hibernetes ORM 拡張機能を使用すると、@Struct 集計埋め込み可能ファイルのリストを使用して埋め込みドキュメントフィールドを作成できます。

この例では、このガイドの エンティティの定義例 と同様に、エンティティに@Struct 集計埋め込み可能ファイルのリストを保存するフィールドを定義します。サンプルMovie.java エンティティクラスには、次の情報が含まれています。

• @Entity エンティティを定義し、それを moviesコレクションにマッピングする @Table アノテーション

• @Id idフィールドをプライマリキーとして指定する @ObjectIdGenerator 注釈

• 映画のタイトルを表す Stringフィールド

• 複数の Writer @Struct 集計埋め込み可能性を保存するリストフィールド。これは書込み情報を表す

次の例は1 対多の関係を表しています。各 Movie エンティティは複数の Writer 埋め込み可能に関連付けられているためです。

@Entity
@Table(name = "movies")
public class Movie {
    @Id
    @ObjectIdGenerator
    @Column(name = "_id")
    private ObjectId id;
    private String title;
    private List<Writer> writers;
    public Movie(String title, List<Writer> writers) {
        this.title = title;
        this.writers = writers;
    }
    public Movie() {
    }
    // Getter and setter methods
}

次のサンプルコードでは、Writer @Struct 集計埋め込み可能を作成します。

@Embeddable
@Struct(name = "Writer")
public class Writer {
    private String name;
    public Writer() {
    }
    public Writer(String name) {
        this.name = name;
    }
    // Getter and setter methods
}

ネストされた埋め込み

@Struct集計埋め込み可能内にフラット化された埋め込み可能をネストできます。フラット化された埋め込み可能とは、@Embeddable アノテーションを含むが@Struct アノテーションは含まないクラスです。 Hibernetes ORM 拡張機能は、フラット化された埋め込み可能のフィールドを別のネストされたドキュメントとしてではなく、親埋め込みドキュメントのフィールドとして保存します。

次のサンプルコードでは、フィールドとしてフラット化された埋め込み可能性を含むStudio@Struct Address集計埋め込み可能ファイルを作成します。

@Embeddable
@Struct(name = "Studio")
public class Studio {
    private String name;
    private Address address;
    public Studio() {
    }
    public Studio(String name, Address address) {
        this.name = name;
        this.address = address;
    }
    // Getter and setter methods
}

次のサンプルコードでは、Address のフラット化された埋め込み可能値を作成します。クラスは@Struct 注釈を省略します。

@Embeddable
public class Address {
    private String city;
    private String country;
    public Address() {
    }
    public Address(String city, String country) {
        this.city = city;
        this.country = country;
    }
    // Getter and setter methods
}

Studioフィールド を含むエンティティを永続化すると、Address フィールドは Studio フィールドの埋め込みドキュメントのフィールドになります。次の例ドキュメントには、Address フラット化された埋め込み可能のフィールドを保存する studio という名前の Studioフィールドがあります。

{
  "_id": { "$oid": "..." },
  "title": "Breathless",
  "studio": {
    "name": "Les Films Impéria",
    "city": "Paris",
    "country": "France"
  }
}