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/raw/RawStore.html | 810 +++++++++++----------- 1 file changed, 390 insertions(+), 420 deletions(-) (limited to 'docs/java/com/sleepycat/persist/raw/RawStore.html') diff --git a/docs/java/com/sleepycat/persist/raw/RawStore.html b/docs/java/com/sleepycat/persist/raw/RawStore.html index f8f414a6..b50b110d 100644 --- a/docs/java/com/sleepycat/persist/raw/RawStore.html +++ b/docs/java/com/sleepycat/persist/raw/RawStore.html @@ -1,111 +1,109 @@ - - - - - -RawStore (Oracle - Berkeley DB Java API) - - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
-Berkeley DB
version 5.3.21
-
- + + +
+ + +
+ + + - -
-

- -com.sleepycat.persist.raw -
-Class RawStore

-
-java.lang.Object
-  extended by com.sleepycat.persist.raw.RawStore
-
-
-
-
public class RawStore
extends Object
- - -

-Provides access to the raw data in a store for use by general purpose tools. +

+
com.sleepycat.persist.raw
+

Class RawStore

+
+
+ +
+
    +
  • +
    +
    +
    public class RawStore
    +extends java.lang.Object
    +
    Provides access to the raw data in a store for use by general purpose tools. A RawStore provides access to stored entities without using entity classes or key classes. Keys are represented as simple type objects - or, for composite keys, as RawObject instances, and entities are - represented as RawObject instances. + or, for composite keys, as RawObject instances, and entities are + represented as RawObject instances.

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

    @@ -114,272 +112,240 @@ Provides access to the raw data in a store for use by general purpose tools. are not used. Instead, the previously stored metadata and class definitions are used. This has several implications:

      -
    1. An EntityModel may not be specified using StoreConfig.setModel(com.sleepycat.persist.model.EntityModel). In other words, the configured model must be +
    2. An EntityModel may not be specified using StoreConfig.setModel(com.sleepycat.persist.model.EntityModel). In other words, the configured model must be null (the default).
    3. When storing entities, their format will not automatically be evolved to the current class definition, even if the current class definition has changed.
    4. -
    -

    - -

    -


    - -

    - +

    +
  • +
+
+
+
    +
  • - - - - - - - - - -
    -Constructor Summary
    RawStore(Environment env, - String storeName, - StoreConfig config) - -
    -          Opens an entity store for raw data access.
    -  +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      RawStore(Environment env, + java.lang.String storeName, + StoreConfig config) +
      Opens an entity store for raw data access.
      +
      +
    • +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -Method Summary
    - voidclose() - -
    -          Closes all databases and sequences that were opened by this model.
    - StoreConfiggetConfig() - -
    -          Returns a copy of the entity store configuration.
    - EnvironmentgetEnvironment() - -
    -          Returns the environment associated with this store.
    - EntityModelgetModel() - -
    -          Returns the last configured and stored entity model for this store.
    - MutationsgetMutations() - -
    -          Returns the set of mutations that were configured and stored previously.
    - PrimaryIndex<Object,RawObject>getPrimaryIndex(String entityClass) - -
    -          Opens the primary index for a given entity class.
    - SecondaryIndex<Object,Object,RawObject>getSecondaryIndex(String entityClass, - String keyName) - -
    -          Opens the secondary index for a given entity class and secondary key - name.
    - StringgetStoreName() - -
    -          Returns the name of this store.
    - - - - - - - -
    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
      voidclose() +
      Closes all databases and sequences that were opened by this model.
      +
      StoreConfiggetConfig() +
      Returns a copy of the entity store configuration.
      +
      EnvironmentgetEnvironment() +
      Returns the environment associated with this store.
      +
      EntityModelgetModel() +
      Returns the last configured and stored entity model for this store.
      +
      MutationsgetMutations() +
      Returns the set of mutations that were configured and stored previously.
      +
      PrimaryIndex<java.lang.Object,RawObject>getPrimaryIndex(java.lang.String entityClass) +
      Opens the primary index for a given entity class.
      +
      SecondaryIndex<java.lang.Object,java.lang.Object,RawObject>getSecondaryIndex(java.lang.String entityClass, + java.lang.String keyName) +
      Opens the secondary index for a given entity class and secondary key + name.
      +
      java.lang.StringgetStoreName() +
      Returns the name of this store.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

    -RawStore

    -
    -public RawStore(Environment env,
    -                String storeName,
    -                StoreConfig config)
    -         throws StoreNotFoundException,
    -                DatabaseException
    -
    -
    Opens an entity store for raw data access. -

    -

    -
    Parameters:
    env - an open Berkeley DB environment.
    storeName - the name of the entity store within the given - environment.
    config - the store configuration, or null to use default - configuration properties. -
    Throws: -
    IllegalArgumentException - if the Environment is - read-only and the config ReadOnly property is false. -
    StoreNotFoundException -
    DatabaseException
    -
    - +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        RawStore

        +
        public RawStore(Environment env,
        +        java.lang.String storeName,
        +        StoreConfig config)
        +         throws StoreNotFoundException,
        +                DatabaseException
        +
        Opens an entity store for raw data access.
        +
        Parameters:
        env - an open Berkeley DB environment.
        storeName - the name of the entity store within the given + environment.
        config - the store configuration, or null to use default + configuration properties.
        +
        Throws:
        +
        java.lang.IllegalArgumentException - if the Environment is + read-only and the config ReadOnly property is false.
        +
        StoreNotFoundException
        +
        DatabaseException
        +
      • +
      +
    • +
    - - - - - - -
    -Method Detail
    - -

    -getPrimaryIndex

    -
    -public PrimaryIndex<Object,RawObject> getPrimaryIndex(String entityClass)
    -                                               throws DatabaseException
    -
    -
    Opens the primary index for a given entity class. -

    -

    - -
    Throws: -
    DatabaseException - the base class for all BDB exceptions.
    -
    -
    -
    - -

    -getSecondaryIndex

    -
    -public SecondaryIndex<Object,Object,RawObject> getSecondaryIndex(String entityClass,
    -                                                                 String keyName)
    -                                                          throws DatabaseException
    -
    -
    Opens the secondary index for a given entity class and secondary key - name. -

    -

    - -
    Throws: -
    DatabaseException - the base class for all BDB exceptions.
    -
    -
    -
    - -

    -getEnvironment

    -
    -public Environment getEnvironment()
    -
    -
    Returns the environment associated with this store. -

    -

    -
    -
    -
    -
    - -

    -getConfig

    -
    -public StoreConfig getConfig()
    -
    -
    Returns a copy of the entity store configuration. -

    -

    -
    -
    -
    -
    - -

    -getStoreName

    -
    -public String getStoreName()
    -
    -
    Returns the name of this store. -

    -

    -
    -
    -
    -
    - -

    -getModel

    -
    -public EntityModel getModel()
    -
    -
    Returns the last configured and stored entity model for this store. -

    -

    -
    -
    -
    -
    - -

    -getMutations

    -
    -public Mutations getMutations()
    -
    -
    Returns the set of mutations that were configured and stored previously. -

    -

    -
    -
    -
    -
    - -

    -close

    -
    -public void close()
    -           throws DatabaseException
    -
    -
    Closes all databases and sequences that were opened by this model. No +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getSecondaryIndex

        +
        public SecondaryIndex<java.lang.Object,java.lang.Object,RawObject> getSecondaryIndex(java.lang.String entityClass,
        +                                                                            java.lang.String keyName)
        +                                                                              throws DatabaseException
        +
        Opens the secondary index for a given entity class and secondary key + name.
        +
        Throws:
        +
        DatabaseException - the base class for all BDB exceptions.
        +
      • +
      + + + +
        +
      • +

        getEnvironment

        +
        public Environment getEnvironment()
        +
        Returns the environment associated with this store.
        +
      • +
      + + + +
        +
      • +

        getConfig

        +
        public StoreConfig getConfig()
        +
        Returns a copy of the entity store configuration.
        +
      • +
      + + + +
        +
      • +

        getStoreName

        +
        public java.lang.String getStoreName()
        +
        Returns the name of this store.
        +
      • +
      + + + +
        +
      • +

        getModel

        +
        public EntityModel getModel()
        +
        Returns the last configured and stored entity model for this store.
        +
      • +
      + + + +
        +
      • +

        getMutations

        +
        public Mutations getMutations()
        +
        Returns the set of mutations that were configured and stored previously.
        +
      • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +           throws DatabaseException
        +
        Closes all databases and sequences that were opened by this model. No databases opened via this store may be in use.

        WARNING: To guard against memory leaks, the application should @@ -387,75 +353,79 @@ public void close() to discard references from closed objects to the allocated memory for an environment, this behavior is not guaranteed. The safe course of action for an application is to discard all references to closed BDB - objects.

        -

        -

        - -
        Throws: -
        DatabaseException - the base class for all BDB exceptions.
        -
        -
    + objects.

+
Throws:
+
DatabaseException - the base class for all BDB exceptions.
+ + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
-Berkeley DB
version 5.3.21
-
- + + +
+ + +
+ + + - -
-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