org.hibernate.annotations.DialectOverride Maven / Gradle / Ivy
Show all versions of beangle-hibernate-core Show documentation
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.annotations;
import org.hibernate.Incubating;
import org.hibernate.dialect.Dialect;
import java.lang.annotation.Annotation;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.Integer.MAX_VALUE;
import static java.lang.Integer.MIN_VALUE;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* Allows certain annotations to be overridden in a given SQL {@link Dialect}.
*
* For example, a {@link org.hibernate.annotations.Formula} annotation may be
* customized for a given {@code Dialect} using the {@link Formula} annotation.
*
* @Formula(value = "(rate * 100) || '%'")
* @DialectOverride.Formula(dialect = MySQLDialect.class,
* override = @Formula("concat(rate * 100, '%')"))
* @DialectOverride.Formula(dialect = DB2Dialect.class,
* override = @Formula("varchar_format(rate * 100) || '%'"))
* @DialectOverride.Formula(dialect = OracleDialect.class,
* override = @Formula("to_char(rate * 100) || '%'"))
* @DialectOverride.Formula(dialect = SQLServerDialect.class,
* override = @Formula("ltrim(str(rate * 100, 10, 2)) + '%'"))
* @DialectOverride.Formula(dialect = SybaseDialect.class,
* override = @Formula("ltrim(str(rate * 100, 10, 2)) + '%'"))
* private String ratePercent;
*
*
* An annotation may even be customized for a specific range of versions
* of the dialect by specifying a {@link Version}.
*
* - {@link Formula#dialect() dialect} specifies the SQL dialect to which
* the override applies,
*
- {@link Formula#sameOrAfter() sameOrAfter} specifies that the override
* applies to all versions beginning with the given version, and
*
- {@link Formula#before() before} specifies that the override applies
* to all versions earlier than the given version.
*
*
*
* @since 6.0
* @author Gavin King
*/
@Incubating
public interface DialectOverride {
/**
* Identifies a database version.
*
* @see org.hibernate.dialect.DatabaseVersion
*/
@Retention(RUNTIME)
@interface Version {
int major();
int minor() default 0;
}
/**
* Specializes a {@link org.hibernate.annotations.Check}
* in a certain dialect.
*/
@Target({METHOD, FIELD, TYPE})
@Retention(RUNTIME)
@Repeatable(Checks.class)
@OverridesAnnotation(org.hibernate.annotations.Check.class)
@interface Check {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.Check override();
}
@Target({METHOD, FIELD, TYPE})
@Retention(RUNTIME)
@interface Checks {
Check[] value();
}
/**
* Specializes an {@link org.hibernate.annotations.OrderBy}
* in a certain dialect.
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@Repeatable(OrderBys.class)
@OverridesAnnotation(org.hibernate.annotations.OrderBy.class)
@interface OrderBy {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.OrderBy override();
}
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@interface OrderBys {
OrderBy[] value();
}
/**
* Specializes a {@link org.hibernate.annotations.ColumnDefault}
* in a certain dialect.
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@Repeatable(ColumnDefaults.class)
@OverridesAnnotation(org.hibernate.annotations.ColumnDefault.class)
@interface ColumnDefault {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.ColumnDefault override();
}
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@interface ColumnDefaults {
ColumnDefault[] value();
}
/**
* Specializes a {@link org.hibernate.annotations.GeneratedColumn}
* in a certain dialect.
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@Repeatable(GeneratedColumns.class)
@OverridesAnnotation(org.hibernate.annotations.GeneratedColumn.class)
@interface GeneratedColumn {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.GeneratedColumn override();
}
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@interface GeneratedColumns {
GeneratedColumn[] value();
}
/**
* Specializes a {@link org.hibernate.annotations.DiscriminatorFormula}
* in a certain dialect.
*/
@Target(TYPE)
@Retention(RUNTIME)
@Repeatable(DiscriminatorFormulas.class)
@OverridesAnnotation(org.hibernate.annotations.DiscriminatorFormula.class)
@interface DiscriminatorFormula {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.DiscriminatorFormula override();
}
@Target(TYPE)
@Retention(RUNTIME)
@interface DiscriminatorFormulas {
DiscriminatorFormula[] value();
}
/**
* Specializes a {@link org.hibernate.annotations.Formula}
* in a certain dialect.
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@Repeatable(Formulas.class)
@OverridesAnnotation(org.hibernate.annotations.Formula.class)
@interface Formula {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.Formula override();
}
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@interface Formulas {
Formula[] value();
}
/**
* Specializes a {@link org.hibernate.annotations.JoinFormula}
* in a certain dialect.
*/
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@OverridesAnnotation(org.hibernate.annotations.JoinFormula.class)
@interface JoinFormula {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.JoinFormula override();
}
@Target({METHOD, FIELD})
@Retention(RUNTIME)
@interface JoinFormulas {
JoinFormula[] value();
}
/**
* Specializes a {@link org.hibernate.annotations.Where}
* in a certain dialect.
*/
@Target({METHOD, FIELD, TYPE})
@Retention(RUNTIME)
@OverridesAnnotation(org.hibernate.annotations.Where.class)
@interface Where {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.Where override();
}
@Target({METHOD, FIELD, TYPE})
@Retention(RUNTIME)
@interface Wheres {
Where[] value();
}
/**
* Specializes {@link org.hibernate.annotations.Filters}
* in a certain dialect.
*/
@Target({METHOD, FIELD, TYPE})
@Retention(RUNTIME)
@Repeatable(FilterOverrides.class)
@OverridesAnnotation(org.hibernate.annotations.Filters.class)
@interface Filters {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.Filters override();
}
@Target({METHOD, FIELD, TYPE})
@Retention(RUNTIME)
@interface FilterOverrides {
Filters[] value();
}
/**
* Specializes {@link org.hibernate.annotations.FilterDefs}
* in a certain dialect.
*/
@Target({PACKAGE, TYPE})
@Retention(RUNTIME)
@Repeatable(FilterDefOverrides.class)
@OverridesAnnotation(org.hibernate.annotations.FilterDefs.class)
@interface FilterDefs {
/**
* The {@link Dialect} in which this override applies.
*/
Class dialect();
Version before() default @Version(major = MAX_VALUE);
Version sameOrAfter() default @Version(major = MIN_VALUE);
org.hibernate.annotations.FilterDefs override();
}
@Target({PACKAGE, TYPE})
@Retention(RUNTIME)
@interface FilterDefOverrides {
FilterDefs[] value();
}
/**
* Marks an annotation type as a dialect-specific override for
* some other annotation type.
*
* The marked annotation must have the following members:
*
* - {@code Class dialect()},
*
- {@code Version before()},
*
- {@code Version sameOrAfter()}, and
*
- {@code A override()}, where {@code A} is the type
* of annotation which the marked annotation overrides.
*
*/
@Target({ANNOTATION_TYPE})
@Retention(RUNTIME)
@interface OverridesAnnotation {
/**
* The class of the annotation that is overridden.
*/
Class value();
}
}