/
DiscriminatorColumn.java
59 lines (55 loc) · 1.83 KB
/
DiscriminatorColumn.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*
* Copyright (c) 2023 Contributors to the Eclipse Foundation
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Apache License v2.0 is available at http://www.opensource.org/licenses/apache2.0.php.
*
* You may elect to redistribute this code under either of these licenses.
*
* Contributors:
*
* Otavio Santana
*/
package org.eclipse.jnosql.mapping;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Specifies the discriminator column for the mapping strategy.
* If the <code>DiscriminatorColumn</code> annotation is missing,
* the name of the discriminator column defaults is <code>"dtype"</code>.
* * <p>Example usage:
* * <pre>{@code
* * @Entity
* * @DiscriminatorColumn(name = "dtype")
* * public class Animal {
* * // Common fields and methods for all animals
* * }
* *
* * @Entity
* * public class Dog extends Animal {
* * // Specific fields and methods for dogs
* * }
* *
* * @Entity
* * public class Cat extends Animal {
* * // Specific fields and methods for cats
* * }
* * }</pre>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface DiscriminatorColumn {
/**
* The default name of the discriminator column, which is {@code "dtype"}.
*/
String DEFAULT_DISCRIMINATOR_COLUMN = "dtype";
/**
* (Optional) The name of column to be used for the discriminator.
* @return the column's name
*/
String value() default DEFAULT_DISCRIMINATOR_COLUMN;
}