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. --- .../com/sleepycat/persist/model/EntityModel.html | 1133 ++++++++++---------- 1 file changed, 540 insertions(+), 593 deletions(-) (limited to 'docs/java/com/sleepycat/persist/model/EntityModel.html') diff --git a/docs/java/com/sleepycat/persist/model/EntityModel.html b/docs/java/com/sleepycat/persist/model/EntityModel.html index 9e9d3ea8..b31fd2fb 100644 --- a/docs/java/com/sleepycat/persist/model/EntityModel.html +++ b/docs/java/com/sleepycat/persist/model/EntityModel.html @@ -1,123 +1,122 @@ - - - - - -EntityModel (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 EntityModel

-
-java.lang.Object
-  extended by com.sleepycat.persist.model.EntityModel
-
-
-
Direct Known Subclasses:
AnnotationModel
-
-
-
-
public abstract class EntityModel
extends Object
- - -

-The base class for classes that provide entity model metadata. An EntityModel defines entity classes, primary keys, secondary keys, and +

+
com.sleepycat.persist.model
+

Class EntityModel

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    AnnotationModel
    +
    +
    +
    +
    public abstract class EntityModel
+extends java.lang.Object
    +
    The base class for classes that provide entity model metadata. An EntityModel defines entity classes, primary keys, secondary keys, and relationships between entities. For each entity class that is part of the - model, a single PrimaryIndex object and zero or more SecondaryIndex objects may be accessed via an EntityStore. + model, a single PrimaryIndex object and zero or more SecondaryIndex objects may be accessed via an EntityStore. -

    The built-in entity model, the AnnotationModel, is based on +

    The built-in entity model, the AnnotationModel, is based on annotations that are added to entity classes and their key fields. Annotations are used in the examples in this package, and it is expected that annotations will normally be used; most readers should therefore skip - to the AnnotationModel class. However, a custom entity model class + to the AnnotationModel class. However, a custom entity model class may define its own metadata. This can be used to define entity classes and keys using mechanisms other than annotations.

    A concrete entity model class should extend this class and implement the - getClassMetadata(java.lang.String), getEntityMetadata(java.lang.String) and getKnownClasses() methods.

    + getClassMetadata(java.lang.String), getEntityMetadata(java.lang.String) and getKnownClasses() methods.

    This is an abstract class rather than an interface to allow adding capabilities to the model at a future date without causing @@ -125,232 +124,209 @@ The base class for classes that provide entity model metadata. An +

      +
    • - - - - - - - - - - -
      -Constructor Summary
      -protected EntityModel() - -
      -          The default constructor for use by subclasses.
      -  +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ModifierConstructor and Description
        protected EntityModel() +
        The default constructor for use by subclasses.
        +
        +
        • +
      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      -Method Summary
      -static ClassclassForName(String className) - -
      -          Deprecated. use resolveClass(java.lang.String) instead. This method does not - use the environment's ClassLoader property.
      - ObjectconvertRawObject(RawObject raw) - -
      -          Converts a given raw object to a live object according to the current - class definitions.
      - List<RawType>getAllRawTypes() - -
      -          Returns all versions of all known types.
      - List<RawType>getAllRawTypeVersions(String className) - -
      -          Returns all known versions of type information for a given class name, - or null if no persistent version of the class is known.
      -abstract  ClassMetadatagetClassMetadata(String className) - -
      -          Returns the metadata for a given persistent class name, including proxy - classes and entity classes.
      -abstract  EntityMetadatagetEntityMetadata(String className) - -
      -          Returns the metadata for a given entity class name.
      -abstract  Set<String>getKnownClasses() - -
      -          Returns the names of all known persistent classes.
      - Set<String>getKnownSpecialClasses() - -
      -          Returns the names of all known persistent enum and array classes that - may be used to store persistent data.
      - RawTypegetRawType(String className) - -
      -          Returns the type information for the current version of a given class, - or null if the class is not currently persistent.
      - RawTypegetRawTypeVersion(String className, - int version) - -
      -          Returns the type information for a given version of a given class, - or null if the given version of the class is unknown.
      - booleanisOpen() - -
      -          Returns whether the model is associated with an open store.
      - voidregisterClass(Class persistentClass) - -
      -          Registers a persistent class, most importantly, a PersistentProxy class or entity subclass.
      - ClassresolveClass(String className) - -
      -          Should be called by entity model implementations instead of calling - Class.forName whenever loading an application class.
      -protected  voidsetCatalog(com.sleepycat.persist.impl.PersistCatalog newCatalog) - -
      -          Internal access method that should not be used by applications.
      -  - - - - - - - -
      Methods inherited from class java.lang.Object
      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      -  -

      - +

        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Methods 
        Modifier and TypeMethod and Description
        static java.lang.ClassclassForName(java.lang.String className) +
        Deprecated.  +
        use resolveClass(java.lang.String) instead. This method does not + use the environment's ClassLoader property.
        +
        +
        java.lang.ObjectconvertRawObject(RawObject raw) +
        Converts a given raw object to a live object according to the current + class definitions.
        +
        java.util.List<RawType>getAllRawTypes() +
        Returns all versions of all known types.
        +
        java.util.List<RawType>getAllRawTypeVersions(java.lang.String className) +
        Returns all known versions of type information for a given class name, + or null if no persistent version of the class is known.
        +
        abstract ClassMetadatagetClassMetadata(java.lang.String className) +
        Returns the metadata for a given persistent class name, including proxy + classes and entity classes.
        +
        abstract EntityMetadatagetEntityMetadata(java.lang.String className) +
        Returns the metadata for a given entity class name.
        +
        abstract java.util.Set<java.lang.String>getKnownClasses() +
        Returns the names of all known persistent classes.
        +
        java.util.Set<java.lang.String>getKnownSpecialClasses() +
        Returns the names of all known persistent enum and array classes that + may be used to store persistent data.
        +
        RawTypegetRawType(java.lang.String className) +
        Returns the type information for the current version of a given class, + or null if the class is not currently persistent.
        +
        RawTypegetRawTypeVersion(java.lang.String className, + int version) +
        Returns the type information for a given version of a given class, + or null if the given version of the class is unknown.
        +
        booleanisOpen() +
        Returns whether the model is associated with an open store.
        +
        voidregisterClass(java.lang.Class persistentClass) +
        Registers a persistent class, most importantly, a PersistentProxy class or entity subclass.
        +
        java.lang.ClassresolveClass(java.lang.String className) +
        Should be called by entity model implementations instead of calling + Class.forName whenever loading an application class.
        +
        protected voidsetCatalog(com.sleepycat.persist.impl.PersistCatalog newCatalog) +
        Internal access method that should not be used by applications.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
    +
    • +
+ + + +
    +
  • +

    registerClass

    +
    public final void registerClass(java.lang.Class persistentClass)
    +
    Registers a persistent class, most importantly, a PersistentProxy class or entity subclass. Also registers an enum or array class.

    Any persistent class , enum class or array may be registered in @@ -358,8 +334,8 @@ public final void registerClass(PersistentProxy classes, and

    • -
  • to register an entity subclass defining a secondary key, if getSubclassIndex is not called for the +
  • to register all PersistentProxy classes, and
    • +
  • to register an entity subclass defining a secondary key, if getSubclassIndex is not called for the subclass, and
  • to register all new enum or array classes, if the these enum or array classes are unknown for DPL but will be used in a Converter @@ -383,291 +359,262 @@ public final void registerClass(IllegalStateException - if this method is called for a model that - is associated with an open store. -
    IllegalArgumentException - if the given class is not persistent - or has a different class loader than previously registered classes. -
    - -
    - -

    -setCatalog

    -
    -protected void setCatalog(com.sleepycat.persist.impl.PersistCatalog newCatalog)
    -
    -
    Internal access method that should not be used by applications. + model.

+
Throws:
+
java.lang.IllegalStateException - if this method is called for a model that + is associated with an open store.
+
java.lang.IllegalArgumentException - if the given class is not persistent + or has a different class loader than previously registered classes.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
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