From 780b92ada9afcf1d58085a83a0b9e6bc982203d1 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Tue, 17 Feb 2015 17:25:57 +0000 Subject: Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz. --- .../persist/model/SecondaryKeyMetadata.html | 792 ++++++++++----------- 1 file changed, 385 insertions(+), 407 deletions(-) (limited to 'docs/java/com/sleepycat/persist/model/SecondaryKeyMetadata.html') diff --git a/docs/java/com/sleepycat/persist/model/SecondaryKeyMetadata.html b/docs/java/com/sleepycat/persist/model/SecondaryKeyMetadata.html index 063fffb7..ee54a179 100644 --- a/docs/java/com/sleepycat/persist/model/SecondaryKeyMetadata.html +++ b/docs/java/com/sleepycat/persist/model/SecondaryKeyMetadata.html @@ -1,431 +1,409 @@ - - - - - -SecondaryKeyMetadata (Oracle - Berkeley DB Java API) - - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-

- -com.sleepycat.persist.model -
-Class SecondaryKeyMetadata

-
-java.lang.Object
-  extended by com.sleepycat.persist.model.FieldMetadata
-      extended by com.sleepycat.persist.model.SecondaryKeyMetadata
-
-
-
All Implemented Interfaces:
Serializable
-
-
-
-
public class SecondaryKeyMetadata
extends FieldMetadata
- - -

-The metadata for a secondary key field. A secondary key may be specified - with the SecondaryKey annotation. +

+
com.sleepycat.persist.model
+

Class SecondaryKeyMetadata

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class SecondaryKeyMetadata
+extends FieldMetadata
    +
    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.

    -

    - -

    -

    -
    See Also:
    Serialized Form
    -
    - -

    - + object.

    +
    See Also:
    Serialized Form
    +
    • +
+
+
+ +
+
+
    +
  • - - - - - - -
    -Constructor Detail
    - -

    -SecondaryKeyMetadata

    -
    -public 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. -

    -

    - +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SecondaryKeyMetadata

        +
        public SecondaryKeyMetadata(java.lang.String name,
+                    java.lang.String className,
+                    java.lang.String declaringClassName,
+                    java.lang.String elementClassName,
+                    java.lang.String keyName,
+                    Relationship relationship,
+                    java.lang.String relatedEntity,
+                    DeleteAction deleteAction)
        +
        Used by an EntityModel to construct secondary key metadata.
        +
        • +
      +
      • +
    - - - - - - -
    -Method Detail
    - -

    -getElementClassName

    -
    -public 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. -

    -

    -
    -
    -
    -
    - -

    -getKeyName

    -
    -public String getKeyName()
    -
    -
    Returns the key name, which may be different from the field name. -

    -

    -
    -
    -
    -
    - -

    -getRelationship

    -
    -public Relationship getRelationship()
    -
    -
    Returns the relationship between instances of the entity class and the - secondary keys. This may be specified using the SecondaryKey.relate() annotation. -

    -

    -
    -
    -
    -
    - -

    -getRelatedEntity

    -
    -public String getRelatedEntity()
    -
    -
    Returns the class name of the related (foreign) entity, for which - foreign key constraints are specified using the SecondaryKey.relatedEntity() annotation. -

    -

    -
    -
    -
    -
    - -

    -getDeleteAction

    -
    -public DeleteAction getDeleteAction()
    -
    -
    Returns the action to take when a related entity is deleted having a +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getElementClassName

        +
        public java.lang.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.
        +
        • +
      + + + +
        +
      • +

        getKeyName

        +
        public java.lang.String getKeyName()
        +
        Returns the key name, which may be different from the field name.
        +
        • +
      + + + +
        +
      • +

        getRelationship

        +
        public Relationship getRelationship()
        +
        Returns the relationship between instances of the entity class and the + secondary keys. This may be specified using the SecondaryKey.relate() annotation.
        +
        • +
      + + + +
        +
      • +

        getRelatedEntity

        +
        public java.lang.String getRelatedEntity()
        +
        Returns the class name of the related (foreign) entity, for which + foreign key constraints are specified using the SecondaryKey.relatedEntity() annotation.
        +
        • +
      + + + +
        +
      • +

        getDeleteAction

        +
        public 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. - This may be specified using the SecondaryKey.onRelatedEntityDelete() annotation. -

        -

        -
        -
        -
    -
    - -

    -equals

    -
    -public boolean equals(Object other)
    -
    -
    -
    Overrides:
    equals in class FieldMetadata
    -
    -
    -
    -
    -
    -
    - -

    -hashCode

    -
    -public int hashCode()
    -
    -
    -
    Overrides:
    hashCode in class FieldMetadata
    -
    -
    -
    -
    -
    + This may be specified using the SecondaryKey.onRelatedEntityDelete() annotation.
+ + + + + + + + + + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved. - - +

Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.

+ + -- cgit v1.2.1