Java Doc for StoredContainer.java in  » JMX » je » com » sleepycat » collections » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » JMX » je » com.sleepycat.collections 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.sleepycat.collections.StoredContainer

All known Subclasses:   com.sleepycat.collections.StoredCollection,  com.sleepycat.collections.StoredMap,
StoredContainer
abstract public class StoredContainer implements Cloneable(Code)
A abstract base class for all stored collections and maps. This class provides implementations of methods that are common to the java.util.Collection and the java.util.Map interfaces, namely StoredContainer.clear , StoredContainer.isEmpty and StoredContainer.size .

In addition, this class provides the following methods for stored collections only. Note that the use of these methods is not compatible with the standard Java collections interface.


author:
   Mark Hayes


Field Summary
 DataViewview
    

Constructor Summary
 StoredContainer(DataView view)
    

Method Summary
final public  booleanareDuplicatesAllowed()
     Returns whether duplicate keys are allowed in this container.
final public  booleanareDuplicatesOrdered()
     Returns whether duplicate keys are allowed and sorted by element value.
final public  booleanareKeysRenumbered()
     Returns whether keys are renumbered when insertions and deletions occur.
final  booleanbeginAutoCommit()
    
public  voidclear()
     Removes all mappings or elements from this map or collection (optional operation).
final  voidcloseCursor(DataCursor cursor)
    
final  voidcommitAutoCommit(boolean doAutoCommit)
    
final  StoredContainerconfiguredClone(CursorConfig config)
     Clones a container with a specified cursor configuration.
 booleancontainsKey(Object key)
    
 booleancontainsValue(Object value)
    
static  RuntimeExceptionconvertException(Exception e)
    
 Objectget(Object key)
    
final public  CursorConfiggetCursorConfig()
     Returns the cursor configuration that is used for all operations performed via this container.
final  RuntimeExceptionhandleException(Exception e, boolean doAutoCommit)
    
 voidinitAfterClone()
     Override this method to initialize view-dependent fields.
final public  booleanisDirtyRead()
    
final public  booleanisDirtyReadAllowed()
     Returns whether read-uncommitted is allowed for this container.
public  booleanisEmpty()
     Returns true if this map or collection contains no mappings or elements.
final public  booleanisOrdered()
     Returns whether keys are ordered in this container.
final public  booleanisSecondary()
     Returns whether this container is a view on a secondary database rather than directly on a primary database.
final public  booleanisTransactional()
     Returns whether the databases underlying this container are transactional.
final public  booleanisWriteAllowed()
     Returns true if this is a read-write container or false if this is a read-only container.
 Objectput(Object key, Object value)
    
final  booleanremoveKey(Object key, Object[] oldVal)
    
final  booleanremoveValue(Object value)
    
abstract public  intsize()
     Returns a non-transactional count of the records in the collection or map.
final  IteratorstoredOrExternalIterator(Collection coll)
     Returns a StoredIterator if the given collection is a StoredCollection, else returns a regular/external Iterator.

Field Detail
view
DataView view(Code)




Constructor Detail
StoredContainer
StoredContainer(DataView view)(Code)




Method Detail
areDuplicatesAllowed
final public boolean areDuplicatesAllowed()(Code)
Returns whether duplicate keys are allowed in this container. Duplicates are optionally allowed for HASH and BTREE databases. This method does not exist in the standard java.util.Map or java.util.Collection interfaces.

Note that the JE product only supports BTREE databases.

whether duplicates are allowed.



areDuplicatesOrdered
final public boolean areDuplicatesOrdered()(Code)
Returns whether duplicate keys are allowed and sorted by element value. Duplicates are optionally sorted for HASH and BTREE databases. This method does not exist in the standard java.util.Map or java.util.Collection interfaces.

Note that the JE product only supports BTREE databases, and duplicates are always sorted.

whether duplicates are ordered.



areKeysRenumbered
final public boolean areKeysRenumbered()(Code)
Returns whether keys are renumbered when insertions and deletions occur. Keys are optionally renumbered for RECNO databases. This method does not exist in the standard java.util.Map or java.util.Collection interfaces.

Note that the JE product does not support RECNO databases, and therefore keys are never renumbered.

whether keys are renumbered.



beginAutoCommit
final boolean beginAutoCommit()(Code)



clear
public void clear()(Code)
Removes all mappings or elements from this map or collection (optional operation). This method conforms to the java.util.Collection.clear and java.util.Map.clear interfaces.
throws:
  UnsupportedOperationException - if the container is read-only.
throws:
  RuntimeExceptionWrapper - if a DatabaseException is thrown.



closeCursor
final void closeCursor(DataCursor cursor)(Code)



commitAutoCommit
final void commitAutoCommit(boolean doAutoCommit) throws DatabaseException(Code)



configuredClone
final StoredContainer configuredClone(CursorConfig config)(Code)
Clones a container with a specified cursor configuration.



containsKey
boolean containsKey(Object key)(Code)



containsValue
boolean containsValue(Object value)(Code)



convertException
static RuntimeException convertException(Exception e)(Code)



get
Object get(Object key)(Code)



getCursorConfig
final public CursorConfig getCursorConfig()(Code)
Returns the cursor configuration that is used for all operations performed via this container. For example, if CursorConfig.getReadUncommitted returns true, data will be read that is modified but not committed. This method does not exist in the standard java.util.Map or java.util.Collection interfaces. the cursor configuration, or null if no configuration has beenspecified.



handleException
final RuntimeException handleException(Exception e, boolean doAutoCommit)(Code)



initAfterClone
void initAfterClone()(Code)
Override this method to initialize view-dependent fields.



isDirtyRead
final public boolean isDirtyRead()(Code)
StoredContainer.getCursorConfig



isDirtyReadAllowed
final public boolean isDirtyReadAllowed()(Code)
Returns whether read-uncommitted is allowed for this container. For the JE product, read-uncommitted is always allowed; for the DB product, read-uncommitted is allowed if it was configured for the underlying database for this container. Even when read-uncommitted is allowed it must specifically be enabled by calling one of the StoredCollections methods. This method does not exist in the standard java.util.Map or java.util.Collection interfaces. whether read-uncommitted is allowed.



isEmpty
public boolean isEmpty()(Code)
Returns true if this map or collection contains no mappings or elements. This method conforms to the java.util.Collection.isEmpty and java.util.Map.isEmpty interfaces. whether the container is empty.
throws:
  RuntimeExceptionWrapper - if a DatabaseException is thrown.



isOrdered
final public boolean isOrdered()(Code)
Returns whether keys are ordered in this container. Keys are ordered for BTREE, RECNO and QUEUE database. This method does not exist in the standard java.util.Map or java.util.Collection interfaces.

Note that the JE product only support BTREE databases, and therefore keys are always ordered.

whether keys are ordered.



isSecondary
final public boolean isSecondary()(Code)
Returns whether this container is a view on a secondary database rather than directly on a primary database. This method does not exist in the standard java.util.Map or java.util.Collection interfaces. whether the view is for a secondary database.



isTransactional
final public boolean isTransactional()(Code)
Returns whether the databases underlying this container are transactional. Even in a transactional environment, a database will be transactional only if it was opened within a transaction or if the auto-commit option was specified when it was opened. This method does not exist in the standard java.util.Map or java.util.Collection interfaces. whether the database is transactional.



isWriteAllowed
final public boolean isWriteAllowed()(Code)
Returns true if this is a read-write container or false if this is a read-only container. This method does not exist in the standard java.util.Map or java.util.Collection interfaces. whether write is allowed.



put
Object put(Object key, Object value)(Code)



removeKey
final boolean removeKey(Object key, Object[] oldVal)(Code)



removeValue
final boolean removeValue(Object value)(Code)



size
abstract public int size()(Code)
Returns a non-transactional count of the records in the collection or map. This method conforms to the java.util.Collection.size and java.util.Map.size interfaces.

This operation is faster than obtaining a count by scanning the collection manually, and will not perturb the current contents of the cache. However, the count is not guaranteed to be accurate if there are concurrent updates.


throws:
  RuntimeExceptionWrapper - if a DatabaseException is thrown.



storedOrExternalIterator
final Iterator storedOrExternalIterator(Collection coll)(Code)
Returns a StoredIterator if the given collection is a StoredCollection, else returns a regular/external Iterator. The iterator returned should be closed with the static method StoredIterator.close(Iterator).



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.