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. --- docs/java/com/sleepycat/persist/DatabaseNamer.html | 503 +++++++++++---------- 1 file changed, 253 insertions(+), 250 deletions(-) (limited to 'docs/java/com/sleepycat/persist/DatabaseNamer.html') diff --git a/docs/java/com/sleepycat/persist/DatabaseNamer.html b/docs/java/com/sleepycat/persist/DatabaseNamer.html index 5040e4cb..781fc293 100644 --- a/docs/java/com/sleepycat/persist/DatabaseNamer.html +++ b/docs/java/com/sleepycat/persist/DatabaseNamer.html @@ -1,106 +1,99 @@ - - - - - -DatabaseNamer (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 -
-Interface DatabaseNamer

-
-
-
public interface DatabaseNamer
- - -

-Determines the file names to use for primary and secondary databases. - -

Each PrimaryIndex and SecondaryIndex is represented - internally as a Berkeley DB Database. The file names of primary and +

+
com.sleepycat.persist
+

Interface DatabaseNamer

+
+
+
+
    +
  • +
    +
    +
    public interface DatabaseNamer
    +
    Determines the file names to use for primary and secondary databases. + +

    Each PrimaryIndex and SecondaryIndex is represented + internally as a Berkeley DB Database. The file names of primary and secondary indices must be unique within the environment, so that each index is stored in a separate database file.

    @@ -109,20 +102,20 @@ Determines the file names to use for primary and secondary databases.

    The syntax of a primary index database file name is:

       STORE_NAME-ENTITY_CLASS
    -

    Where STORE_NAME is the name parameter passed to EntityStore and ENTITY_CLASS is name of the class - passed to getPrimaryIndex.

    +

    Where STORE_NAME is the name parameter passed to EntityStore and ENTITY_CLASS is name of the class + passed to getPrimaryIndex.

    The syntax of a secondary index database file name is:

       STORE_NAME-ENTITY_CLASS-KEY_NAME
    -

    Where KEY_NAME is the secondary key name passed to getSecondaryIndex.

    +

    Where KEY_NAME is the secondary key name passed to getSecondaryIndex.

    -

    The default naming described above is implemented by the built-in DEFAULT object. An application may supply a custom DatabaseNamer to overrride the default naming scheme. For example, a +

    The default naming described above is implemented by the built-in DEFAULT object. An application may supply a custom DatabaseNamer to overrride the default naming scheme. For example, a custom namer could place all database files in a subdirectory with the name of the store. A custom namer could also be used to name files according to specific file system restrictions.

    The custom namer object must be an instance of the DatabaseNamer - interface and is configured using setDatabaseNamer.

    + interface and is configured using setDatabaseNamer.

    When copying or removing all databases in a store, there is one further consideration. There are two internal databases that must be kept with the @@ -140,72 +133,80 @@ Determines the file names to use for primary and secondary databases. 

       STORE_NAME-com.sleepycat.persist.sequences

    These databases must normally be included with copies of other databases - in the store. They should not be modified by the application.

    -

    - -

    -

    - -

    + in the store. They should not be modified by the application.

    +
    • +
+
+
+
    +
  • - - - - - - - - - - -
    -Field Summary
    -static DatabaseNamerDEFAULT - -
    -          The default database namer.
    -  +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      static DatabaseNamerDEFAULT +
      The default database namer.
      +
      +
      • +
    - - - - - - - - - - -
    -Method Summary
    - StringgetFileName(String storeName, - String entityClassName, - String keyName) - -
    -          Returns the name of the file to be used to store the dataabase for the - given store, entity class and key.
    -  -

    - +

      +
    • + + +

      Method Summary

      + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      java.lang.StringgetFileName(java.lang.String storeName, + java.lang.String entityClassName, + java.lang.String keyName) +
      Returns the name of the file to be used to store the dataabase for the + given store, entity class and key.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • - - - - - - -
    -Field Detail
    - -

    -DEFAULT

    -
    -static final DatabaseNamer DEFAULT
    -
    -
    The default database namer. - -

    The getFileName method of this namer returns the +

      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DEFAULT

        +
        static final DatabaseNamer DEFAULT
        +
        The default database namer. + +

        The getFileName method of this namer returns the storeName, entityClassName and keyName parameters as follows:

        @@ -214,99 +215,101 @@ static final - - - - -
        -Method Detail
        - -

        -getFileName

        -
        -String getFileName(String storeName,
-                   String entityClassName,
-                   String keyName)
        -
        -
        Returns the name of the file to be used to store the dataabase for the - given store, entity class and key. This method may not return null. -

        -

        -
        Parameters:
        storeName - the name of the EntityStore.
        entityClassName - the complete name of the entity class for a - primary or secondary index.
        keyName - the key name identifying a secondary index, or null for - a primary index.
        -
        -
        +
          +
        • + + +

          Method Detail

          + + + +
            +
          • +

            getFileName

            +
            java.lang.String getFileName(java.lang.String storeName,
+                           java.lang.String entityClassName,
+                           java.lang.String keyName)
            +
            Returns the name of the file to be used to store the dataabase for the + given store, entity class and key. This method may not return null.
            +
            Parameters:
            storeName - the name of the EntityStore.
            entityClassName - the complete name of the entity class for a + primary or secondary index.
            keyName - the key name identifying a secondary index, or null for + a primary index.
            +
            • +
          +
          • +
        +
        • +
      +
+
-
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
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