Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

add some doc to AttributeContainer

This commit is contained in:
Gavin 2023-01-02 08:03:44 +01:00 committed by Gavin King
parent 117851e4a4
commit 1eba25a466
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
hibernate-core/src/main/java/org/hibernate/mapping/AttributeContainer.java
View File

@ -7,12 +7,24 @@
package org.hibernate.mapping; package org.hibernate.mapping;
/** /**
* Identifies a mapping model object which may have {@linkplain Property attributes} (fields or properties). * Identifies a mapping model object which may have {@linkplain Property attributes}
* Abstracts over {@link PersistentClass} and {@link Join}. * (fields or properties). Abstracts over {@link PersistentClass} and {@link Join}.
*
* @apiNote This model makes sense in {@code hbm.xml} mappings where a
* {@code <property/>} element may occur as a child of a {@code <join/>}.
* In annotations, and in {@code orm.xml}, a property cannot be said to
* itself belong to a secondary table, instead its columns are mapped to
* the table explicitly. In fact, the old {@code hbm.xml} model was more
* natural when it came to handling {@code <column/>} and especially
* {@code <formula/>} mappings in secondary tables. There was no need to
* repetitively write {@code @Column(table="secondary")}. Granted, it does
* sound strange to say that a Java property "belongs" to a secondary table.
* *
* @author Steve Ebersole * @author Steve Ebersole
*/ */
//NOTE: this unifying contract is currently only used from HBM binding and so only defines the needs of that use case.
public interface AttributeContainer { public interface AttributeContainer {
/**
* Add a property to this {@link PersistentClass} or {@link Join}.
*/
void addProperty(Property attribute); void addProperty(Property attribute);
} }