|
Berkeley DB Java Edition version 3.0.12 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sleepycat.persist.model.FieldMetadata
com.sleepycat.persist.model.SecondaryKeyMetadata
public class SecondaryKeyMetadata
The metadata for a secondary key field. A secondary key may be specified
with the SecondaryKey annotation.
SecondaryKeyMetadata objects are thread-safe. Multiple threads
may safely call the methods of a shared SecondaryKeyMetadata
object.
| Constructor Summary | |
|---|---|
SecondaryKeyMetadata(String name,
String className,
String declaringClassName,
String elementClassName,
String keyName,
Relationship relationship,
String relatedEntity,
DeleteAction deleteAction)
Used by an EntityModel to construct secondary key metadata. |
|
| Method Summary | |
|---|---|
boolean |
equals(Object other)
|
DeleteAction |
getDeleteAction()
Returns the action to take when a related entity is deleted having a primary key value that exists as a secondary key value for this entity. |
String |
getElementClassName()
Returns the class name of the array or collection element for a ONE_TO_MANY or MANY_TO_MANY relationship, or null for a
Relationship#ONE_TO_ONE ONE_TO_ONE} or MANY_TO_ONE relationship. |
String |
getKeyName()
Returns the key name, which may be different from the field name. |
String |
getRelatedEntity()
Returns the class name of the related (foreign) entity, for which foreign key constraints are specified using the SecondaryKey.relatedEntity() annotation. |
Relationship |
getRelationship()
Returns the relationship between instances of the entity class and the secondary keys. |
| Methods inherited from class com.sleepycat.persist.model.FieldMetadata |
|---|
getClassName, getDeclaringClassName, getName |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SecondaryKeyMetadata(String name,
String className,
String declaringClassName,
String elementClassName,
String keyName,
Relationship relationship,
String relatedEntity,
DeleteAction deleteAction)
EntityModel to construct secondary key metadata.
| Method Detail |
|---|
public String getElementClassName()
ONE_TO_MANY or MANY_TO_MANY relationship, or null for a
Relationship#ONE_TO_ONE ONE_TO_ONE} or MANY_TO_ONE relationship.
public String getKeyName()
public Relationship getRelationship()
SecondaryKey.relate() annotation.
public String getRelatedEntity()
SecondaryKey.relatedEntity() annotation.
public DeleteAction getDeleteAction()
SecondaryKey.onRelatedEntityDelete() annotation.
public boolean equals(Object other)
equals in class FieldMetadata
|
Berkeley DB Java Edition version 3.0.12 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||