Top Description Methods
javax.persistence

public @Interface DiscriminatorValue

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.Target, .Retention

Specifies the value of the discriminator column for entities of the given type.

The DiscriminatorValue annotation can only be specified on a concrete entity class.

If the DiscriminatorValue annotation is not specified and a discriminator column is used, a provider-specific function will be used to generate a value representing the entity type. If the DiscriminatorType is STRING, the discriminator value default is the entity name.

The inheritance strategy and the discriminator column are only specified in the root of an entity class hierarchy or subhierarchy in which a different inheritance strategy is applied. The discriminator value, if not defaulted, should be specified for each entity class in the hierarchy.


   Example:

   @Entity
   @Table(name="CUST")
   @Inheritance(strategy=SINGLE_TABLE)
   @DiscriminatorColumn(name="DISC", discriminatorType=STRING, length=20)
   @DiscriminatorValue("CUSTOMER")
   public class Customer { ... }

   @Entity
   @DiscriminatorValue("VCUSTOMER")
   public class ValuedCustomer extends Customer { ... }
Since
Java Persistence 1.0
See Also
DiscriminatorColumn

Method Summary

Modifier and TypeMethod and Description
public String
value()

(Optional) The value that indicates that the row is an entity of the annotated entity type.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public String value()

(Optional) The value that indicates that the row is an entity of the annotated entity type.

If the DiscriminatorValue annotation is not specified and a discriminator column is used, a provider-specific function will be used to generate a value representing the entity type. If the DiscriminatorType is STRING, the discriminator value default is the entity name.