From 54bc9fbf9db36e55a869a5a7bacbc6897ae2f18e Mon Sep 17 00:00:00 2001 From: Steve Ebersole Date: Wed, 10 Apr 2013 12:26:33 -0500 Subject: [PATCH] HHH-8163 - Deprecate @IndexColumn and add @ListIndexBase --- .../en-US/content/collection_mapping.xml | 17 +++++---- .../org/hibernate/cfg/AnnotationBinder.java | 4 +++ .../java/org/hibernate/cfg/IndexColumn.java | 35 ++++++++++++++----- .../test/annotations/array/Contest.java | 6 ++-- .../test/annotations/indexcoll/Wardrobe.java | 8 +++-- .../test/propertyref/DoesNotWork.java | 5 ++- 6 files changed, 54 insertions(+), 21 deletions(-) diff --git a/documentation/src/main/docbook/manual/en-US/content/collection_mapping.xml b/documentation/src/main/docbook/manual/en-US/content/collection_mapping.xml index 3fe09b797d..26b6c0f166 100644 --- a/documentation/src/main/docbook/manual/en-US/content/collection_mapping.xml +++ b/documentation/src/main/docbook/manual/en-US/content/collection_mapping.xml @@ -584,13 +584,16 @@ public class Order { - We recommend you to convert the legacy - @org.hibernate.annotations.IndexColumn usages to - @OrderColumn unless you are making use of the - base property. The base property lets you define - the index value of the first element (aka as base index). The usual - value is 0 or 1. The default - is 0 like in Java. + + We recommend you to convert the legacy @org.hibernate.annotations.IndexColumn + usages to the JPA standard @javax.persistence.OrderColumn. + + + If you are leveraging a custom list index base (maybe currently using the + org.hibernate.annotations.IndexColumn.literal attribute), you can + specify this using the @org.hibernate.annotations.ListIndexBase in conjunction + with @javax.persistence.OrderColumn. The default base is 0 like in Java. + Looking again at the Hibernate mapping file equivalent, the diff --git a/hibernate-core/src/main/java/org/hibernate/cfg/AnnotationBinder.java b/hibernate-core/src/main/java/org/hibernate/cfg/AnnotationBinder.java index d5d370c164..bf7293310e 100644 --- a/hibernate-core/src/main/java/org/hibernate/cfg/AnnotationBinder.java +++ b/hibernate-core/src/main/java/org/hibernate/cfg/AnnotationBinder.java @@ -111,6 +111,7 @@ import org.hibernate.annotations.GenericGenerators; import org.hibernate.annotations.Index; import org.hibernate.annotations.LazyToOne; import org.hibernate.annotations.LazyToOneOption; +import org.hibernate.annotations.ListIndexBase; import org.hibernate.annotations.ManyToAny; import org.hibernate.annotations.MapKeyType; import org.hibernate.annotations.NaturalId; @@ -1708,6 +1709,9 @@ public final class AnnotationBinder { entityBinder.getSecondaryTables(), mappings ); + if ( property.isAnnotationPresent( ListIndexBase.class ) ) { + indexColumn.setBase( ( property.getAnnotation( ListIndexBase.class ) ).value() ); + } } else { //if @IndexColumn is not there, the generated IndexColumn is an implicit column and not used. diff --git a/hibernate-core/src/main/java/org/hibernate/cfg/IndexColumn.java b/hibernate-core/src/main/java/org/hibernate/cfg/IndexColumn.java index 36a4898346..893850342f 100644 --- a/hibernate-core/src/main/java/org/hibernate/cfg/IndexColumn.java +++ b/hibernate-core/src/main/java/org/hibernate/cfg/IndexColumn.java @@ -77,17 +77,27 @@ public class IndexColumn extends Ejb3Column { this.base = base; } - //JPA 2 @OrderColumn processing + /** + * JPA 2 {@link OrderColumn @OrderColumn} processing. + * + * @param ann The OrderColumn annotation instance + * @param propertyHolder Information about the property + * @param inferredData Yeah, right. Uh... + * @param secondaryTables Any secondary tables available. + * @param mappings The mappings being built. + * + * @return The index column + */ public static IndexColumn buildColumnFromAnnotation( OrderColumn ann, PropertyHolder propertyHolder, PropertyData inferredData, Map secondaryTables, Mappings mappings) { - IndexColumn column; + final IndexColumn column; if ( ann != null ) { - String sqlType = BinderHelper.isEmptyAnnotationValue( ann.columnDefinition() ) ? null : ann.columnDefinition(); - String name = BinderHelper.isEmptyAnnotationValue( ann.name() ) ? inferredData.getPropertyName() + "_ORDER" : ann.name(); + final String sqlType = BinderHelper.isEmptyAnnotationValue( ann.columnDefinition() ) ? null : ann.columnDefinition(); + final String name = BinderHelper.isEmptyAnnotationValue( ann.name() ) ? inferredData.getPropertyName() + "_ORDER" : ann.name(); //TODO move it to a getter based system and remove the constructor // The JPA OrderColumn annotation defines no table element... // column = new IndexColumn( @@ -110,16 +120,25 @@ public class IndexColumn extends Ejb3Column { return column; } - //legacy @IndexColumn processing + /** + * Legacy {@link IndexColumn @IndexColumn} processing. + * + * @param ann The IndexColumn annotation instance + * @param propertyHolder Information about the property + * @param inferredData Yeah, right. Uh... + * @param mappings The mappings being built. + * + * @return The index column + */ public static IndexColumn buildColumnFromAnnotation( org.hibernate.annotations.IndexColumn ann, PropertyHolder propertyHolder, PropertyData inferredData, Mappings mappings) { - IndexColumn column; + final IndexColumn column; if ( ann != null ) { - String sqlType = BinderHelper.isEmptyAnnotationValue( ann.columnDefinition() ) ? null : ann.columnDefinition(); - String name = BinderHelper.isEmptyAnnotationValue( ann.name() ) ? inferredData.getPropertyName() : ann.name(); + final String sqlType = BinderHelper.isEmptyAnnotationValue( ann.columnDefinition() ) ? null : ann.columnDefinition(); + final String name = BinderHelper.isEmptyAnnotationValue( ann.name() ) ? inferredData.getPropertyName() : ann.name(); //TODO move it to a getter based system and remove the constructor column = new IndexColumn( false, sqlType, 0, 0, 0, name, ann.nullable(), diff --git a/hibernate-core/src/test/java/org/hibernate/test/annotations/array/Contest.java b/hibernate-core/src/test/java/org/hibernate/test/annotations/array/Contest.java index 8db7c0b122..19c6e6328e 100644 --- a/hibernate-core/src/test/java/org/hibernate/test/annotations/array/Contest.java +++ b/hibernate-core/src/test/java/org/hibernate/test/annotations/array/Contest.java @@ -1,5 +1,6 @@ //$Id$ package org.hibernate.test.annotations.array; + import javax.persistence.CascadeType; import javax.persistence.ElementCollection; import javax.persistence.Entity; @@ -8,7 +9,7 @@ import javax.persistence.Id; import javax.persistence.OneToMany; import javax.persistence.OrderColumn; -import org.hibernate.annotations.IndexColumn; +import org.hibernate.annotations.ListIndexBase; /** * @author Emmanuel Bernard @@ -40,7 +41,8 @@ public class Contest { } @ElementCollection - @IndexColumn(name = "pos", base=1) //legacy + base + @OrderColumn + @ListIndexBase( 1 ) public Month[] getHeldIn() { return heldIn; } diff --git a/hibernate-core/src/test/java/org/hibernate/test/annotations/indexcoll/Wardrobe.java b/hibernate-core/src/test/java/org/hibernate/test/annotations/indexcoll/Wardrobe.java index 35caf58329..68349d6838 100644 --- a/hibernate-core/src/test/java/org/hibernate/test/annotations/indexcoll/Wardrobe.java +++ b/hibernate-core/src/test/java/org/hibernate/test/annotations/indexcoll/Wardrobe.java @@ -1,5 +1,5 @@ -//$Id$ package org.hibernate.test.annotations.indexcoll; + import java.util.List; import javax.persistence.CascadeType; import javax.persistence.Entity; @@ -7,8 +7,9 @@ import javax.persistence.GeneratedValue; import javax.persistence.Id; import javax.persistence.JoinColumn; import javax.persistence.OneToMany; +import javax.persistence.OrderColumn; -import org.hibernate.annotations.IndexColumn; +import org.hibernate.annotations.ListIndexBase; /** * @author Emmanuel Bernard @@ -34,8 +35,9 @@ public class Wardrobe { * not recommended). */ @OneToMany(cascade = CascadeType.ALL) - @IndexColumn(name = "drawer_position", base = 1) @JoinColumn(name = "wardrobe_id", nullable = false) + @OrderColumn( name = "drawer_position" ) + @ListIndexBase( 1 ) public List getDrawers() { return drawers; } diff --git a/hibernate-core/src/test/java/org/hibernate/test/propertyref/DoesNotWork.java b/hibernate-core/src/test/java/org/hibernate/test/propertyref/DoesNotWork.java index 1cb7292cc6..60aa29b906 100644 --- a/hibernate-core/src/test/java/org/hibernate/test/propertyref/DoesNotWork.java +++ b/hibernate-core/src/test/java/org/hibernate/test/propertyref/DoesNotWork.java @@ -30,12 +30,14 @@ import javax.persistence.EmbeddedId; import javax.persistence.Entity; import javax.persistence.JoinColumn; import javax.persistence.JoinTable; +import javax.persistence.OrderColumn; import javax.persistence.Table; import java.io.Serializable; import java.util.ArrayList; import java.util.List; import org.hibernate.annotations.IndexColumn; +import org.hibernate.annotations.ListIndexBase; /** * @author Steve Ebersole @@ -58,7 +60,8 @@ public class DoesNotWork implements Serializable { joinColumns = @JoinColumn(name = "text_id", referencedColumnName = "production_credits_tid") ) @Column(name = "text_part", insertable = false, updatable = false) - @IndexColumn(name = "seq_no", base = 1) + @OrderColumn( name = "seq_no" ) + @ListIndexBase(1) private List globalNotes = new ArrayList(); public DoesNotWork() {