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/ClassMetadata.html | 971 ++++++++++----------- 1 file changed, 454 insertions(+), 517 deletions(-) (limited to 'docs/java/com/sleepycat/persist/model/ClassMetadata.html') diff --git a/docs/java/com/sleepycat/persist/model/ClassMetadata.html b/docs/java/com/sleepycat/persist/model/ClassMetadata.html index c8f22bd0..3a0a178a 100644 --- a/docs/java/com/sleepycat/persist/model/ClassMetadata.html +++ b/docs/java/com/sleepycat/persist/model/ClassMetadata.html @@ -1,111 +1,111 @@ - - - - - -ClassMetadata (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 ClassMetadata

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

-The metadata for a persistent class. A persistent class may be specified - with the Entity or Persistent annotation. +

+
com.sleepycat.persist.model
+

Class ClassMetadata

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class ClassMetadata
+extends java.lang.Object
+implements java.io.Serializable
    +
    The metadata for a persistent class. A persistent class may be specified + with the Entity or Persistent annotation.

    ClassMetadata objects are thread-safe. Multiple threads may safely call the methods of a shared ClassMetadata object.

    @@ -113,340 +113,278 @@ The metadata for a persistent class. A persistent class may be specified

    This and other metadata classes are classes rather than interfaces to allow adding properties to the model at a future date without causing incompatibilities. Any such property will be given a default value and - its use will be optional.

    -

    - -

    -

    -
    See Also:
    Serialized Form
    -
    - -

    - + its use will be optional.

    +
    See Also:
    Serialized Form
    +
    • +
+
+
+
    +
  • - - - - - - - - - - - - -
    -Constructor Summary
    ClassMetadata(String className, - int version, - String proxiedClassName, - boolean entityClass, - PrimaryKeyMetadata primaryKey, - Map<String,SecondaryKeyMetadata> secondaryKeys, - List<FieldMetadata> compositeKeyFields) - -
    -          Used by an EntityModel to construct persistent class metadata.
    ClassMetadata(String className, - int version, - String proxiedClassName, - boolean entityClass, - PrimaryKeyMetadata primaryKey, - Map<String,SecondaryKeyMetadata> secondaryKeys, - List<FieldMetadata> compositeKeyFields, - Collection<FieldMetadata> persistentFields) - -
    -          Used by an EntityModel to construct persistent class metadata.
    -  +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + +
      Constructors 
      Constructor and Description
      ClassMetadata(java.lang.String className, + int version, + java.lang.String proxiedClassName, + boolean entityClass, + PrimaryKeyMetadata primaryKey, + java.util.Map<java.lang.String,SecondaryKeyMetadata> secondaryKeys, + java.util.List<FieldMetadata> compositeKeyFields) +
      Used by an EntityModel to construct persistent class metadata.
      +
      ClassMetadata(java.lang.String className, + int version, + java.lang.String proxiedClassName, + boolean entityClass, + PrimaryKeyMetadata primaryKey, + java.util.Map<java.lang.String,SecondaryKeyMetadata> secondaryKeys, + java.util.List<FieldMetadata> compositeKeyFields, + java.util.Collection<FieldMetadata> persistentFields) +
      Used by an EntityModel to construct persistent class metadata.
      +
      +
      • +
    - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + +
    -Method Summary
    - booleanequals(Object other) - -
    -           
    - StringgetClassName() - -
    -          Returns the name of the persistent class.
    - List<FieldMetadata>getCompositeKeyFields() - -
    -          Returns an unmodifiable list of metadata for the fields making up a - composite key, or null if this is a not a composite key class.
    - Collection<FieldMetadata>getPersistentFields() - -
    -          Returns an unmodifiable list of metadata for the persistent fields in +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      booleanequals(java.lang.Object other) 
      java.lang.StringgetClassName() +
      Returns the name of the persistent class.
      +
      java.util.List<FieldMetadata>getCompositeKeyFields() +
      Returns an unmodifiable list of metadata for the fields making up a + composite key, or null if this is a not a composite key class.
      +
      java.util.Collection<FieldMetadata>getPersistentFields() +
      Returns an unmodifiable list of metadata for the persistent fields in this class, or null if the default rules for persistent fields should be - used.
      - PrimaryKeyMetadatagetPrimaryKey() - -
      -          Returns the primary key metadata for a key declared in this class, or - null if none is declared.
      - StringgetProxiedClassName() - -
      -          Returns the class name of the proxied class if this class is a PersistentProxy, or null otherwise.
      - Map<String,SecondaryKeyMetadata>getSecondaryKeys() - -
      -          Returns an unmodifiable map of key name (which may be different from + used. +
      PrimaryKeyMetadatagetPrimaryKey() +
      Returns the primary key metadata for a key declared in this class, or + null if none is declared.
      +
      java.lang.StringgetProxiedClassName() +
      Returns the class name of the proxied class if this class is a PersistentProxy, or null otherwise.
      +
      java.util.Map<java.lang.String,SecondaryKeyMetadata>getSecondaryKeys() +
      Returns an unmodifiable map of key name (which may be different from field name) to secondary key metadata for all secondary keys declared in - this class, or null if no secondary keys are declared in this class.
      - intgetVersion() - -
      -          Returns the version of this persistent class.
      - inthashCode() - -
      -           
      - booleanisEntityClass() - -
      -          Returns whether this class is an entity class.
      -  - - - - - - - -
      Methods inherited from class java.lang.Object
      clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      -  -

      - + this class, or null if no secondary keys are declared in this class. +

    intgetVersion() +
    Returns the version of this persistent class.
    +
    inthashCode() 
    booleanisEntityClass() +
    Returns whether this class is an entity class.
    +
    +
      +
    • + + +

      Methods inherited from class java.lang.Object

      +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
    +
    • +
+ + +
+
+
    +
  • - - - - - - -
    -Constructor Detail
    - -

    -ClassMetadata

    -
    -public ClassMetadata(String className,
-                     int version,
-                     String proxiedClassName,
-                     boolean entityClass,
-                     PrimaryKeyMetadata primaryKey,
-                     Map<String,SecondaryKeyMetadata> secondaryKeys,
-                     List<FieldMetadata> compositeKeyFields)
    -
    -
    Used by an EntityModel to construct persistent class metadata. - The optional getPersistentFields() property will be set to null. -

    -

    -
    - -

    -ClassMetadata

    -
    -public ClassMetadata(String className,
-                     int version,
-                     String proxiedClassName,
-                     boolean entityClass,
-                     PrimaryKeyMetadata primaryKey,
-                     Map<String,SecondaryKeyMetadata> secondaryKeys,
-                     List<FieldMetadata> compositeKeyFields,
-                     Collection<FieldMetadata> persistentFields)
    -
    -
    Used by an EntityModel to construct persistent class metadata. -

    -

    - +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ClassMetadata

        +
        public ClassMetadata(java.lang.String className,
+             int version,
+             java.lang.String proxiedClassName,
+             boolean entityClass,
+             PrimaryKeyMetadata primaryKey,
+             java.util.Map<java.lang.String,SecondaryKeyMetadata> secondaryKeys,
+             java.util.List<FieldMetadata> compositeKeyFields)
        +
        Used by an EntityModel to construct persistent class metadata. + The optional getPersistentFields() property will be set to null.
        +
        • +
      + + + +
        +
      • +

        ClassMetadata

        +
        public ClassMetadata(java.lang.String className,
+             int version,
+             java.lang.String proxiedClassName,
+             boolean entityClass,
+             PrimaryKeyMetadata primaryKey,
+             java.util.Map<java.lang.String,SecondaryKeyMetadata> secondaryKeys,
+             java.util.List<FieldMetadata> compositeKeyFields,
+             java.util.Collection<FieldMetadata> persistentFields)
        +
        Used by an EntityModel to construct persistent class metadata.
        +
        • +
      +
      • +
    - - - - - - -
    -Method Detail
    - -

    -getClassName

    -
    -public String getClassName()
    -
    -
    Returns the name of the persistent class. -

    -

    -
    -
    -
    -
    -
    -
    -
    - -

    -getVersion

    -
    -public int getVersion()
    -
    -
    Returns the version of this persistent class. This may be specified - using the Entity.version() or Persistent.version() - annotation. -

    -

    -
    -
    -
    -
    -
    -
    -
    - -

    -getProxiedClassName

    -
    -public String getProxiedClassName()
    -
    -
    Returns the class name of the proxied class if this class is a PersistentProxy, or null otherwise. -

    -

    -
    -
    -
    -
    -
    -
    -
    - -

    -isEntityClass

    -
    -public boolean isEntityClass()
    -
    -
    Returns whether this class is an entity class. -

    -

    -
    -
    -
    -
    -
    -
    -
    - -

    -getPrimaryKey

    -
    -public PrimaryKeyMetadata getPrimaryKey()
    -
    -
    Returns the primary key metadata for a key declared in this class, or - null if none is declared. This may be specified using the PrimaryKey annotation. -

    -

    -
    -
    -
    -
    -
    -
    -
    - -

    -getSecondaryKeys

    -
    -public Map<String,SecondaryKeyMetadata> getSecondaryKeys()
    -
    -
    Returns an unmodifiable map of key name (which may be different from +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getClassName

        +
        public java.lang.String getClassName()
        +
        Returns the name of the persistent class.
        +
        • +
      + + + +
        +
      • +

        getVersion

        +
        public int getVersion()
        +
        Returns the version of this persistent class. This may be specified + using the Entity.version() or Persistent.version() + annotation.
        +
        • +
      + + + +
        +
      • +

        getProxiedClassName

        +
        public java.lang.String getProxiedClassName()
        +
        Returns the class name of the proxied class if this class is a PersistentProxy, or null otherwise.
        +
        • +
      + + + +
        +
      • +

        isEntityClass

        +
        public boolean isEntityClass()
        +
        Returns whether this class is an entity class.
        +
        • +
      + + + +
        +
      • +

        getPrimaryKey

        +
        public PrimaryKeyMetadata getPrimaryKey()
        +
        Returns the primary key metadata for a key declared in this class, or + null if none is declared. This may be specified using the PrimaryKey annotation.
        +
        • +
      + + + +
        +
      • +

        getSecondaryKeys

        +
        public java.util.Map<java.lang.String,SecondaryKeyMetadata> getSecondaryKeys()
        +
        Returns an unmodifiable map of key name (which may be different from field name) to secondary key metadata for all secondary keys declared in this class, or null if no secondary keys are declared in this class. - This metadata may be specified using SecondaryKey annotations. -

        -

        -
        -
        -
        -
        -
        -
    -
    - -

    -getCompositeKeyFields

    -
    -public List<FieldMetadata> getCompositeKeyFields()
    -
    -
    Returns an unmodifiable list of metadata for the fields making up a + This metadata may be specified using SecondaryKey annotations.
+ + + + + + + + + + + + + + + + + + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
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